CmdMessenger  3.0
CmdMessenger is a serial port messaging library for the .Net / Mono Platform.
Public Member Functions | Public Attributes | Protected Member Functions | Properties
CommandMessenger.CommunicationManager Class Reference

Fas Manager for serial port data. More...

Inheritance diagram for CommandMessenger.CommunicationManager:
CommandMessenger.DisposableObject

List of all members.

Public Member Functions

 CommunicationManager (DisposeStack disposeStack, ITransport transport, ReceiveCommandQueue receiveCommandQueue)
 Default constructor.
 CommunicationManager (DisposeStack disposeStack, ITransport transport, ReceiveCommandQueue receiveCommandQueue, char commandSeparator, char fieldSeparator, char escapeCharacter)
 Constructor.
void Initialize (DisposeStack disposeStack, ITransport transport, ReceiveCommandQueue receiveCommandQueue, char commandSeparator, char fieldSeparator, char escapeCharacter)
 Initializes this object.
bool StartListening ()
 Connects to a serial port defined through the current settings.
bool StopListening ()
 Stops listening to the serial port.
void WriteLine (string value)
 Writes a string to the serial port.
void WriteLine< T > (T value)
 Writes a parameter to the serial port followed by a NewLine.
void Write< T > (T value)
 Writes a parameter to the serial port.
void ProcessLine (string line)
 Converts lines on .

Public Attributes

readonly Encoding StringEncoder = Encoding.GetEncoding("ISO-8859-1")

Protected Member Functions

override void Dispose (bool disposing)
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Properties

long LastLineTimeStamp [get, set]
 Gets or sets the time stamp of the last received line.

Detailed Description

Fas Manager for serial port data.


Constructor & Destructor Documentation

Default constructor.

/

Parameters:
disposeStackThe DisposeStack
transportThe Transport Layer
receiveCommandQueue
CommandMessenger.CommunicationManager.CommunicationManager ( DisposeStack  disposeStack,
ITransport  transport,
ReceiveCommandQueue  receiveCommandQueue,
char  commandSeparator,
char  fieldSeparator,
char  escapeCharacter 
)

Constructor.

Parameters:
receiveCommandQueue
commandSeparatorThe End-Of-Line separator.
fieldSeparator
escapeCharacterThe escape character.
disposeStackThe DisposeStack
transportThe Transport Layer

Member Function Documentation

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

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

Parameters:
disposingtrue if resources should be disposed, false if not.

Reimplemented from CommandMessenger.DisposableObject.

void CommandMessenger.CommunicationManager.Initialize ( DisposeStack  disposeStack,
ITransport  transport,
ReceiveCommandQueue  receiveCommandQueue,
char  commandSeparator,
char  fieldSeparator,
char  escapeCharacter 
)

Initializes this object.

Parameters:
receiveCommandQueue
commandSeparatorThe End-Of-Line separator.
fieldSeparator
escapeCharacterThe escape character.
disposeStackThe DisposeStack

/

Parameters:
transportThe Transport Layer

Converts lines on .

Connects to a serial port defined through the current settings.

Returns:
true if it succeeds, false if it fails.

Stops listening to the serial port.

Returns:
true if it succeeds, false if it fails.
void CommandMessenger.CommunicationManager.Write< T > ( value)

Writes a parameter to the serial port.

Template Parameters:
TGeneric type parameter.
Parameters:
valueThe value.

Writes a string to the serial port.

Parameters:
valueThe string to write.

Writes a parameter to the serial port followed by a NewLine.

Template Parameters:
TGeneric type parameter.
Parameters:
valueThe value.

Property Documentation

Gets or sets the time stamp of the last received line.

time stamp of the last received line.


The documentation for this class was generated from the following file: