|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectztex.ZtexUsbReader
public class ZtexUsbReader
A helper class to implement asynchronous bulk and interrupt read transfers. This class also has a speed test mode.
Constructor Summary | |
---|---|
ZtexUsbReader(org.usb4java.DeviceHandle p_handle,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)
Creates the reader for a given USB device and endpoint number. |
|
ZtexUsbReader(Ztex1 ztex,
int p_ep,
boolean p_isInt,
int p_bufNum,
int p_bufSize)
Creates the reader from a given ZTEX device and endpoint number. |
|
ZtexUsbReader(Ztex1v1 ztex,
int p_bufNum,
int p_bufSize)
Creates the reader for the input endpoint of the default interface of a ZTEX device. |
Method Summary | |
---|---|
int |
bufSize()
Return the buffer size. |
long |
byteCount()
Return the number of bytes read since last start(long) . |
void |
cancel()
Cancels all pending transfers, also see cancelWait(int) , |
boolean |
cancelWait(int timeout)
Cancels all pending transfers and waits until transfers are canceled. |
int |
getBuffer(byte[] buf,
int timeout)
Get the next buffer. |
void |
start(long maxCount)
Start the reader. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ZtexUsbReader(org.usb4java.DeviceHandle p_handle, int p_ep, boolean p_isInt, int p_bufNum, int p_bufSize)
p_handle
- The device handle used for communication (must be opened).p_ep
- The input endpoint.p_isInt
- True if it is an interrupt transfer.p_bufSize
- size of each buffer. Typical values are 64KByte to 512KBytep_bufNum
- number of buffer. Recommended queue size is 2MByte to 8MByte.public ZtexUsbReader(Ztex1 ztex, int p_ep, boolean p_isInt, int p_bufNum, int p_bufSize)
ztex
- The ZTEX device.p_ep
- The number of the input endpointp_isInt
- True if it is an interrupt transfer.p_bufSize
- size of each buffer. Typical values are 64KByte to 512KBytep_bufNum
- number of buffer. Recommended queue size is 2MByte to 8MByte.public ZtexUsbReader(Ztex1v1 ztex, int p_bufNum, int p_bufSize) throws InvalidFirmwareException, UsbException, CapabilityException
ztex
- The ZTEX device.p_bufSize
- size of each buffer. Typical values are 64KByte to 512KBytep_bufNum
- number of buffer. Recommended queue size is 2MByte to 8MByte.
InvalidFirmwareException
UsbException
CapabilityException
Method Detail |
---|
public int getBuffer(byte[] buf, int timeout) throws UsbException
start(long)
.
buf
- The byte array where to store the data.timeout
- Timeout in ms. If timeout occurs the function returns -1.
UsbExecption
- if an error occurred.
UsbException
public long byteCount()
start(long)
.
start(long)
.public int bufSize()
public void cancel() throws UsbException
cancelWait(int)
,
UsbExecption
- if an error occurred.
UsbException
public boolean cancelWait(int timeout) throws UsbException
UsbExecption
- if an error occurred.
UsbException
public void start(long maxCount) throws UsbException
maxCount
- Maximum amount of bytes to read or 0 for infinite transfers or <0 for speed test mode.
UsbExecption
- if an error occurred.
UsbException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |