Skip to content

Most visited

Recently visited

navigation
Added in API level 12

UsbRequest

public class UsbRequest
extends Object

java.lang.Object
   ↳ android.hardware.usb.UsbRequest


A class representing USB request packet. This can be used for both reading and writing data to or from a UsbDeviceConnection. UsbRequests can be used to transfer data on bulk and interrupt endpoints. Requests on bulk endpoints can be sent synchronously via bulkTransfer(UsbEndpoint, byte[], int, int) or asynchronously via queue(ByteBuffer, int) and requestWait(). Requests on interrupt endpoints are only send and received asynchronously.

Requests on endpoint zero are not supported by this class; use controlTransfer(int, int, int, int, byte[], int, int) for endpoint zero requests instead.

Summary

Public constructors

UsbRequest()

Public methods

boolean cancel()

Cancels a pending queue operation.

void close()

Releases all resources related to this request.

Object getClientData()

Returns the client data for the request.

UsbEndpoint getEndpoint()

Returns the endpoint for the request, or null if the request is not opened.

boolean initialize(UsbDeviceConnection connection, UsbEndpoint endpoint)

Initializes the request so it can read or write data on the given endpoint.

boolean queue(ByteBuffer buffer, int length)

Queues the request to send or receive data on its endpoint.

void setClientData(Object data)

Sets the client data for the request.

Protected methods

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class java.lang.Object

Public constructors

UsbRequest

Added in API level 12
UsbRequest ()

Public methods

cancel

Added in API level 12
boolean cancel ()

Cancels a pending queue operation.

Returns
boolean true if cancelling succeeded

close

Added in API level 12
void close ()

Releases all resources related to this request.

getClientData

Added in API level 12
Object getClientData ()

Returns the client data for the request. This can be used in conjunction with setClientData(Object) to associate another object with this request, which can be useful for maintaining state between calls to queue(ByteBuffer, int) and requestWait()

Returns
Object the client data for the request

getEndpoint

Added in API level 12
UsbEndpoint getEndpoint ()

Returns the endpoint for the request, or null if the request is not opened.

Returns
UsbEndpoint the request's endpoint

initialize

Added in API level 12
boolean initialize (UsbDeviceConnection connection, 
                UsbEndpoint endpoint)

Initializes the request so it can read or write data on the given endpoint. Whether the request allows reading or writing depends on the direction of the endpoint.

Parameters
connection UsbDeviceConnection
endpoint UsbEndpoint: the endpoint to be used for this request.
Returns
boolean true if the request was successfully opened.

queue

Added in API level 12
boolean queue (ByteBuffer buffer, 
                int length)

Queues the request to send or receive data on its endpoint. For OUT endpoints, the given buffer data will be sent on the endpoint. For IN endpoints, the endpoint will attempt to read the given number of bytes into the specified buffer. If the queueing operation is successful, we return true and the result will be returned via requestWait()

Parameters
buffer ByteBuffer: the buffer containing the bytes to write, or location to store the results of a read
length int: number of bytes to read or write
Returns
boolean true if the queueing operation succeeded

setClientData

Added in API level 12
void setClientData (Object data)

Sets the client data for the request. This can be used in conjunction with getClientData() to associate another object with this request, which can be useful for maintaining state between calls to queue(ByteBuffer, int) and requestWait()

Parameters
data Object: the client data for the request

Protected methods

finalize

Added in API level 12
void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the JavaTM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
Throwable
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.