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 a direct connection to an attached Zebra USB printer without requiring the presence of a USB driver

Constructor Summary

Constructors

Constructor and Description
UsbConnection(String symbolicName) Initializes a new instance of the UsbConnection class.
UsbConnection(String symbolicName, int maxTimeoutForRead, int timeToWaitForMoreData) Initializes a new instance of the UsbConnection class.

Method Summary

Methods

Modifier and Type	Method and Description
int	bytesAvailable() Returns number of bytes currently read from printer.
void	close() Closes this connection and releases any system resources associated with the connection.
com.zebra.sdk.comm.ConnectionReestablisher	getConnectionReestablisher(long thresholdTime) Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.
String	getManufacturer() Returns the printer's manufacturer.
int	getMaxTimeoutForRead() Returns the maximum time, in milliseconds, to wait for any data to be received.
String	getSerialNumber()
String	getSimpleConnectionName() Return a human-readable description of the connection.
void	open() Opens the connection to a device.
byte[]	read(int maxBytesToRead) Reads up to maxBytesToRead into byte array Performing reads using DriverPrinterConnection and UsbConnection concurrently could cause indeterminate reads
int	readChar() Reads the next byte of data from the connection, similar to a Java InputStream.
void	setMaxTimeoutForRead(int maxTimeoutForRead) Set the maximum time, in milliseconds, to wait for any data to be received
String	toString() Returns the Connection Builder name of the USB device.
void	write(byte[] data) Writes data.length bytes from the specified byte array to this output stream.
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, getMaxDataToWrite, getTimeToWaitForMoreData, isConnected, read, read, read, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxDataToWrite, setReadTimeout, setTimeToWaitForMoreData, waitForData, 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

getTimeToWaitForMoreData, isConnected, read, read, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setTimeToWaitForMoreData, waitForData, write

Constructor Detail

UsbConnection

public UsbConnection(String symbolicName)
              throws ConnectionException

Initializes a new instance of the UsbConnection class. This constructor will attempt a connection to the printer specified in the symbolic name.

Parameters:

symbolicName - the USB symbolic name for the device returned by the UsbDiscoverer.getZebraUsbPrinters() member function.

Throws:

ConnectionException - if the system is not running the Windows operating system or if the device cannot be found.

UsbConnection

public UsbConnection(String symbolicName,
             int maxTimeoutForRead,
             int timeToWaitForMoreData)
              throws ConnectionException

Initializes a new instance of the UsbConnection class. This constructor will attempt a connection to the printer specified in the symbolic name.

Parameters:

symbolicName - the USB symbolic name for the device returned by the UsbDiscoverer.getZebraUsbPrinters() member function.

maxTimeoutForRead - Maximum time to wait for read data

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

Throws:

ConnectionException - if the system is not running the Windows operating system or if the device cannot be found.

Method Detail

open

public void open()
          throws ConnectionException

Description copied from interface: Connection

Opens the connection to a device. If the open method is called when this connection has already been opened, this call is ignored. When a handle to the connection is no longer needed, you must call Connection.close() to free up system resources.

Specified by:

open in interface Connection

Overrides:

open in class ConnectionA

Throws:

ConnectionException - if the connection cannot be established.

See Also:

ConnectionA.open()

close

public void close()
           throws ConnectionException

Description copied from interface: Connection

Closes this connection and releases any system resources associated with the connection. If the connection is already closed then invoking this method has no effect.

Specified by:

close in interface Connection

Overrides:

close in class ConnectionA

Throws:

ConnectionException - if an I/O error occurs.

See Also:

ConnectionA.close()

write

public void write(byte[] data)
           throws ConnectionException

Description copied from interface: Connection

Writes data.length bytes from the specified byte array to this output stream. 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.

Throws:

ConnectionException - if an I/O error occurs.

See Also:

ConnectionA.write(byte[])

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)

readChar

public int readChar()
             throws ConnectionException

Description copied from interface: Connection

Reads the next byte of data from the connection, similar to a Java InputStream. The value byte is returned as an int in the range of 0 to 255. If no byte is available on the connection the value -1 is returned.

 int singleCharacter = printerConnection.readChar();
 

Specified by:

readChar in interface Connection

Overrides:

readChar in class ConnectionA

Returns:

the next byte from the connection

Throws:

ConnectionException - if an I/O error occurs.

See Also:

Connection.readChar()

read

public byte[] read(int maxBytesToRead)
            throws ConnectionException

Reads up to maxBytesToRead into byte array
Performing reads using DriverPrinterConnection and UsbConnection concurrently could cause indeterminate reads

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.

bytesAvailable

public int bytesAvailable()
                   throws ConnectionException

Returns number of bytes currently read from printer.

Specified by:

bytesAvailable in interface Connection

Overrides:

bytesAvailable in class ConnectionA

Returns:

number of bytes currently read from printer.

Throws:

ConnectionException - if an I/O error occurs.

See Also:

Connection.bytesAvailable()

getSimpleConnectionName

public String getSimpleConnectionName()

Description copied from interface: Connection

Return a human-readable description of the connection.

Specified by:

getSimpleConnectionName in interface Connection

Returns:

a human-readable description of the connection.

See Also:

Connection.getSimpleConnectionName()

getSerialNumber

public String getSerialNumber()

Returns:

serialNumber - The printer's serial number.

toString

public String toString()

Returns the Connection Builder name of the USB device.

Specified by:

toString in interface Connection

Overrides:

toString in class Object

Returns:

the connection description string.

getConnectionReestablisher

public com.zebra.sdk.comm.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)

setMaxTimeoutForRead

public void setMaxTimeoutForRead(int maxTimeoutForRead)

Description copied from interface: Connection

Set the maximum time, in milliseconds, to wait for any data to be received

Specified by:

setMaxTimeoutForRead in interface Connection

Overrides:

setMaxTimeoutForRead in class ConnectionA

Parameters:

maxTimeoutForRead - the maximum time, in milliseconds, to wait for any data to be received.

See Also:

ConnectionA.setMaxTimeoutForRead(int)

getMaxTimeoutForRead

public int getMaxTimeoutForRead()

Description copied from interface: Connection

Returns the maximum time, in milliseconds, to wait for any data to be received.

Specified by:

getMaxTimeoutForRead in interface Connection

Overrides:

getMaxTimeoutForRead in class ConnectionA

Returns:

the maximum time, in milliseconds, to wait for any data to be received.

See Also:

ConnectionA.getMaxTimeoutForRead()

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:

ConnectionI.getManufacturer()