URL
https://opencores.org/ocsvn/usb_fpga_2_14/usb_fpga_2_14/trunk
Subversion Repositories usb_fpga_2_14
[/] [usb_fpga_2_14/] [trunk/] [docs/] [java/] [ztex/] [ZtexContext.html] - Rev 2
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="de"> <head> <!-- Generated by javadoc (version 1.7.0_79) on Wed Mar 22 19:20:13 CET 2017 --> <title>ZtexContext</title> <meta name="date" content="2017-03-22"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ZtexContext"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../ztex/package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../deprecated-list.html">Deprecated</a></li> <li><a href="../index-all.html">Index</a></li> <li><a href="../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../ztex/Ztex1v1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li> <li><a href="../ztex/ZtexDevice1.html" title="class in ztex"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?ztex/ZtexContext.html" target="_top">Frames</a></li> <li><a href="ZtexContext.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">ztex</div> <h2 title="Class ZtexContext" class="title">Class ZtexContext</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>ztex.ZtexContext</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">ZtexContext</span> extends java.lang.Object</pre> <div class="block">This class manages an USB context. Because libusb_get_device_list does not return an up to date device list at least on some implementations a new context must be created every time the bus is (re)discovered, i.e. every time re-numeration occurs. This class creates a new USB context, initializes it and deinitializes it as soon it is not used anymore. Used is tracked using a reference counter. Reference counter of a new instance is 1.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../ztex/ZtexContext.html#ZtexContext()">ZtexContext</a></strong>()</code> <div class="block">Constructs an new USB context and initializes it.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>org.usb4java.Context</code></td> <td class="colLast"><code><strong><a href="../ztex/ZtexContext.html#context()">context</a></strong>()</code> <div class="block">Returns the USB context.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../ztex/ZtexContext.html#finalize()">finalize</a></strong>()</code> <div class="block">Releases all resources.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a></code></td> <td class="colLast"><code><strong><a href="../ztex/ZtexContext.html#ref()">ref</a></strong>()</code> <div class="block">Increases the reference count.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../ztex/ZtexContext.html#unref()">unref</a></strong>()</code> <div class="block">Decreases the reference count and deinitializes the context if reference counter reaches 0.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="ZtexContext()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ZtexContext</h4> <pre>public ZtexContext() throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre> <div class="block">Constructs an new USB context and initializes it.</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="context()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>context</h4> <pre>public final org.usb4java.Context context()</pre> <div class="block">Returns the USB context.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the USB context.</dd></dl> </li> </ul> <a name="ref()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ref</h4> <pre>public <a href="../ztex/ZtexContext.html" title="class in ztex">ZtexContext</a> ref() throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre> <div class="block">Increases the reference count.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the USB context.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl> </li> </ul> <a name="unref()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>unref</h4> <pre>public void unref()</pre> <div class="block">Decreases the reference count and deinitializes the context if reference counter reaches 0.</div> </li> </ul> <a name="finalize()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>finalize</h4> <pre>protected void finalize() throws java.lang.Throwable</pre> <div class="block">Releases all resources.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>finalize</code> in class <code>java.lang.Object</code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Throwable</code></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../ztex/package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../deprecated-list.html">Deprecated</a></li> <li><a href="../index-all.html">Index</a></li> <li><a href="../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../ztex/Ztex1v1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li> <li><a href="../ztex/ZtexDevice1.html" title="class in ztex"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?ztex/ZtexContext.html" target="_top">Frames</a></li> <li><a href="ZtexContext.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>