org.usb4java

Class SsEndpointCompanionDescriptor

java.lang.Object

org.usb4java.SsEndpointCompanionDescriptor

public final class SsEndpointCompanionDescriptor
extends Object

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

Author:

Klaus Reimer (k@ailis.de)

Constructor Summary

Constructors

Constructor and Description
SsEndpointCompanionDescriptor() Constructs a new descriptor which can be passed to the LibUsb.getSsEndpointCompanionDescriptor(Context, EndpointDescriptor, SsEndpointCompanionDescriptor) method.

Method Summary

Modifier and Type	Method and Description
byte	bDescriptorType() Returns the descriptor type.
byte	bLength() Returns the size of this descriptor (in bytes).
byte	bmAttributes() Returns the attributes.
byte	bMaxBurst() Returns the maximum number of packets the endpoint can send or receive as part of a burst.
String	dump() Returns a dump of this descriptor.
boolean	equals(Object obj)
long	getPointer() Returns the native pointer.
int	hashCode()
String	toString()
short	wBytesPerInterval() Returns the total number of bytes this endpoint will transfer every service interval.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SsEndpointCompanionDescriptor

public SsEndpointCompanionDescriptor()

Constructs a new descriptor which can be passed to the LibUsb.getSsEndpointCompanionDescriptor(Context, EndpointDescriptor, SsEndpointCompanionDescriptor) method.

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 descriptor size in bytes;

bDescriptorType

public byte bDescriptorType()

Returns the descriptor type.

Returns:

The descriptor type.

bMaxBurst

public byte bMaxBurst()

Returns the maximum number of packets the endpoint can send or receive as part of a burst.

Returns:

The maximum number of packets as part of a burst.

bmAttributes

public byte bmAttributes()

Returns the attributes. In bulk endpoint: bits 4:0 represents the maximum number of streams the EP supports. In isochronous endpoint: bits 1:0 represents the Mult - a zero based value that determines the maximum number of packets within a service interval.

Returns:

The attributes.

wBytesPerInterval

public short wBytesPerInterval()

Returns the total number of bytes this endpoint will transfer every service interval. Valid only for periodic endpoints.

Returns:

The total number of bytes per service interval.

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