Top Description Fields Constructors Methods
javax.usb.event

public Class UsbPipeEvent

extends EventObject
Class Inheritance
Known Direct Subclasses
javax.usb.event.UsbPipeDataEvent, javax.usb.event.UsbPipeErrorEvent
Imports
java.util.*, javax.usb.*

Class for USB pipe events.
Authors
E. Michael Maximilien, Dan Streetman

Field Summary

Modifier and TypeField and Description
private UsbIrp
Inherited from java.util.EventObject:
source

Constructor Summary

AccessConstructor and Description
public
UsbPipeEvent(UsbPipe
The source UsbPipe.
source
)

Constructor.

public
UsbPipeEvent(UsbPipe
The source UsbPipe.
source
,
UsbIrp
The UsbIrp.
uI
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public UsbIrp

Returns:

The associated UsbIrp, or null.
getUsbIrp
()

Get the UsbIrp associated with this event.

public UsbPipe

Returns:

The associated UsbPipe.
getUsbPipe
()

Get the UsbPipe.

public boolean

Returns:

If this has an associated UsbIrp.
hasUsbIrp
()

If this has an associated UsbIrp.

Inherited from java.util.EventObject:
getSourcetoString

Field Detail

usbIrpback to summary
private UsbIrp usbIrp

Constructor Detail

UsbPipeEventback to summary
public UsbPipeEvent(UsbPipe source)

Constructor.

This should only be used if there is no UsbIrp associated with this event.

Parameters
source:UsbPipe

The source UsbPipe.

UsbPipeEventback to summary
public UsbPipeEvent(UsbPipe source, UsbIrp uI)

Constructor.

Parameters
source:UsbPipe

The source UsbPipe.

uI:UsbIrp

The UsbIrp.

Method Detail

getUsbIrpback to summary
public UsbIrp getUsbIrp()

Get the UsbIrp associated with this event.

If there is no UsbIrp associated with this event, this returns null.

Returns:UsbIrp

The associated UsbIrp, or null.

getUsbPipeback to summary
public UsbPipe getUsbPipe()

Get the UsbPipe.

Returns:UsbPipe

The associated UsbPipe.

hasUsbIrpback to summary
public boolean hasUsbIrp()

If this has an associated UsbIrp.

Note that even if a byte[] was submitted to a UsbPipe, if the implementation used/created a UsbIrp to manage the submission, it may (or may not) provide that UsbIrp in any event generated from the submission.

Returns:boolean

If this has an associated UsbIrp.