Command messenger main class. More...

Public Member Functions
delegate void	MessengerCallbackFunction (ReceivedCommand receivedCommand)
	Definition of the messenger callback function.
	CmdMessenger (SerialPortManager communications)
	Constructor.
	CmdMessenger (SerialPortManager communications, char fieldSeparator)
	Constructor.
	CmdMessenger (SerialPortManager communications, char fieldSeparator, char commandSeparator)
	Constructor.
	CmdMessenger (SerialPortManager communications, char fieldSeparator, char commandSeparator, char escapeCharacter)
	Constructor.
void	SetControlToInvokeOn (Control controlToInvokeOn)
	Sets a control to invoke on.
bool	StopListening ()
	Stop listening and end serial port connection.
bool	StartListening ()
	Starts serial port connection and start listening.
void	Attach (MessengerCallbackFunction newFunction)
	Attaches default callback for unsupported commands.
void	Attach (int messageId, MessengerCallbackFunction newFunction)
	Attaches default callback for certain Message ID.
void	ProcessLines ()
	Process the command lines and invokes callbacks.
void	HandleMessage (ReceivedCommand receivedCommand)
	Handle message.
ReceivedCommand	SendCommand (int cmdId)
	Sends a command.
ReceivedCommand	SendCommand (int cmdId, string argument)
	Sends a command.
ReceivedCommand	SendCommand (SendCommand sendCommand)
	Sends a command.
ReceivedCommand	SendCommand (int cmdId, string argument, bool reqAc, int ackCmdId, int timeout)
	Sends a command.
ReceivedCommand	SendCommand (int cmdId, string[] arguments, bool reqAc, int ackCmdId, int timeout)
	Sends a command.
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public Attributes
EventHandler	NewLinesReceived
EventHandler	NewLineReceived
EventHandler	NewLineSent
Protected Member Functions
virtual void	Dispose (bool disposing)
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Properties
bool	PrintLfCr `[get, set]`
	Gets or sets a whether to print a line feed carriage return after each command.
String	CurrentReceivedLine `[get, set]`
	Gets or sets the current received command line.
ReceivedCommand	CurrentReceivedCommand `[get, set]`
	Gets or sets the current received command.
String	CurrentSentLine `[get, set]`
	Gets or sets the currently sent line.
ConcurrencyPriority	Priority `[get, set]`
long	LastLineTimeStamp `[get, set]`
	Gets or sets the time stamp of the last command line received.

Detailed Description

Command messenger main class.

Constructor & Destructor Documentation

CommandMessenger.CmdMessenger.CmdMessenger ( SerialPortManager communications )

Constructor.

Parameters:

communications The Serial port object.

CommandMessenger.CmdMessenger.CmdMessenger	(	SerialPortManager	communications,
		char	fieldSeparator
	)

Constructor.

Parameters:

communications	The Serial port object.
fieldSeparator	The field separator.

CommandMessenger.CmdMessenger.CmdMessenger	(	SerialPortManager	communications,
		char	fieldSeparator,
		char	commandSeparator
	)

Constructor.

Parameters:

communications	The Serial port object.
fieldSeparator	The field separator.
commandSeparator	The command separator.

CommandMessenger.CmdMessenger.CmdMessenger	(	SerialPortManager	communications,
		char	fieldSeparator,
		char	commandSeparator,
		char	escapeCharacter
	)

Constructor.

Parameters:

communications	The Serial port object.
fieldSeparator	The field separator.
commandSeparator	The command separator.
escapeCharacter	The escape character.

Member Function Documentation

void CommandMessenger.CmdMessenger.Attach ( MessengerCallbackFunction newFunction )

Attaches default callback for unsupported commands.

Parameters:

newFunction The callback function.

void CommandMessenger.CmdMessenger.Attach	(	int	messageId,
		MessengerCallbackFunction	newFunction
	)

Attaches default callback for certain Message ID.

Parameters:

messageId	Command ID.
newFunction	The callback function.

void CommandMessenger.CmdMessenger.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

virtual void CommandMessenger.CmdMessenger.Dispose ( bool disposing ) [protected, virtual]

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Parameters:

disposing true if resources should be disposed, false if not.

void CommandMessenger.CmdMessenger.HandleMessage ( ReceivedCommand receivedCommand )

Handle message.

Parameters:

receivedCommand The received command.

delegate void CommandMessenger.CmdMessenger.MessengerCallbackFunction ( ReceivedCommand receivedCommand )

Definition of the messenger callback function.

Parameters:

receivedCommand The received command.

void CommandMessenger.CmdMessenger.ProcessLines ( )

Process the command lines and invokes callbacks.

ReceivedCommand CommandMessenger.CmdMessenger.SendCommand ( int cmdId )

Sends a command.

Parameters:

cmdId Command ID.

Returns:: .

ReceivedCommand CommandMessenger.CmdMessenger.SendCommand	(	int	cmdId,
		string	argument
	)

Sends a command.

Parameters:

cmdId	Command ID.
argument	The command argument.

Returns:: .

ReceivedCommand CommandMessenger.CmdMessenger.SendCommand ( SendCommand sendCommand )

Sends a command.

Parameters:

sendCommand The command to sent.

Returns:: .

ReceivedCommand CommandMessenger.CmdMessenger.SendCommand	(	int	cmdId,
		string	argument,
		bool	reqAc,
		int	ackCmdId,
		int	timeout
	)

Sends a command.

Parameters:

cmdId	Command ID.
argument	The command argument.
reqAc	true to request acknowledge command.
ackCmdId	acknowledgement command ID
timeout	Timeout on acknowlegde command.

Returns:: .

ReceivedCommand CommandMessenger.CmdMessenger.SendCommand	(	int	cmdId,
		string[]	arguments,
		bool	reqAc,
		int	ackCmdId,
		int	timeout
	)

Sends a command.

Parameters:

cmdId	Command ID.
arguments	The arguments.
reqAc	true to request acknowledge command.
ackCmdId	acknowledgement command ID
timeout	Timeout on acknowlegde command.