UsbRequest

UsbRequest

UsbRequest()

cancel

open fun cancel(): Boolean

Cancels a pending queue operation.

close

open fun close(): Unit

Releases all resources related to this request.

getClientData

open fun getClientData(): Any!

Returns the client data for the request. This can be used in conjunction with setClientData to associate another object with this request, which can be useful for maintaining state between calls to #queue and android.hardware.usb.UsbDeviceConnection#requestWait

getEndpoint

open fun getEndpoint(): UsbEndpoint!

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

initialize

open fun initialize(
    connection: UsbDeviceConnection!, 
    endpoint: UsbEndpoint!
): Boolean

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.

queue

open fun queue(buffer: ByteBuffer?): Boolean

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

For OUT endpoints, the remaining bytes of the buffer will be sent on the endpoint. For IN endpoints, the endpoint will attempt to fill the remaining bytes of the buffer. If the queueing operation is successful, return true. The result will be returned via android.hardware.usb.UsbDeviceConnection#requestWait

queue

open fun queue(
    buffer: ByteBuffer!, 
    length: Int
): Boolean

Deprecated: Use queue(java.nio.ByteBuffer) instead.

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, return true. The result will be returned via android.hardware.usb.UsbDeviceConnection#requestWait

setClientData

open fun setClientData(data: Any!): Unit

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 and android.hardware.usb.UsbDeviceConnection#requestWait

finalize

protected open fun finalize(): Unit

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 Java 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.