Auto ID SDK v1.00 (beta) 5/15/2022
AComm Class Referenceabstract

Abstract class that implements default functionality for IComm interface class. More...

Inheritance diagram for AComm:
IComm TcpConnection

Public Member Functions

abstract void Close ()
 Closes a connection. More...
 
abstract void Open ()
 Opens a connection. More...
 
abstract byte[] Read ()
 Read all bytes available. More...
 
virtual void Read (BinaryWriter binDataIn)
 Reads all bytes available into the stream passed in. More...
 
virtual void WaitForData (int msTimeOut)
 Waits until data available BytesAvailable in current thread. Current thread sleeps until data received or timeout reached. Blocking call.
More...
 
virtual void Write (BinaryReader binReader)
 Write from input stream to output stream
More...
 
abstract void Write (byte[] dataOut)
 Writes all bytes from the array passed in. More...
 
virtual void WriteAndWaitForResponse (BinaryWriter binDataIn, BinaryReader binDataOut, int responseStartTimeOut, int responseEndTimeOut, string completetionToken)
 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...
 
virtual byte[] WriteAndWaitForResponse (byte[] dataOut, int responseStartTimeOut, int responseEndTimeOut, string 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. More...
 

Properties

abstract int BytesAvailable [get]
 
abstract bool Connected [get]
 
abstract string Descriptor [get]
 
- Properties inherited from IComm
int BytesAvailable [get]
 Number of bytes available to read. This is estimate and number can change as data is received.
 
bool Connected [get]
 true if connection is established
 
string Descriptor [get]
 string descriptor of the connection.
 

Detailed Description

Abstract class that implements default functionality for IComm interface class.

Member Function Documentation

◆ Close()

abstract void Close ( )
pure virtual

Closes a connection.

Implements IComm.

Implemented in TcpConnection.

◆ Open()

abstract void Open ( )
pure virtual

Opens a connection.

Implements IComm.

Implemented in TcpConnection.

◆ Read() [1/2]

abstract byte[] Read ( )
pure virtual

Read all bytes available.

Implements IComm.

Implemented in TcpConnection.

◆ Read() [2/2]

virtual void Read ( BinaryWriter  binDataIn)
inlinevirtual

Reads all bytes available into the stream passed in.

Implements IComm.

◆ WaitForData()

virtual void WaitForData ( int  msTimeOut)
inlinevirtual

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

Parameters
[in]msTimeOutMillisecond timeout before return if no data received.

Implements IComm.

◆ Write() [1/2]

virtual void Write ( BinaryReader  binReader)
inlinevirtual

Write from input stream to output stream

Parameters
[in]binReaderSource data to send

Implements IComm.

◆ Write() [2/2]

abstract void Write ( byte[]  dataOut)
pure virtual

Writes all bytes from the array passed in.

Implements IComm.

Implemented in TcpConnection.

◆ WriteAndWaitForResponse() [1/2]

virtual void WriteAndWaitForResponse ( BinaryWriter  binDataIn,
BinaryReader  binDataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
string  completetionToken 
)
inlinevirtual

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]binDataInDestination stream to store response received from connection.
[in]binDataOut
Source stream data to write to connection.
[in]responseStartTimeOutTimeout to wait for first data to be received. Time to first byte.
[in]responseEndTimeOutTimeout 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 writng data to connection.

Implements IComm.

◆ WriteAndWaitForResponse() [2/2]

virtual byte[] WriteAndWaitForResponse ( byte[]  dataOut,
int  responseStartTimeOut,
int  responseEndTimeOut,
string  completetionToken 
)
inlinevirtual

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]responseStartTimeOutTimeout to wait for first data to be received. Time to first byte.
[in]responseEndTimeOutTimeout 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 writng data to connection.

Implements IComm.