com.zebra.sdk.comm

Class TcpStatusConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.TcpConnection

com.zebra.sdk.comm.TcpStatusConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging, IpAddressable, StatusConnection, StatusConnectionWithWriteLogging

public class TcpStatusConnection
extends TcpConnection
implements StatusConnectionWithWriteLogging

Establishes a status only TCP connection to a device

package test.zebra.sdk.comm.examples;
 
 import com.zebra.sdk.comm.Connection;
 import com.zebra.sdk.comm.ConnectionException;
 import com.zebra.sdk.comm.TcpStatusConnection;
 import com.zebra.sdk.printer.SGD;
 
 public class TcpStatusConnectionExample {
 
     public static void main(String[] args) throws Exception {
         new TcpStatusConnectionExample().sendJSONOverStatusChannel("1.2.3.4");
     }
 
     private void sendJSONOverStatusChannel(String theIpAddress) throws ConnectionException {
         // Instantiate connection for ZPL TCP port at given address
         Connection thePrinterConn = new TcpStatusConnection(theIpAddress, TcpStatusConnection.DEFAULT_STATUS_TCP_PORT);
 
         try {
             // Open the connection - physical connection is established here.
             thePrinterConn.open();
 
             // This sends down JSON to the status channel to retrieve the 'appl.name' setting
             String firmwareVersion = SGD.GET("appl.name", thePrinterConn);
 
             System.out.println("The firmware version is : " + firmwareVersion);
         } catch (ConnectionException e) {
             // Handle communications error here.
             e.printStackTrace();
         } finally {
             // Close the connection to release resources.
             thePrinterConn.close();
         }
     }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STATUS_TCP_PORT The default Status TCP port for ZPL devices.

Fields inherited from class com.zebra.sdk.comm.TcpConnection

DEFAULT_CPCL_TCP_PORT, DEFAULT_ZPL_TCP_PORT

Constructor Summary

Constructors

Constructor and Description
TcpStatusConnection(String address) Initializes a new status only instance of the TcpStatusConnection class using the default status port of 9200.
TcpStatusConnection(String address, int port) Initializes a new status only instance of the TcpConnection class.
TcpStatusConnection(String address, int port, int maxTimeoutForRead, int timeToWaitForMoreData) Initializes a new status only instance of the TcpConnection class.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSimpleConnectionName() Return the IP address and the status port as the description.
String	toString() Returns TCP_STATUS:[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.TcpConnection

getAddress, getConnectionReestablisher, getPortNumber

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

addWriteLogStream, bytesAvailable, close, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, open, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxTimeoutForRead, 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.StatusConnectionWithWriteLogging

addWriteLogStream

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

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

Field Detail

DEFAULT_STATUS_TCP_PORT

public static final int DEFAULT_STATUS_TCP_PORT

The default Status TCP port for ZPL devices.

See Also:

Constant Field Values

Constructor Detail

TcpStatusConnection

public TcpStatusConnection(String address)

Initializes a new status only instance of the TcpStatusConnection class using the default status port of 9200. 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:
TcpStatusConnection(String, int, int, int).

Parameters:

address - the IP Address or DNS Hostname.

TcpStatusConnection

public TcpStatusConnection(String address,
                   int port)

Initializes a new status only 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:
TcpStatusConnection(String, int, int, int).

Parameters:

address - the IP Address or DNS Hostname.

port - the port number.

TcpStatusConnection

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

Initializes a new status only 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_STATUS:[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 TcpConnection

Returns:

the connection description string.

See Also:

Connection.toString()

getSimpleConnectionName

public String getSimpleConnectionName()

Return the IP address and the status port as the description.

Specified by:

getSimpleConnectionName in interface Connection

Overrides:

getSimpleConnectionName in class TcpConnection

Returns:

a human-readable description of the connection.

See Also:

Connection.getSimpleConnectionName()