CmdMessenger
4.0.0
CmdMessenger is a serial port messaging library for the .Net / Mono Platform.
|
Manager for data over transport layer. More...
Public Member Functions | |
CommunicationManager (ITransport transport, ReceiveCommandQueue receiveCommandQueue, BoardType boardType, char commandSeparator, char fieldSeparator, char escapeCharacter) | |
Constructor. | |
void | Dispose () |
bool | Connect () |
Connects to a transport layer defined through the current settings. | |
bool | Disconnect () |
Stops listening to the transport layer. | |
void | WriteLine (string value) |
Writes a string to the transport layer. | |
void | WriteLine< T > (T value) |
Writes a parameter to the transport layer followed by a NewLine. | |
void | Write< T > (T value) |
Writes a parameter to the transport layer. | |
void | Write (string value) |
Writes a string to the transport layer. | |
ReceivedCommand | ExecuteSendCommand (SendCommand sendCommand, SendQueue sendQueueState) |
Directly executes the send command operation. | |
ReceivedCommand | ExecuteSendString (String commandString, SendQueue sendQueueState) |
Directly executes the send string operation. | |
Protected Member Functions | |
virtual void | Dispose (bool disposing) |
Properties | |
char | FieldSeparator [get, set] |
The field separator. | |
char | CommandSeparator [get, set] |
The command separator. | |
char | EscapeCharacter [get, set] |
The escape character. | |
bool | PrintLfCr [get, set] |
Gets or sets a whether to print a line feed carriage return after each command. | |
BoardType | BoardType [get, set] |
long | LastLineTimeStamp [get, set] |
Gets or sets the time stamp of the last received line. |
Manager for data over transport layer.
CommandMessenger.CommunicationManager.CommunicationManager | ( | ITransport | transport, |
ReceiveCommandQueue | receiveCommandQueue, | ||
BoardType | boardType, | ||
char | commandSeparator, | ||
char | fieldSeparator, | ||
char | escapeCharacter | ||
) |
Constructor.
receiveCommandQueue | |
boardType | The Board Type. |
commandSeparator | The End-Of-Line separator. |
fieldSeparator | |
escapeCharacter | The escape character. |
transport | The Transport Layer |
Connects to a transport layer defined through the current settings.
Stops listening to the transport layer.
ReceivedCommand CommandMessenger.CommunicationManager.ExecuteSendCommand | ( | SendCommand | sendCommand, |
SendQueue | sendQueueState | ||
) |
Directly executes the send command operation.
sendCommand | The command to sent. |
sendQueueState | Property to optionally clear the send and receive queues. |
ReceivedCommand CommandMessenger.CommunicationManager.ExecuteSendString | ( | String | commandString, |
SendQueue | sendQueueState | ||
) |
Directly executes the send string operation.
commandString | The string to sent. |
sendQueueState | Property to optionally clear the send and receive queues. |
void CommandMessenger.CommunicationManager.Write | ( | string | value | ) |
Writes a string to the transport layer.
value | The string to write. |
void CommandMessenger.CommunicationManager.Write< T > | ( | T | value | ) |
Writes a parameter to the transport layer.
T | Generic type parameter. |
value | The value. |
void CommandMessenger.CommunicationManager.WriteLine | ( | string | value | ) |
Writes a string to the transport layer.
value | The string to write. |
void CommandMessenger.CommunicationManager.WriteLine< T > | ( | T | value | ) |
Writes a parameter to the transport layer followed by a NewLine.
T | Generic type parameter. |
value | The value. |
char CommandMessenger.CommunicationManager.CommandSeparator [get, set] |
The command separator.
char CommandMessenger.CommunicationManager.EscapeCharacter [get, set] |
The escape character.
char CommandMessenger.CommunicationManager.FieldSeparator [get, set] |
The field separator.
long CommandMessenger.CommunicationManager.LastLineTimeStamp [get, set] |
Gets or sets the time stamp of the last received line.
time stamp of the last received line.
bool CommandMessenger.CommunicationManager.PrintLfCr [get, set] |
Gets or sets a whether to print a line feed carriage return after each command.
true if print line feed carriage return, false if not.