UniPRT SDK v1.0.0.0-so (C++)
 
Loading...
Searching...
No Matches
CommSDK.cpp File Reference
#include "CommSDK.h"
#include "TcpComm.h"
Include dependency graph for CommSDK.cpp:

Enumerations

enum  COMM_IDX { TCP_COMM = 1 }
 

Functions

int BytesAvailable ()
 Get the bytes available.
 
bool Connected ()
 Is connected with the NET.
 
void Read (byte *buffer, int size)
 Read data through the NET from printer.
 
void Write (byte *dataOut, int iDataSize)
 Write data through the NET to printer.
 
byte * WriteAndWaitForResponse (byte *dataOut, int iDataSize, int responseStartTimeOut, int responseEndTimeOut, char *completetionToken)
 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.
 
void Close ()
 Disconnect the printer.
 
void Open ()
 Open the printer through the NET.
 
void SendPrintFile (char *ipAddress, char *fileName)
 Send file through the NET.
 
void SendPrintString (char *ipAddress, char *data, int iDataSize)
 Send the string through the NET.
 
void TcpConnect (char *ipAddress, int port)
 Connect to the selected NET device.
 
void GetComm (void *&ptrComm)
 Get the pointer of communicating I/F.
 

Variables

static TcpComm gTcpComm
 
static TcpConnection gTcpConnection
 
static int giComm = TCP_COMM
 

Enumeration Type Documentation

◆ COMM_IDX

enum COMM_IDX
Enumerator
TCP_COMM 

Function Documentation

◆ BytesAvailable()

int BytesAvailable ( )

Get the bytes available.

Returns
Greater than 0 : The size of data bytes available
Equal to 0 : None
Sample
int iBytes = BytesAvailable();
pBuf = new byte[iBytes];
Read(pBuf, iBytes);
void Read(byte *buffer, int size)
Read data through the NET from printer.
Definition CommSDK.cpp:224
int BytesAvailable()
Get the bytes available.
Definition CommSDK.cpp:95

◆ Close()

void Close ( )

Disconnect the printer.

Returns
void
Sample
void Close()
Disconnect the printer.
Definition CommSDK.cpp:419

◆ Connected()

bool Connected ( )

Is connected with the NET.

Returns
true or false
Sample
if (true == Connected())
bool Connected()
Is connected with the NET.
Definition CommSDK.cpp:139

◆ GetComm()

void GetComm ( void *& ptrComm)

Get the pointer of communicating I/F.

Parameters
[in]ptrComm: a pointer to storage communicating I/F
Returns
void
Sample
void* commPtr = NULL;
GetComm(commPtr);
void GetComm(void *&ptrComm)
Get the pointer of communicating I/F.
Definition CommSDK.cpp:712

◆ Open()

void Open ( )

Open the printer through the NET.

Returns
void
Sample
Open();
void Open()
Open the printer through the NET.
Definition CommSDK.cpp:463

◆ Read()

void Read ( byte * buffer,
int size )

Read data through the NET from printer.

Parameters
[in]buffer: the buffer for to storage data
[in]size: buffer size
Returns
void
Sample
int iBytes = BytesAvailable();
pBuf = new byte[iBytes];
Read(pBuf, iBytes);

◆ SendPrintFile()

void SendPrintFile ( char * ipAddress,
char * fileName )

Send file through the NET.

Parameters
[in]ipAddress: IP address
[in]fileName: file path
Returns
void
Sample
SendPrintFile((char*)"10.0.10.172", (char*)"rfid.pgl");
void SendPrintFile(char *ipAddress, char *fileName)
Send file through the NET.
Definition CommSDK.cpp:531

◆ SendPrintString()

void SendPrintString ( char * ipAddress,
char * data,
int iDataSize )

Send the string through the NET.

Parameters
[in]ipAddress: IP address
[in]data: the data to the printer
[in]iDataSize: the size of data
Returns
void
Sample
SendPrintString((char*)"10.0.10.172", (char*)"FEED 100", strlen("FEED 100"));
void SendPrintString(char *ipAddress, char *data, int iDataSize)
Send the string through the NET.
Definition CommSDK.cpp:575

◆ TcpConnect()

void TcpConnect ( char * ipAddress,
int port )

Connect to the selected NET device.

Parameters
[in]ipAddress: IP address
[in]port: port number:9100
Returns
void
Sample
TcpConnect("10.100.15.214", 9100);
void TcpConnect(char *ipAddress, int port)
Connect to the selected NET device.
Definition CommSDK.cpp:651

◆ Write()

void Write ( byte * dataOut,
int iDataSize )

Write data through the NET to printer.

Parameters
[in]dataOut: the data write to printer
[in]iDataSize: the size of data to write to printer
Returns
void
Sample
std::string content;
content += "FEED 100";
const char* pStr = content.c_str();
Write((byte*)pStr, strlen(pStr));
void Write(byte *dataOut, int iDataSize)
Write data through the NET to printer.
Definition CommSDK.cpp:280

◆ WriteAndWaitForResponse()

byte * WriteAndWaitForResponse ( byte * dataOut,
int iDataSize,
int responseStartTimeOut,
int responseEndTimeOut,
char * completetionToken )

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.

Parameters
[in]dataOut: the data write to printer
[in]iDataSize: the size of data to write to printer
[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]completetionTokenString 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.
Returns
byte* string received from connection. Data returned is any data received or up to completetionToken if token received
Sample
std::string content;
content += "FEED 100\r\n";
content += "OUT \"12345678\"\r\n";
std::cout << std::endl;
std::cout << "Send to Printer:" << std::endl;
std::cout << content;
const char* pStr = content.c_str();
byte* pResponse = WriteAndWaitForResponse((byte*)pStr, content.size(), 1000, 500, "\r\n");
byte * WriteAndWaitForResponse(byte *dataOut, int iDataSize, int responseStartTimeOut, int responseEndTimeOut, char *completetionToken)
Write byte data to output stream and return data received. Data returned is any data received or up t...
Definition CommSDK.cpp:360

Variable Documentation

◆ giComm

int giComm = TCP_COMM
static

◆ gTcpComm

TcpComm gTcpComm
static

◆ gTcpConnection

TcpConnection gTcpConnection
static