com.zebra.sdk.comm

Class TcpConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.TcpConnection

All Implemented Interfaces:

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

public class TcpConnection
extends ConnectionA
implements IpAddressable, com.zebra.sdk.comm.internal.ConnectionI

Establishes a TCP connection to a device

package test.zebra.sdk.comm.examples;
 
 import com.zebra.sdk.comm.*;
 import com.zebra.sdk.common.card.containers.*;
 import com.zebra.sdk.common.card.exceptions.ZebraCardException;
 import com.zebra.sdk.common.card.printer.*;
 import com.zebra.sdk.settings.SettingsException;
 
 public class TcpConnectionExample {
 
 	public static void main(String[] args) throws Exception {
 		new TcpConnectionExample().getPrinterStatusOverTcp("1.2.3.4");
 		new TcpConnectionExample().getPrinterInfoUsingDnsName("PrinterName");
 	}
 
 	private void getPrinterStatusOverTcp(String theIpAddress) throws ConnectionException, SettingsException, ZebraCardException {
 		Connection connection = new TcpConnection(theIpAddress, 9100);
 		ZebraCardPrinter zebraCardPrinter = null;
 
 		try {
 			connection.open();
 			zebraCardPrinter = ZebraCardPrinterFactory.getInstance(connection);
 
 			PrinterStatusInfo printerStatusInfo = zebraCardPrinter.getPrinterStatus();
 			System.out.format("Status: %s%n", printerStatusInfo.status);
 			System.out.format("Alarm: %s (%s)%n", printerStatusInfo.alarmInfo.value, printerStatusInfo.alarmInfo.description);
 			System.out.format("Error: %s (%s)%n", printerStatusInfo.errorInfo.value, printerStatusInfo.errorInfo.description);
 			System.out.format("Total jobs: %s%n", printerStatusInfo.jobsTotal);
 			System.out.format("Pending jobs: %s%n", printerStatusInfo.jobsPending);
 			System.out.format("Active jobs: %s%n", printerStatusInfo.jobsActive);
 			System.out.format("Completed jobs: %s%n%n", printerStatusInfo.jobsComplete);
 		} catch (ConnectionException e) {
 			// Handle communications error here.
 			e.printStackTrace();
 		} finally {
 			// Release resources and close the connection
 			zebraCardPrinter.destroy();
 			connection.close();
 		}
 	}
 
 	private void getPrinterInfoUsingDnsName(String dnsName) throws ConnectionException, SettingsException, ZebraCardException {
 		Connection connection = new TcpConnection(dnsName, 9100);
 		ZebraCardPrinter zebraCardPrinter = null;
 
 		try {
 			connection.open();
 			zebraCardPrinter = ZebraCardPrinterFactory.getInstance(connection);
 
 			PrinterInfo printerInfo = zebraCardPrinter.getPrinterInformation();
 			System.out.format("Vendor: %s%n", printerInfo.vendor);
 			System.out.format("Model: %s%n", printerInfo.model);
 			System.out.format("SerialNumber: %s%n", printerInfo.serialNumber);
 			System.out.format("OEM Code: %s%n", printerInfo.oemCode);
 			System.out.format("Firmware Version: %s%n%n", printerInfo.firmwareVersion);
 		} catch (ConnectionException e) {
 			// Handle communications error here.
 			e.printStackTrace();
 		} finally {
 			// Release resources and close the connection
 			zebraCardPrinter.destroy();
 			connection.close();
 		}
 	}
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CPCL_TCP_PORT The default TCP port for CPCL devices.
static int	DEFAULT_ZPL_TCP_PORT The default TCP port for ZPL devices.
boolean	isCardPrinter For internal use of the Zebra Printer API only.
String	serialNumber For internal use of the Zebra Printer API only.

Constructor Summary

Constructors

Constructor and Description
TcpConnection(String address, int port) Initializes a new instance of the TcpConnection class.
TcpConnection(String address, int port, int maxTimeoutForRead, int timeToWaitForMoreData) Initializes a new instance of the TcpConnection class.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddress() Returns the address which was passed into the constructor.
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	getPortNumber() Returns the port number which was passed into the constructor.
String	getSimpleConnectionName() Return the IP address as the description.
String	toString() Returns TCP:[address]:[port number]. The address and port number are the parameters which were passed into the constructor.

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

addWriteLogStream, bytesAvailable, close, getManufacturer, getMaxDataToWrite, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, open, read, read, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxDataToWrite, setMaxTimeoutForRead, setReadTimeout, setTimeToWaitForMoreData, waitForData, write, 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

getManufacturer, getMaxDataToWrite, read, 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, write

Field Detail

DEFAULT_ZPL_TCP_PORT

public static final int DEFAULT_ZPL_TCP_PORT

The default TCP port for ZPL devices.

See Also:

Constant Field Values

DEFAULT_CPCL_TCP_PORT

public static final int DEFAULT_CPCL_TCP_PORT

The default TCP port for CPCL devices.

See Also:

Constant Field Values

isCardPrinter

public boolean isCardPrinter

For internal use of the Zebra Printer API only.

serialNumber

public String serialNumber

For internal use of the Zebra Printer API only.

Constructor Detail

TcpConnection

public TcpConnection(String address,
             int port)

Initializes a new instance of the TcpConnection 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:
TcpConnection(String, int, int, int).

Parameters:

address - the IP Address or DNS Hostname.

port - the port number.

TcpConnection

public TcpConnection(String address,
             int port,
             int maxTimeoutForRead,
             int timeToWaitForMoreData)

Initializes a new instance of the TcpConnection 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:

address - the IP Address or DNS Hostname.

port - the port number.

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

timeToWaitForMoreData - the maximum time, in milliseconds, to wait in-between reads after the initial read.

Method Detail

toString

public String toString()

Returns TCP:[address]:[port number].
The address and port number are the parameters which were passed into the constructor.

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 IP address as the description.

Specified by:

getSimpleConnectionName in interface Connection

Returns:

a human-readable description of the connection.

See Also:

Connection.getSimpleConnectionName()

getAddress

public String getAddress()

Description copied from interface: IpAddressable

Returns the address which was passed into the constructor.

Specified by:

getAddress in interface IpAddressable

Returns:

the address used to establish this connection. This can be either a DNS Hostname or an IP address.

See Also:

IpAddressable.getAddress()

getPortNumber

public String getPortNumber()

Description copied from interface: IpAddressable

Returns the port number which was passed into the constructor.

Specified by:

getPortNumber in interface IpAddressable

Returns:

the port number associated with the connection.

See Also:

IpAddressable.getPortNumber()

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)