Transfer (usb4java 1.3.0 API)

java.lang.Object
- org.usb4java.Transfer

```
public final class Transfer
extends Object
```
The generic USB transfer structure. The user populates this structure and then submits it in order to request a transfer. After the transfer has completed, the library populates the transfer with the results and passes it back to the user.

Author:

Klaus Reimer (k@ailis.de)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actualLength()` Returns the actual length of data that was transferred.
`ByteBuffer`	`buffer()` Returns the data buffer.
`TransferCallback`	`callback()` Returns the current callback object.
`DeviceHandle`	`devHandle()` Returns the handle of the device that this transfer will be submitted to.
`byte`	`endpoint()` Returns the address of the endpoint where this transfer will be sent.
`boolean`	`equals(Object obj)`
`byte`	`flags()` Returns the bitwise OR combination of libusb transfer flags.
`long`	`getPointer()` Returns the native pointer.
`int`	`hashCode()`
`IsoPacketDescriptor[]`	`isoPacketDesc()` Array of isochronous packet descriptors, for isochronous transfers only.
`int`	`length()` Returns the length of the data buffer.
`int`	`numIsoPackets()` Returns the number of isochronous packets.
`void`	`setBuffer(ByteBuffer buffer)` Sets the data buffer.
`void`	`setCallback(TransferCallback callback)` Sets the callback object.
`void`	`setDevHandle(DeviceHandle handle)` Sets the handle of the device that this transfer will be submitted to.
`void`	`setEndpoint(byte endpoint)` Sets the address of the endpoint where this transfer will be sent.
`void`	`setFlags(byte flags)` Sets the bitwise OR combination of libusb transfer flags.
`void`	`setLength(int length)` Sets the length of the data buffer.
`void`	`setNumIsoPackets(int numIsoPackets)` Sets the number of isochronous packets.
`void`	`setStreamId(int streamId)` Set a transfer's bulk stream id.
`void`	`setTimeout(long timeout)` Sets the timeout for this transfer in milliseconds.
`void`	`setType(byte type)` Sets the type of the endpoint.
`void`	`setUserData(Object userData)` Sets the user data object, representing user context data to pass to the callback function and that can be accessed from there.
`int`	`status()` Returns the status of the transfer.
`int`	`streamId()` Get a transfer's bulk stream id.
`long`	`timeout()` Returns the timeout for this transfer in milliseconds.
`String`	`toString()`
`byte`	`type()` Returns the type of the endpoint.
`Object`	`userData()` Returns the current user data object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getPointer
```
public long getPointer()
```
    Returns the native pointer.
    
    Returns:
    
    The native pointer.
  - devHandle
```
public DeviceHandle devHandle()
```
    Returns the handle of the device that this transfer will be submitted to.
    
    Returns:
    
    The handle of the device.
  - setDevHandle
```
public void setDevHandle(DeviceHandle handle)
```
    Sets the handle of the device that this transfer will be submitted to.
    
    Parameters:
    
    handle - The handle of the device.
  - flags
```
public byte flags()
```
    Returns the bitwise OR combination of libusb transfer flags.
    
    Returns:
    
    The transfer flags.
  - setFlags
```
public void setFlags(byte flags)
```
    Sets the bitwise OR combination of libusb transfer flags.
    
    Parameters:
    
    flags - The transfer flags to set.
  - endpoint
```
public byte endpoint()
```
    Returns the address of the endpoint where this transfer will be sent.
    
    Returns:
    
    The endpoint address.
  - setEndpoint
```
public void setEndpoint(byte endpoint)
```
    Sets the address of the endpoint where this transfer will be sent.
    
    Parameters:
    
    endpoint - The endpoint address to set
  - type
```
public byte type()
```
    Returns the type of the endpoint.
    
    Returns:
    
    The endpoint type.
  - setType
```
public void setType(byte type)
```
    Sets the type of the endpoint.
    
    Parameters:
    
    type - The endpoint type to set.
  - timeout
```
public long timeout()
```
    Returns the timeout for this transfer in milliseconds. A value of 0 indicates no timeout.
    
    Returns:
    
    The timeout.
  - setTimeout
```
public void setTimeout(long timeout)
```
    Sets the timeout for this transfer in milliseconds. A value of 0 indicates no timeout.
    
    Parameters:
    
    timeout - The timeout to set.
  - status
```
public int status()
```
    Returns the status of the transfer. Read-only, and only for use within transfer callback function. If this is an isochronous transfer, this field may read LibUsb.TRANSFER_COMPLETED even if there were errors in the frames. Use the status field in each packet to determine if errors occurred.
    
    Returns:
    
    The transfer status.
  - length
```
public int length()
```
    Returns the length of the data buffer.
    
    Returns:
    
    The data buffer length.
  - setLength
```
public void setLength(int length)
```
    Sets the length of the data buffer. This is checked against the maximum capacity of the supplied ByteBuffer.
    
    Parameters:
    
    length - The data buffer length to set.
  - actualLength
```
public int actualLength()
```
    Returns the actual length of data that was transferred. Read-only, and only for use within transfer callback function. Not valid for isochronous endpoint transfers.
    
    Returns:
    
    The actual length of the transferred data.
  - callback
```
public TransferCallback callback()
```
    Returns the current callback object.
    
    Returns:
    
    The current callback object.
  - setCallback
```
public void setCallback(TransferCallback callback)
```
    Sets the callback object. This will be invoked when the transfer completes, fails, or is cancelled.
    
    Parameters:
    
    callback - The callback object to use.
  - userData
```
public Object userData()
```
    Returns the current user data object.
    
    Returns:
    
    The current user data object.
  - setUserData
```
public void setUserData(Object userData)
```
    Sets the user data object, representing user context data to pass to the callback function and that can be accessed from there.
    
    Parameters:
    
    userData - The user data object to set.
  - buffer
```
public ByteBuffer buffer()
```
    Returns the data buffer.
    
    Returns:
    
    The data buffer.
  - setBuffer
```
public void setBuffer(ByteBuffer buffer)
```
    Sets the data buffer.
    
    Parameters:
    
    buffer - The data buffer to set.
  - numIsoPackets
```
public int numIsoPackets()
```
    Returns the number of isochronous packets. Only used for I/O with isochronous endpoints.
    
    Returns:
    
    The number of isochronous packets.
  - setNumIsoPackets
```
public void setNumIsoPackets(int numIsoPackets)
```
    Sets the number of isochronous packets.
    
    Parameters:
    
    numIsoPackets - The number of isochronous packets to set.
  - isoPacketDesc
```
public IsoPacketDescriptor[] isoPacketDesc()
```
    Array of isochronous packet descriptors, for isochronous transfers only.
    
    Returns:
    
    The array of isochronous packet descriptors.
  - streamId
```
public int streamId()
```
    Get a transfer's bulk stream id.
    
    Returns:
    
    The stream id for the transfer.
  - setStreamId
```
public void setStreamId(int streamId)
```
    Set a transfer's bulk stream id. Note: users are advised to use LibUsb.fillBulkStreamTransfer() instead of calling this function directly.
    
    Parameters:
    
    streamId - The stream id to set.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Transfer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPointer

devHandle

setDevHandle

flags

setFlags

endpoint

setEndpoint

type

setType

timeout

setTimeout

status

length

setLength

actualLength

callback

setCallback

userData

setUserData

buffer

setBuffer

numIsoPackets

setNumIsoPackets

isoPacketDesc

streamId

setStreamId

hashCode

equals

toString