Main Page | Class Hierarchy | Class List | File List | Class Members

SmartDeviceGUIClient::Message Class Reference

List of all members.

Public Member Functions

 Message (MessageType type, ushort destination, MessagePriority priority)
 Message (MessageType type, ushort destination)
abstract MemoryStream SerialiseData ()
abstract void DeserialiseData (Stream serialisedDataStream)

Static Public Member Functions

MemoryStream SerialiseMessage (Message msg)
Message DeserialiseMessage (Stream serialisedMessageStream)

Properties

MessageType Type
MessageType type
ushort Destination
ushort Source
MessagePriority Priority

Detailed Description

<summary> Summary description for Message. </summary>

Definition at line 9 of file SmartDeviceGUIClient/Message.cs.


Constructor & Destructor Documentation

SmartDeviceGUIClient::Message::Message MessageType  type,
ushort  destination,
MessagePriority  priority
[inline]
 

<summary> Creates a new message of specified type, with given destination and given priority </summary> <param name="type"></param>

Definition at line 15 of file SmartDeviceGUIClient/Message.cs.

SmartDeviceGUIClient::Message::Message MessageType  type,
ushort  destination
[inline]
 

<summary> Creates a new message of specified type and destination, with normal priority </summary> <param name="type"></param> <param name="destination"></param>

Definition at line 26 of file SmartDeviceGUIClient/Message.cs.


Member Function Documentation

abstract void SmartDeviceGUIClient::Message::DeserialiseData Stream  serialisedDataStream  )  [pure virtual]
 

<summary> Converts a serialised bytes into message </summary> <param name="serialisedMessage"></param>

abstract MemoryStream SmartDeviceGUIClient::Message::SerialiseData  )  [pure virtual]
 

<summary> Converts message into serialised bytes for transport </summary> <returns>Memory stream representing serialised data, at end of stream.</returns>


Property Documentation

ushort SmartDeviceGUIClient::Message::Destination [get, set]
 

<summary> Destination device ID of the message </summary>

Definition at line 40 of file SmartDeviceGUIClient/Message.cs.

MessagePriority SmartDeviceGUIClient::Message::Priority [get, set]
 

<summary> Priority of message to be sent. </summary>

Definition at line 58 of file SmartDeviceGUIClient/Message.cs.

ushort SmartDeviceGUIClient::Message::Source [get, set]
 

<summary> The device ID the message comes from </summary>

Definition at line 49 of file SmartDeviceGUIClient/Message.cs.

MessageType SmartDeviceGUIClient::Message::Type [get, set]
 

<summary> Property for getting and setting the type of the message (retrans, http, etc) </summary>

Definition at line 31 of file SmartDeviceGUIClient/Message.cs.


The documentation for this class was generated from the following file:
Generated on Mon May 8 22:07:29 2006 by  doxygen 1.3.9.1