org.usb4java

Class EndpointDescriptor

java.lang.Object

org.usb4java.EndpointDescriptor

public final class EndpointDescriptor
extends Object

A structure representing the standard USB endpoint descriptor. This descriptor is documented in section 9.6.6 of the USB 3.0 specification. All multiple-byte fields are represented in host-endian format.

Author:

Klaus Reimer (k@ailis.de)

Method Summary

Modifier and Type	Method and Description
byte	bDescriptorType() Returns the descriptor type.
byte	bEndpointAddress() The address of the endpoint described by this descriptor.
byte	bInterval() Returns the interval for polling endpoint for data transfers.
byte	bLength() Returns the size of this descriptor (in bytes).
byte	bmAttributes() Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
byte	bRefresh() For audio devices only: the rate at which synchronization feedback is provided.
byte	bSynchAddress() For audio devices only: the address of the synch endpoint.
String	dump() Returns a dump of this descriptor.
boolean	equals(Object obj)
ByteBuffer	extra() Extra descriptors.
int	extraLength() Length of the extra descriptors, in bytes.
long	getPointer() Returns the native pointer.
int	hashCode()
String	toString()
short	wMaxPacketSize() Returns the maximum packet size this endpoint is capable of sending/receiving.

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.

bLength

public byte bLength()

Returns the size of this descriptor (in bytes).

Returns:

The size of this descriptor (in bytes).

bDescriptorType

public byte bDescriptorType()

Returns the descriptor type. Will have value LibUsb.DT_ENDPOINT in this context.

Returns:

The descriptor type.

bEndpointAddress

public byte bEndpointAddress()

The address of the endpoint described by this descriptor. Bits 0:3 are the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction (Either LibUsb.ENDPOINT_IN or LibUsb.ENDPOINT_OUT).

Returns:

The endpoint address.

bmAttributes

public byte bmAttributes()

Attributes which apply to the endpoint when it is configured using the bConfigurationValue. Bits 0:1 determine the transfer type and correspond to the LibUsb.TRANSFER_TYPE_* constants. Bits 2:3 are only used for isochronous endpoints and correspond to the LibUsb.ISO_SYNC_TYPE_* constants. Bits 4:5 are also only used for isochronous endpoints and correspond to the LibUsb.ISO_USAGE_TYPE_* constants. Bits 6:7 are reserved.

Returns:

The attributes.

wMaxPacketSize

public short wMaxPacketSize()

Returns the maximum packet size this endpoint is capable of sending/receiving.

Returns:

The maximum packet size.

bInterval

public byte bInterval()

Returns the interval for polling endpoint for data transfers.

Returns:

The polling interval.

bRefresh

public byte bRefresh()

For audio devices only: the rate at which synchronization feedback is provided.

Returns:

The synchronization feedback rate.

bSynchAddress

public byte bSynchAddress()

For audio devices only: the address of the synch endpoint.

Returns:

The synch endpoint address.

extra

public ByteBuffer extra()

Extra descriptors. If libusb encounters unknown endpoint descriptors, it will store them here, should you wish to parse them.

Returns:

The extra descriptors.

extraLength

public int extraLength()

Length of the extra descriptors, in bytes.

Returns:

The extra descriptors length.

dump

public String dump()

Returns a dump of this descriptor.

Returns:

The descriptor dump.

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