com.clover.remote.client.transport.usb

Class UsbCloverManager<T>

java.lang.Object

com.clover.remote.client.transport.usb.UsbCloverManager<T>

Direct Known Subclasses:

RemoteUsbManager, UsbAccessorySetupUsbManager

public abstract class UsbCloverManager<T>
extends java.lang.Object

This class is designed to be a reusable USB communication manager for devices that bulk transfer data. Instances of this class should be singletons.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UsbCloverManager.InputResult
static class	UsbCloverManager.UsbConnectException
static class	UsbCloverManager.UsbDeviceNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CONNECTION_RETRY_WAIT_MS
protected static int	CONNECTION_TIMEOUT_MS
protected android.hardware.usb.UsbDeviceConnection	mConnection
protected static int	READ_TIMEOUT_MS
protected static int	SETUP_RETRY_WAIT_MS
protected static int	SETUP_TIMEOUT_MS
protected static boolean	VERBOSE
protected static int	WRITE_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
UsbCloverManager(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	disconnect()
static android.hardware.usb.UsbDevice	findDevice(android.hardware.usb.UsbManager usbManager, android.util.Pair<java.lang.Integer,java.lang.Integer>[] vendorProductIds)
protected abstract int	getMaxWriteDataSize()
protected abstract int	getReadSize()
protected int	getReadTimeOut() Returns the amount of time to wait before read fails, 0 means wait forever.
protected abstract android.util.Pair<java.lang.Integer,java.lang.Integer>[]	getVendorProductIds()
protected boolean	isBulkInterface()
boolean	isConnected()
protected boolean	isInterfaceMatch(android.hardware.usb.UsbInterface usbInterface)
static boolean	isMatch(android.hardware.usb.UsbDevice device, android.util.Pair<java.lang.Integer,java.lang.Integer>[] vendorProductIds)
protected void	onPostDisconnect() Called after disconnect is complete, does nothing by default and may be overridden.
protected void	onPreConnect() Called before a connection is attempted, does nothing by default and may be overridden.
protected void	onTransferError() Called when a transfer error occurs, does nothing by default and may be overridden.
void	open() Open a connection to the USB device and begin a session.
protected com.clover.remote.client.transport.usb.UsbCloverManager.DeviceStatus	postStatusChange(com.clover.remote.client.transport.usb.UsbCloverManager.DeviceStatus status)
protected UsbCloverManager.InputResult	processInputData(byte[] inputData, java.io.ByteArrayOutputStream outputStream, T params) Optionally override this method to perform data processing on the input data bytes before they are returned.
protected byte[]	processOutputData(byte[] outputData, T params) Optionally override this method to perform data processing on the output bytes before they are sent.
byte[]	read(T params)
protected byte[]	unwrapReadPacket(java.nio.ByteBuffer inDataBuffer)
protected byte[]	wrapWritePacket(java.nio.ByteBuffer outDataBuffer, int numBytesToTransfer)
int	write(byte[] outputData, T params)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERBOSE

protected static final boolean VERBOSE

See Also:

Constant Field Values

CONNECTION_TIMEOUT_MS

protected static final int CONNECTION_TIMEOUT_MS

See Also:

Constant Field Values

CONNECTION_RETRY_WAIT_MS

protected static final int CONNECTION_RETRY_WAIT_MS

See Also:

Constant Field Values

SETUP_TIMEOUT_MS

protected static final int SETUP_TIMEOUT_MS

See Also:

Constant Field Values

SETUP_RETRY_WAIT_MS

protected static final int SETUP_RETRY_WAIT_MS

See Also:

Constant Field Values

READ_TIMEOUT_MS

protected static final int READ_TIMEOUT_MS

See Also:

Constant Field Values

WRITE_TIMEOUT_MS

protected static final int WRITE_TIMEOUT_MS

See Also:

Constant Field Values

mConnection

protected android.hardware.usb.UsbDeviceConnection mConnection

Constructor Detail

UsbCloverManager

public UsbCloverManager(android.content.Context context)

Method Detail

open

public void open()
          throws UsbCloverManager.UsbConnectException

Open a connection to the USB device and begin a session. Only one session may be opened at a time.

Throws:

UsbCloverManager.UsbConnectException - if connecting to the device failed

getReadSize

protected abstract int getReadSize()

getMaxWriteDataSize

protected abstract int getMaxWriteDataSize()

onPreConnect

protected void onPreConnect()

Called before a connection is attempted, does nothing by default and may be overridden.

findDevice

public static android.hardware.usb.UsbDevice findDevice(android.hardware.usb.UsbManager usbManager,
                                                        android.util.Pair<java.lang.Integer,java.lang.Integer>[] vendorProductIds)

getVendorProductIds

protected abstract android.util.Pair<java.lang.Integer,java.lang.Integer>[] getVendorProductIds()

isMatch

public static boolean isMatch(android.hardware.usb.UsbDevice device,
                              android.util.Pair<java.lang.Integer,java.lang.Integer>[] vendorProductIds)

isBulkInterface

protected boolean isBulkInterface()

isInterfaceMatch

protected boolean isInterfaceMatch(android.hardware.usb.UsbInterface usbInterface)

disconnect

public void disconnect()

onPostDisconnect

protected void onPostDisconnect()

Called after disconnect is complete, does nothing by default and may be overridden.

isConnected

public final boolean isConnected()

write

public int write(byte[] outputData,
                 T params)
          throws java.io.IOException,
                 java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

read

public byte[] read(T params)
            throws java.io.IOException,
                   java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

onTransferError

protected void onTransferError()

Called when a transfer error occurs, does nothing by default and may be overridden.

wrapWritePacket

protected byte[] wrapWritePacket(java.nio.ByteBuffer outDataBuffer,
                                 int numBytesToTransfer)

unwrapReadPacket

protected byte[] unwrapReadPacket(java.nio.ByteBuffer inDataBuffer)

getReadTimeOut

protected int getReadTimeOut()

Returns the amount of time to wait before read fails, 0 means wait forever.

processOutputData

protected byte[] processOutputData(byte[] outputData,
                                   T params)

Optionally override this method to perform data processing on the output bytes before they are sent. The returned byte array is used for the data transfer, the implementation may choose to modify the byte array parameter or return a new byte array.

processInputData

protected UsbCloverManager.InputResult processInputData(byte[] inputData,
                                                        java.io.ByteArrayOutputStream outputStream,
                                                        T params)

Optionally override this method to perform data processing on the input data bytes before they are returned. The implementation must write the desired output bytes to the ByteArrayOutputStream. Unlike #processOutputData(byte[], T) this function may be called multiple times in a single transfer depending on the return value of this function

Parameters:

inputData - buffer containing bytes read from the USB device

outputStream - stream containing bytes that will be returned to the caller

params - additional parameters which may allow the implementation to modify the way the byte array is interpreted

Returns:

CONTINUE to request more USB device data, COMPLETE to return the received data or ERROR if something is wrong

postStatusChange

protected final com.clover.remote.client.transport.usb.UsbCloverManager.DeviceStatus postStatusChange(com.clover.remote.client.transport.usb.UsbCloverManager.DeviceStatus status)