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/] [ZtexUsbReader.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>ZtexUsbReader</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="ZtexUsbReader";
}
//-->
</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/ZtexScanBus1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexUsbWriter.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexUsbReader.html" target="_top">Frames</a></li>
<li><a href="ZtexUsbReader.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 ZtexUsbReader" class="title">Class ZtexUsbReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>ztex.ZtexUsbReader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ZtexUsbReader</span>
extends java.lang.Object</pre>
<div class="block">A helper class to implement asynchronous bulk and interrupt read transfers. This class also has a speed test mode.</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/ZtexUsbReader.html#ZtexUsbReader(org.usb4java.DeviceHandle,%20int,%20boolean,%20int,%20int)">ZtexUsbReader</a></strong>(org.usb4java.DeviceHandle p_handle,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)</code>
<div class="block">Creates the reader for a given USB device and endpoint number.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexUsbReader.html#ZtexUsbReader(ztex.Ztex1,%20int,%20boolean,%20int,%20int)">ZtexUsbReader</a></strong>(<a href="../ztex/Ztex1.html" title="class in ztex">Ztex1</a> ztex,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)</code>
<div class="block">Creates the reader from a given ZTEX device and endpoint number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../ztex/ZtexUsbReader.html#ZtexUsbReader(ztex.Ztex1v1,%20int,%20int)">ZtexUsbReader</a></strong>(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> ztex,
int p_bufNum,
int p_bufSize)</code>
<div class="block">Creates the reader for the input endpoint of the default interface of a ZTEX device.</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>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#bufSize()">bufSize</a></strong>()</code>
<div class="block">Return the buffer size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#byteCount()">byteCount</a></strong>()</code>
<div class="block">Return the number of bytes read since last <a href="../ztex/ZtexUsbReader.html#start(long)"><code>start(long)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#cancel()">cancel</a></strong>()</code>
<div class="block">Cancels all pending transfers, also see <a href="../ztex/ZtexUsbReader.html#cancelWait(int)"><code>cancelWait(int)</code></a>,</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#cancelWait(int)">cancelWait</a></strong>(int timeout)</code>
<div class="block">Cancels all pending transfers and waits until transfers are canceled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#getBuffer(byte[],%20int)">getBuffer</a></strong>(byte[] buf,
int timeout)</code>
<div class="block">Get the next buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../ztex/ZtexUsbReader.html#start(long)">start</a></strong>(long maxCount)</code>
<div class="block">Start the reader.</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, finalize, 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="ZtexUsbReader(org.usb4java.DeviceHandle, int, boolean, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexUsbReader</h4>
<pre>public ZtexUsbReader(org.usb4java.DeviceHandle p_handle,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)</pre>
<div class="block">Creates the reader for a given USB device and endpoint number.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p_handle</code> - The device handle used for communication (must be opened).</dd><dd><code>p_ep</code> - The input endpoint.</dd><dd><code>p_isInt</code> - True if it is an interrupt transfer.</dd><dd><code>p_bufSize</code> - size of each buffer. Typical values are 64KByte to 512KByte</dd><dd><code>p_bufNum</code> - number of buffer. Recommended queue size is 2MByte to 8MByte.</dd></dl>
</li>
</ul>
<a name="ZtexUsbReader(ztex.Ztex1, int, boolean, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZtexUsbReader</h4>
<pre>public ZtexUsbReader(<a href="../ztex/Ztex1.html" title="class in ztex">Ztex1</a> ztex,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)</pre>
<div class="block">Creates the reader from a given ZTEX device and endpoint number.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ztex</code> - The ZTEX device.</dd><dd><code>p_ep</code> - The number of the input endpoint</dd><dd><code>p_isInt</code> - True if it is an interrupt transfer.</dd><dd><code>p_bufSize</code> - size of each buffer. Typical values are 64KByte to 512KByte</dd><dd><code>p_bufNum</code> - number of buffer. Recommended queue size is 2MByte to 8MByte.</dd></dl>
</li>
</ul>
<a name="ZtexUsbReader(ztex.Ztex1v1, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ZtexUsbReader</h4>
<pre>public ZtexUsbReader(<a href="../ztex/Ztex1v1.html" title="class in ztex">Ztex1v1</a> ztex,
int p_bufNum,
int p_bufSize)
throws <a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a>,
<a href="../ztex/UsbException.html" title="class in ztex">UsbException</a>,
<a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</a></pre>
<div class="block">Creates the reader for the input endpoint of the default interface of a ZTEX device.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ztex</code> - The ZTEX device.</dd><dd><code>p_bufSize</code> - size of each buffer. Typical values are 64KByte to 512KByte</dd><dd><code>p_bufNum</code> - number of buffer. Recommended queue size is 2MByte to 8MByte.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../ztex/InvalidFirmwareException.html" title="class in ztex">InvalidFirmwareException</a></code></dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd>
<dd><code><a href="../ztex/CapabilityException.html" title="class in ztex">CapabilityException</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="getBuffer(byte[], int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBuffer</h4>
<pre>public int getBuffer(byte[] buf,
int timeout)
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
<div class="block">Get the next buffer. This does not work in speed test mode, see see <a href="../ztex/ZtexUsbReader.html#start(long)"><code>start(long)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - The byte array where to store the data.</dd><dd><code>timeout</code> - Timeout in ms. If timeout occurs the function returns -1.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The number of bytes read or -1 if timeout occurs.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>UsbExecption</code> - if an error occurred.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl>
</li>
</ul>
<a name="byteCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>byteCount</h4>
<pre>public long byteCount()</pre>
<div class="block">Return the number of bytes read since last <a href="../ztex/ZtexUsbReader.html#start(long)"><code>start(long)</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of bytes read since last <a href="../ztex/ZtexUsbReader.html#start(long)"><code>start(long)</code></a>.</dd></dl>
</li>
</ul>
<a name="bufSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufSize</h4>
<pre>public int bufSize()</pre>
<div class="block">Return the buffer size.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The buffer size.</dd></dl>
</li>
</ul>
<a name="cancel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public void cancel()
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
<div class="block">Cancels all pending transfers, also see <a href="../ztex/ZtexUsbReader.html#cancelWait(int)"><code>cancelWait(int)</code></a>,</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>UsbExecption</code> - if an error occurred.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl>
</li>
</ul>
<a name="cancelWait(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelWait</h4>
<pre>public boolean cancelWait(int timeout)
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
<div class="block">Cancels all pending transfers and waits until transfers are canceled.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Timeout in ms</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if all transfers are finished or cancelled</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>UsbExecption</code> - if an error occurred.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></code></dd></dl>
</li>
</ul>
<a name="start(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>start</h4>
<pre>public void start(long maxCount)
throws <a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></pre>
<div class="block">Start the reader.
The amount of buffers to be read is defined using the parameter maxCount.
A value of 0 starts infinite reads, a value of -1 starts the reader in speed test mode.
In this mode the buffer content is ignored and new read transfer are initiated immediately.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxCount</code> - Maximum amount of bytes to read or 0 for infinite transfers or <0 for speed test mode.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>UsbExecption</code> - if an error occurred.</dd>
<dd><code><a href="../ztex/UsbException.html" title="class in ztex">UsbException</a></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/ZtexScanBus1.html" title="class in ztex"><span class="strong">Prev Class</span></a></li>
<li><a href="../ztex/ZtexUsbWriter.html" title="class in ztex"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?ztex/ZtexUsbReader.html" target="_top">Frames</a></li>
<li><a href="ZtexUsbReader.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>