com.zebra.sdk.comm

Class DriverPrinterConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.DriverPrinterConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging

public class DriverPrinterConnection
extends ConnectionA

Establishes a USB connection to a printer. This class is only supported on Windows PC platforms.

package test.zebra.sdk.comm.examples;
 
 import com.zebra.sdk.comm.Connection;
 import com.zebra.sdk.comm.ConnectionException;
 import com.zebra.sdk.comm.DriverPrinterConnection;
 
 public class DriverPrinterConnectionExample {
 
     public static void main(String[] args) throws Exception {
         DriverPrinterConnectionExample example = new DriverPrinterConnectionExample();
 
         example.sendZplOverUsb("ZDesigner QLn320");
         example.sendCpclOverUsb("ZDesigner QLn320");
     }
 
     private void sendZplOverUsb(String printerName) throws ConnectionException {
         // Instantiate connection for ZPL USB port for given printer name
         Connection thePrinterConn = new DriverPrinterConnection(printerName);
 
         try {
             // Open the connection - physical connection is established here.
             thePrinterConn.open();
 
             // This example prints "This is a ZPL test." near the top of the label.
             String zplData = "^XA^FO20,20^A0N,25,25^FDThis is a ZPL test.^FS^XZ";
 
             // Send the data to printer as a byte array.
             thePrinterConn.write(zplData.getBytes());
         } catch (ConnectionException e) {
             // Handle communications error here.
             e.printStackTrace();
         } finally {
             // Close the connection to release resources.
             thePrinterConn.close();
         }
     }
 
     private void sendCpclOverUsb(String printerName) throws ConnectionException {
         // Instantiate connection for CPCL USB port for given printer name
         Connection thePrinterConn = new DriverPrinterConnection(printerName);
 
         try {
             // Open the connection - physical connection is established here.
             thePrinterConn.open();
 
             // This example prints "This is a CPCL test." near the top of the label.
             String cpclData = "! 0 200 200 210 1\r\n" + "TEXT 4 0 30 40 This is a CPCL test.\r\n" + "FORM\r\n" + "PRINT\r\n";
 
             // Send the data to printer as a byte array.
             thePrinterConn.write(cpclData.getBytes());
         } catch (ConnectionException e) {
             // Handle communications error here.
             e.printStackTrace();
         } finally {
             // Close the connection to release resources.
             thePrinterConn.close();
         }
     }
 }
 

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	bytesAvailable() Returns the number of bytes available on the connection.
void	close() Closes this connection and releases any system resources associated with the connection.
ConnectionReestablisher	getConnectionReestablisher(long thresholdTime) Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.
String	getPrinterName() Returns the name of the printer.
String	getSimpleConnectionName() Return the printer name as the description.
void	open() Opens the connection to a device.
byte[]	read() Reads all the available data from the connection.
int	readChar() Reads the next byte of data from the connection, similar to a Java InputStream.
String	toString() See the classes which implement this method for the format of the description string.
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, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, read, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxTimeoutForRead, setTimeToWaitForMoreData, waitForData, write, write

Methods inherited from class Object

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

Constructor Detail

DriverPrinterConnection

public DriverPrinterConnection(String printerName)
                        throws ConnectionException

Initializes a new instance of the DriverPrinterConnection class. This constructor will use the default timeouts for Connection.read(). The default timeout is a maximum of 5 seconds for any data to be received. If no more data is available after 500 milliseconds the read operation is assumed to be complete.
To specify timeouts other than the defaults, use:
DriverPrinterConnection(String, int, int).

Parameters:

printerName - the printer name

Throws:

ConnectionException

DriverPrinterConnection

public DriverPrinterConnection(String printerName,
                       int maxTimeoutForRead,
                       int timeToWaitForMoreData)
                        throws ConnectionException

Initializes a new instance of the DriverPrinterConnection class. This constructor will use the specified timeouts for Connection.read(). The timeout is a maximum of maxTimeoutForRead milliseconds for any data to be received. If no more data is available after timeToWaitForMoreData milliseconds the read operation is assumed to be complete.

Parameters:

printerName - the printer name

maxTimeoutForRead - maximum milliseconds to wait for the initial data to be received

timeToWaitForMoreData - maximum milliseconds to wait for additional data to be received

Throws:

ConnectionException

Method Detail

getPrinterName

public String getPrinterName()

Returns the name of the printer.

Returns:

The name of the printer.

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:

Connection.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:

Connection.close()

read

public byte[] read()
            throws ConnectionException

Description copied from interface: Connection

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

 byte[] data = printerConnection.read();
 

Specified by:

read in interface Connection

Overrides:

read in class ConnectionA

Returns:

the bytes read from the connection.

Throws:

ConnectionException - if an I/O error occurs.

See Also:


Performing reads using DriverPrinterConnection and UsbConnection concurrently could cause indeterminate reads

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()

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:

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

bytesAvailable

public int bytesAvailable()
                   throws ConnectionException

Returns the number of bytes available on the connection. Note that this is a blocking call.

Specified by:

bytesAvailable in interface Connection

Overrides:

bytesAvailable in class ConnectionA

Returns:

estimated number of bytes available.

Throws:

ConnectionException - if an I/O error occurs.

See Also:

Connection.bytesAvailable()

toString

public String toString()

Description copied from interface: Connection

See the classes which implement this method for the format of the description string.

Specified by:

toString in interface Connection

Overrides:

toString in class Object

Returns:

the connection description string.

See Also:

Object.toString()

getSimpleConnectionName

public String getSimpleConnectionName()

Return the printer name as the description.

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.

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)