SerialRecord Struct Reference

#include <serialrecord.h>

Public Member Functions
void	AssignUartNumber (void)
void	ProcessTCPReadSerialData (void)
void	ProcessSpecialFrameTCPReadSerialData (void)
void	ProcessSpecialFrameWriteNetworkData (void)
void	ProcessSpecialFrameWriteTimeout (void)
void	MakeTcpConnection (void)
void	CloseListenPort (void)
void	MakeUdpConnection (void)
bool	OkToListen (void)
void	ProcessTimeouts (void)
void	ProcessAccept (void)
void	OpenSerialPort (void)
void	ProcessReadNetworkData (void)
void	OpenListenPort (void)
void	ProcessWriteNetworkData (void)
void	ProcessWriteSerialData (void)
void	ProcessSerialError (void)
void	ProcessListenError (void)
void	ProcessNetworkError (void)
void	GetCurrentChannelStatus (char *buffer)

Detailed Description

Class Definition (struct is class with all members public)

Member Function Documentation

AssignUartNumber()

void SerialRecord::AssignUartNumber

(

void

)

Methods

Assign physical UART number to PortRecord array index member

CloseListenPort()

void SerialRecord::CloseListenPort

(

void

)

Close the listening port

GetCurrentChannelStatus()

void SerialRecord::GetCurrentChannelStatus

(

char *

buffer

)

" Connected to IP xx.xx.xx.xx " Listening on port xx " UDP mode with learned send-to IP Address : xx.xx.xx.xx " UDP mode send to Address : xx.xx.xx.xx " Idle

MakeTcpConnection()

void SerialRecord::MakeTcpConnection

(

void

)

Initiate a TCP connection

MakeUdpConnection()

void SerialRecord::MakeUdpConnection

(

void

)

Initiate a UDP connection

OkToListen()

bool SerialRecord::OkToListen

(

void

)

Check if conditions are right to establish a listening port

OpenListenPort()

void SerialRecord::OpenListenPort

(

void

)

Open the listening port

OpenSerialPort()

void SerialRecord::OpenSerialPort

(

void

)

Open a serial port

ProcessAccept()

void SerialRecord::ProcessAccept

(

void

)

Called when connections are waiting to be accepted

ProcessListenError()

void SerialRecord::ProcessListenError

(

void

)

Process listening errors

ProcessNetworkError()

void SerialRecord::ProcessNetworkError

(

void

)

Process network errors

ProcessReadNetworkData()

void SerialRecord::ProcessReadNetworkData

(

void

)

Called when data is received on the network port side

ProcessSerialError()

void SerialRecord::ProcessSerialError

(

void

)

Process serial errors

ProcessSpecialFrameTCPReadSerialData()

void SerialRecord::ProcessSpecialFrameTCPReadSerialData

(

void

)

Called to initiate an outgoing TCP connection when data is received on the serial data port side (this version for TCP packet customization logic)

ProcessSpecialFrameWriteNetworkData()

void SerialRecord::ProcessSpecialFrameWriteNetworkData

(

void

)

Called when write space has just opened up on network port (this version for TCP packet customization logic)

ProcessSpecialFrameWriteTimeout()

void SerialRecord::ProcessSpecialFrameWriteTimeout

(

void

)

Time-out function used with TCP packet customization logic - waits for a given time to accumulate serial characters before flushing them out the network side

ProcessTCPReadSerialData()

void SerialRecord::ProcessTCPReadSerialData

(

void

)

Called to initiate an outgoing TCP connection when data is received on the serial data port side

ProcessTimeouts()

void SerialRecord::ProcessTimeouts

(

void

)

Test all of the communication time-outs

Periodically check for live connection at a user-specified interval by sending an empty packet to the target device.

Wait at least two seconds for ACK to return after sending keep-alive packet. Target is lost if ACK was not the last packet received.

ProcessWriteNetworkData()

void SerialRecord::ProcessWriteNetworkData

(

void

)

Called when write space has just opened up on network port

ProcessWriteSerialData()

void SerialRecord::ProcessWriteSerialData

(

void

)

Called when write space has just opened up serial port

---

The documentation for this struct was generated from the following files:

• serialrecord.h
• serialrecord.cpp