ComConnection Class Reference

Class that implements serial communication and extends the AComm class. More...

Inheritance diagram for ComConnection:

Public Member Functions
	ComConnection (String portName, int baudRate, int parity, int dataBits, int stopBits, int handshake)
int	BytesAvailable ()
	Number of bytes available to read. This is estimate and number can change as data is received.
void	Close ()
	Closes a connection.
boolean	Connected ()
	true if connection is established
String	Descriptor ()
	string descriptor of the connection.
void	Open ()
	Opens a connection.
byte[]	Read ()
	Read all bytes available.
void	Read (OutputStream binDataIn) throws IOException
	Reads all bytes available into the stream passed in.
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 (byte[] dataOut)
	Writes all bytes from the array passed in.
void	Write (InputStream binReader) throws IOException
	Write from input stream to output stream 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...
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...

Detailed Description

Class that implements serial communication and extends the AComm class.

Examples

package com.test.UniPRTSdk;
 
import com.UniPRT.Sdk.Comm.TcpConnection;
import java.io.*;
 
public class commTcpSnippet {
    public static void main(String[] args) {
        String prtIp = "127.0.0.1";
        sendPrintFile(prtIp);     // send file over default printer data port
        sendPrintString(prtIp);   // send print data over default printer data port
    }
 
    public static void sendPrintFile(String ipAddress) {
        String fileName = "C:\\testFiles\\Hello.pgl";
        int defaultDataPort = TcpConnection.DEFAULT_DATA_PORT;
 
        ComConnection comm = new ComConnection("COM8", 115200, 0, 8, 1, 1);
 
        try {
            comm.Open();
            if (new File(fileName).exists()) {
                try (InputStream binReader = new BufferedInputStream(new FileInputStream(fileName))) {
                    System.out.println("Sending \"" + fileName + "\" to printer");
 
                    byte[] buffer = new byte[1024];
                    while ((binReader.read(buffer)) != -1) {
                        comm.Write(buffer);
                    }
                }
            } else {
                System.out.println("File \"" + fileName + "\" not found");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            comm.Close();
        }
    }
 
    public static void sendPrintString(String ipAddress) {
        String dataToPrint =
                "~CREATE;C39;72\n" +
                        "SCALE;DOT\n" +
                        "PAGE;30;40\n" +
                        "ALPHA\n" +
                        "C10;1;33;0;0;@HELLO@\n" +
                        "C16;54;37;0;0;@*World*@\n" +
                        "STOP\n" +
                        "BARCODE\n" +
                        "C128C;XRD3:3:6:6:9:9:12:12;H6;10;32\n" +
                        "@World@\n" +
                        "STOP\n" +
                        "END\n" +
                        "~EXECUTE;C39\n" +
                        "~NORMAL\n";
 
        int defaultDataPort = TcpConnection.DEFAULT_DATA_PORT;
 
        ComConnection comm = new ComConnection("COM8", 115200, 0, 8, 1, 1);
 
        try {
            comm.Open();
            if (comm.Connected()) {
                byte[] outBytes = dataToPrint.getBytes("US-ASCII");
                comm.Write(outBytes);
            } else {
                System.out.println("Not connected to printer");
            }
        } catch (Exception e) {
            System.out.println("Exception Msg: " + e.getMessage());
        } finally {
            comm.Close();
        }
    }
}

Member Function Documentation

WaitForData()

void WaitForData ( int  msTimeOut )

inherited

Waits until data available BytesAvailable in current thread. Current thread sleeps until data received or timeout reached. Blocking call.

Parameters

[in]

msTimeOut

Millisecond timeout before return if no data received.

Implements IComm.

Write()

void Write ( InputStream  binReader ) throws IOException

inherited

Write from input stream to output stream

Parameters

[in]

binReader

Source data to send

Implements IComm.

WriteAndWaitForResponse() [1/2]

byte [] WriteAndWaitForResponse ( byte[]  dataOut, int  responseStartTimeOut, int  responseEndTimeOut, String  completionToken  ) throws IOException

inherited

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.

Return values

byte[]

Array of bytes received from connection. Data returned is any data received or up to completetionToken if token received

Parameters

[in]	dataOut	Source byte array to write to connection.
[in]	responseStartTimeOut	Timeout to wait for first data to be received. Time to first byte.
[in]	responseEndTimeOut	Timeout of no new data received. Time after last byte.
[in]	completetionToken	String token denoting the end of the response expected. This can be empty string if simply want to wait for response after writing data to connection.

Implements IComm.

WriteAndWaitForResponse() [2/2]

void WriteAndWaitForResponse ( OutputStream  binDataIn, InputStream  binDataOut, int  responseStartTimeOut, int  responseEndTimeOut, String  completionToken  ) throws IOException

inherited

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.

Parameters

[out]	binDataIn	Destination stream to store response received from connection.
[in]	binDataOut	Source stream data to write to connection.
[in]	responseStartTimeOut	Timeout to wait for first data to be received. Time to first byte.
[in]	responseEndTimeOut	Timeout of no new data received. Time after last byte.
[in]	completetionToken	String token denoting the end of the response expected. This can be empty string if simply want to wait for response after writing data to connection.

Implements IComm.