Class that implements the TCP specific communication and extends the AComm class. More...
Classes | |
enum | DescriptorPortType |
Types for requesting descriptors with default port values. More... | |
Public Member Functions | |
int | GetPort () |
TcpConnection (String descriptor) | |
Initialize new class instance based on descriptor string. More... | |
TcpConnection (String ipAddress, int port) | |
String | IpAddress () |
IP address of connection. More... | |
int | Port () |
Port Number of connection. More... | |
int | BytesAvailable () |
boolean | Connected () |
String | Descriptor () |
Returns a string description of the connection. Format: "<b>TCP</b>:ip:port" e.g. "<b>TCP</b>:127.0.0.1:9100". More... | |
void | Close () |
void | Open () |
byte[] | Read () |
void | Write (byte[] dataOut) |
![]() | |
void | Read (OutputStream binDataIn) throws IOException |
void | WaitForData (int msTimeOut) |
Waits until data available BytesAvailable in current thread. Current thread sleeps until data received or timeout reached. Blocking call. More... | |
void | Write (InputStream binReader) throws IOException |
Write from input stream to output stream. More... | |
void | WriteAndWaitForResponse (OutputStream binDataIn, InputStream binDataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException |
Write binDataOut stream data to output stream and return data received in binDataIn stream. Data returned is any data received or up to completion token if received. Wait for response timeout before returning. More... | |
byte[] | WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, String completetionToken) throws IOException |
Write byte data to output stream and return data received. Data returned is any data received or up to completion token if received. Wait for response timeout before returning. More... | |
Static Public Member Functions | |
static String | DescriptorValidate (String descriptorHint, DescriptorPortType portTypeHint) |
Validate/build descriptor string from descriptorHint that may or may not have a port. Returns valid descriptor or empty "" string. More... | |
Static Public Attributes | |
static final int | DEFAULT_DATA_PORT = 9100 |
Port for sending print data. More... | |
static final int | DEFAULT_STATUS_PORT = 3002 |
Port for listening to status messages from printer. More... | |
static final int | DEFAULT_MGMT_PORT = 3007 |
Port used to control and manage printers. More... | |
Private Member Functions | |
void | ConnectionSettings (String ipAddress, int port) |
Private Attributes | |
String | _ipAddress = "" |
int | _port = 0 |
Socket | _client |
InputStream | _inStream |
OutputStream | _outStream |
Class that implements the TCP specific communication and extends the AComm class.
com.UniPRT.Sdk.Comm.TcpConnection.TcpConnection | ( | String | descriptor | ) |
Initialize new class instance based on descriptor string.
[in] | descriptor | Colon (:) separated string description of connection. Acceptable Formats:
|
References com.UniPRT.Sdk.Comm.TcpConnection.DescriptorPortType.DATA, and com.UniPRT.Sdk.Comm.TcpConnection.DescriptorValidate().
com.UniPRT.Sdk.Comm.TcpConnection.TcpConnection | ( | String | ipAddress, |
int | port | ||
) |
int com.UniPRT.Sdk.Comm.TcpConnection.BytesAvailable | ( | ) |
Get the number of bytes available to read.
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._inStream.
void com.UniPRT.Sdk.Comm.TcpConnection.Close | ( | ) |
Close the connection.
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._client.
boolean com.UniPRT.Sdk.Comm.TcpConnection.Connected | ( | ) |
Check if connection is established.
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._client.
|
private |
String com.UniPRT.Sdk.Comm.TcpConnection.Descriptor | ( | ) |
Returns a string description of the connection. Format: "<b>TCP</b>:ip:port" e.g. "<b>TCP</b>:127.0.0.1:9100".
Format returned:
Note that "<b>TCP</b>" prefix on returned string to denote the type of connection.
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._ipAddress, and com.UniPRT.Sdk.Comm.TcpConnection._port.
|
static |
Validate/build descriptor string from descriptorHint that may or may not have a port. Returns valid descriptor or empty "" string.
descriptorHint accepted values:
References com.UniPRT.Sdk.Comm.TcpConnection.DescriptorPortType.DATA, com.UniPRT.Sdk.Comm.TcpConnection.DEFAULT_DATA_PORT, com.UniPRT.Sdk.Comm.TcpConnection.DEFAULT_MGMT_PORT, com.UniPRT.Sdk.Comm.TcpConnection.DEFAULT_STATUS_PORT, com.UniPRT.Sdk.Comm.TcpConnection.DescriptorPortType.MGMT, and com.UniPRT.Sdk.Comm.TcpConnection.DescriptorPortType.STATUS.
Referenced by com.UniPRT.Sdk.Comm.Communication.CreateComm(), and com.UniPRT.Sdk.Comm.TcpConnection.TcpConnection().
int com.UniPRT.Sdk.Comm.TcpConnection.GetPort | ( | ) |
References com.UniPRT.Sdk.Comm.TcpConnection._port.
String com.UniPRT.Sdk.Comm.TcpConnection.IpAddress | ( | ) |
IP address of connection.
References com.UniPRT.Sdk.Comm.TcpConnection._ipAddress.
void com.UniPRT.Sdk.Comm.TcpConnection.Open | ( | ) |
int com.UniPRT.Sdk.Comm.TcpConnection.Port | ( | ) |
Port Number of connection.
References com.UniPRT.Sdk.Comm.TcpConnection._port.
byte [] com.UniPRT.Sdk.Comm.TcpConnection.Read | ( | ) |
Read all available bytes.
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._inStream.
void com.UniPRT.Sdk.Comm.TcpConnection.Write | ( | byte[] | dataOut | ) |
Write all bytes from the array passed in.
dataOut | Byte array to write. |
Implements com.UniPRT.Sdk.Comm.IComm.
References com.UniPRT.Sdk.Comm.TcpConnection._outStream.
|
private |
|
private |
|
private |
|
private |
Referenced by com.UniPRT.Sdk.Comm.TcpConnection.Open(), and com.UniPRT.Sdk.Comm.TcpConnection.Write().
|
private |
|
static |
Port for sending print data.
Referenced by com.UniPRT.Sdk.Comm.TcpConnection.DescriptorValidate(), com.UniPRT.Sdk.Utilities.Utilities.SendPrintFile(), and com.UniPRT.Sdk.Utilities.Utilities.SendPrintString().
|
static |
Port used to control and manage printers.
Referenced by com.UniPRT.Sdk.Comm.TcpConnection.DescriptorValidate().
|
static |
Port for listening to status messages from printer.
Printer may be configured to send status messages to different ports based on the "Ret. Status Port" setting on the printer. If the "Ret. Status Port" is set to "E-NET Stat Port", the printer may send status messages to the "Status Port Number" setting which has a default of 3002.
e.g. Emulation (printer language such as PGL) diagnostic messages from printer.
e.g. Capturing ODV barcode data and grade with the following printer menu settings:
Referenced by com.UniPRT.Sdk.Comm.TcpConnection.DescriptorValidate().