com.zebra.sdk.comm

Class UsbConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.UsbConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging, com.zebra.sdk.comm.internal.ConnectionI

public class UsbConnection
extends ConnectionA
implements com.zebra.sdk.comm.internal.ConnectionI

Establishes an Android USB connection to an attached Zebra USB printer.

Constructor Summary

Constructors

Constructor and Description
UsbConnection(android.hardware.usb.UsbManager manager, android.hardware.usb.UsbDevice device) Creates a new UsbConnection.
UsbConnection(android.hardware.usb.UsbManager manager, android.hardware.usb.UsbDevice device, int maxTimeoutForRead, int timeToWaitForMoreData) Creates a new UsbConnection.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<String,String>	getConnectionAttributes() For internal use of the Zebra Printer API only.
ConnectionReestablisher	getConnectionReestablisher(long thresholdTime) Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.
String	getDeviceName() Returns the USB device name.
android.hardware.usb.UsbManager	getManager() Returns the UsbManager object.
String	getManufacturer() Returns the printer's manufacturer.
UsbPermissionRequestor	getRequestor() Gets the @see com.zebra.sdk.comm.UsbPermissionRequestor instance.
String	getSerialNumber() Returns the serial number of the printer.
String	getSimpleConnectionName() Return the device name as the description.
byte[]	read(int maxBytesToRead) Reads maxBytesToRead of the available data from the connection.
void	setRequestor(UsbPermissionRequestor requestor) Sets the @see com.zebra.sdk.comm.UsbPermissionRequestor instance.
String	toString() Returns USB:[Device path] The USB device name is obtained from the device when this connection is opened.
void	write(byte[] data, int offset, int length) Writes length bytes from data starting at offset.

Methods inherited from class com.zebra.sdk.comm.ConnectionA

addWriteLogStream, bytesAvailable, close, getMaxDataToWrite, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, open, read, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxDataToWrite, setMaxTimeoutForRead, setReadTimeout, setTimeToWaitForMoreData, waitForData, write, write

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.zebra.sdk.comm.internal.ConnectionI

getMaxDataToWrite, read, setMaxDataToWrite, setReadTimeout

Methods inherited from interface com.zebra.sdk.comm.Connection

bytesAvailable, close, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, open, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxTimeoutForRead, setTimeToWaitForMoreData, waitForData, write, write

Constructor Detail

UsbConnection

public UsbConnection(android.hardware.usb.UsbManager manager,
             android.hardware.usb.UsbDevice device)

Creates a new UsbConnection.

Parameters:

manager - The UsbManager object used to create this UsbConnection.

device - The UsbDevice object.

UsbConnection

public UsbConnection(android.hardware.usb.UsbManager manager,
             android.hardware.usb.UsbDevice device,
             int maxTimeoutForRead,
             int timeToWaitForMoreData)

Creates a new UsbConnection.

Parameters:

manager - The UsbManager object used to create this UsbConnection.

device - The UsbDevice object.

maxTimeoutForRead - Maximum time to wait for read data.

timeToWaitForMoreData - Maximum time to wait for more data after initial data is sent from printer.

Method Detail

getManager

public android.hardware.usb.UsbManager getManager()

Returns the UsbManager object.

Returns:

UsbManager used to create this UsbConnection.

getDeviceName

public String getDeviceName()

Returns the USB device name.

Returns:

USB device name

toString

public String toString()

Returns USB:[Device path]
The USB device name is obtained from the device when this connection is opened.

Specified by:

toString in interface Connection

Overrides:

toString in class Object

Returns:

the connection description string.

See Also:

Connection.toString()

getSimpleConnectionName

public String getSimpleConnectionName()

Return the device name as the description.

Specified by:

getSimpleConnectionName in interface Connection

Returns:

a human-readable description of the connection.

See Also:

Connection.getSimpleConnectionName()

getConnectionReestablisher

public ConnectionReestablisher getConnectionReestablisher(long thresholdTime)
                                                   throws ConnectionException

Description copied from interface: Connection

Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.

• This call should be made while there is still an active connection to the printer (prior to issuing a command which will make the printer non-responsive).

Specified by:

getConnectionReestablisher in interface Connection

Overrides:

getConnectionReestablisher in class ConnectionA

Parameters:

thresholdTime - how long the Connection reestablisher will wait before attempting to reconnection to the printer

Returns:

ConnectionReestablisher

Throws:

ConnectionException - if the ConnectionReestablisher could not be created.

See Also:

ConnectionA.getConnectionReestablisher(long thresholdTime)

getRequestor

public UsbPermissionRequestor getRequestor()

Gets the @see com.zebra.sdk.comm.UsbPermissionRequestor instance.

Returns:

the requestor

setRequestor

public void setRequestor(UsbPermissionRequestor requestor)

Sets the @see com.zebra.sdk.comm.UsbPermissionRequestor instance.

Parameters:

requestor - The UsbPermissionRequestor object.

getManufacturer

public String getManufacturer()

Description copied from class: ConnectionA

Returns the printer's manufacturer.

Specified by:

getManufacturer in interface com.zebra.sdk.comm.internal.ConnectionI

Overrides:

getManufacturer in class ConnectionA

Returns:

The printer's manufacturer.

See Also:

ConnectionA.getManufacturer()

getSerialNumber

public String getSerialNumber()

Returns the serial number of the printer.

Returns:

The serial number.

read

public byte[] read(int maxBytesToRead)
            throws ConnectionException

Description copied from class: ConnectionA

Reads maxBytesToRead of the available data from the connection. This call is non-blocking.

Specified by:

read in interface com.zebra.sdk.comm.internal.ConnectionI

Overrides:

read in class ConnectionA

Parameters:

maxBytesToRead - number of bytes to read

Returns:

the bytes read from the connection.

Throws:

ConnectionException - if an I/O error occurs.

See Also:

ConnectionA.read(int)

write

public void write(byte[] data,
         int offset,
         int length)
           throws ConnectionException

Description copied from interface: Connection

Writes length bytes from data starting at offset. The connection must be open before this method is called. If write is called when a connection is closed, a ConnectionException is thrown.

Specified by:

write in interface Connection

Overrides:

write in class ConnectionA

Parameters:

data - the data.

offset - the start offset in the data.

length - number of bytes to write.

Throws:

ConnectionException - if an I/O error occurs.

See Also:

ConnectionA.write(byte[], int, int)

getConnectionAttributes

public java.util.Map<String,String> getConnectionAttributes()

For internal use of the Zebra Printer API only.

Returns:

Map containing the connection attributes.