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

Fas Manager for serial port data. More...

Inheritance diagram for CommandMessenger.TransportLayer.SerialTransport:
CommandMessenger.DisposableObject CommandMessenger.TransportLayer.ITransport

List of all members.

Public Member Functions

 SerialTransport ()
 Default constructor.
void Initialize ()
 Initializes this object.
bool StartListening ()
 Connects to a serial port defined through the current settings.
bool Open ()
 Opens the serial port.
bool PortExists ()
 Queries if a given port exists.
bool Close ()
 Closes the serial port.
bool IsOpen ()
 Query ifthe serial port is open.
bool StopListening ()
 Stops listening to the serial port.
void Write (byte[] buffer)
 Writes a parameter to the serial port.
bool UpdateBaudRateCollection ()
 Retrieves the possible baud rates for the currently selected serial port.
byte[] Read ()
 Reads the serial buffer into the string buffer.
int BytesInBuffer ()
 Gets the bytes in buffer.

Public Attributes

ThreadRunStates ThreadRunState = ThreadRunStates.Start

Protected Member Functions

void ProcessQueue ()
override void Dispose (bool disposing)
 Remove all references and remove children.

Properties

SerialSettings CurrentSerialSettings [get, set]
 Gets or sets the current serial port settings.
SerialPort SerialPort [get]
 Gets the serial port.

Events

EventHandler NewDataReceived

Detailed Description

Fas Manager for serial port data.


Constructor & Destructor Documentation

Default constructor.


Member Function Documentation

Gets the bytes in buffer.

Returns:
Bytes in buffer

Implements CommandMessenger.TransportLayer.ITransport.

Closes the serial port.

Returns:
true if it succeeds, false if it fails.
override void CommandMessenger.TransportLayer.SerialTransport.Dispose ( bool  disposing) [protected, virtual]

Remove all references and remove children.

Parameters:
disposingIf true, cleanup

Reimplemented from CommandMessenger.DisposableObject.

Initializes this object.

Query ifthe serial port is open.

Returns:
true if open, false if not.

Opens the serial port.

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

Queries if a given port exists.

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

Reads the serial buffer into the string buffer.

Implements CommandMessenger.TransportLayer.ITransport.

Connects to a serial port defined through the current settings.

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

Implements CommandMessenger.TransportLayer.ITransport.

Stops listening to the serial port.

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

Implements CommandMessenger.TransportLayer.ITransport.

Retrieves the possible baud rates for the currently selected serial port.

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

Writes a parameter to the serial port.

Parameters:
bufferThe buffer to write.

Implements CommandMessenger.TransportLayer.ITransport.


Property Documentation

Gets or sets the current serial port settings.

The current serial settings.

Gets the serial port.

The serial port.


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