Network Message Class. More...
#include <deNetworkMessage.h>
Public Member Functions | |
Constructors and Destructors | |
| deNetworkMessage () | |
| Creates a new network message object. | |
| virtual | ~deNetworkMessage () |
| Cleans up the network message object. | |
Management | |
| char * | GetBuffer () const |
| Retrieves the buffer data. | |
| int | GetDataLength () const |
| Retrieves the length of the message data. | |
| void | SetDataLength (int dataLength) |
| Sets the length of the message data. | |
| void | Clear () |
| Clears the message data. | |
| int | GetPosition () const |
| Retrieves the current position. | |
| void | SetPosition (int position) |
| Sets the position relative to the start of the stream. | |
| void | Rewind () |
| Rewinds the position to the start of the message. | |
| bool | EndOfMessage () const |
| Determines if the end of message has been reached. | |
Reading | |
| signed char | ReadChar () |
| Reads an 8-bit signed char. | |
| unsigned char | ReadUChar () |
| Reads an 8-bit unsigned char. | |
| signed short | ReadShort () |
| Reads a 16-bit signed short. | |
| unsigned short | ReadUShort () |
| Reads a 16-bit unsigned short. | |
| signed long | ReadLong () |
| Reads a 32-bit signed long. | |
| unsigned long | ReadULong () |
| Reads a 32-bit unsigned long. | |
| float | ReadFloat () |
| Reads a 32-bit float. | |
| float | ReadDouble () |
| Reads a 64-bit float. | |
| void | ReadData (void *data, int length) |
| Reads data of the given length. | |
Writing | |
| void | WriteChar (signed char value) |
| Writes an 8-bit signed char. | |
| void | WriteUChar (unsigned char value) |
| Writes an 8-bit unsigned char. | |
| void | WriteShort (signed short value) |
| Writes a 16-bit signed short. | |
| void | WriteUShort (unsigned short value) |
| Writes a 16-bit unsigned short. | |
| void | WriteLong (long value) |
| Writes a 32-bit signed long. | |
| void | WriteULong (unsigned long value) |
| Writes a 32-bit unsigned long. | |
| void | WriteFloat (float value) |
| Writes a 32-bit float. | |
| void | WriteDouble (double value) |
| Writes a 64-bit float. | |
| void | WriteData (const void *data, int length) |
| Writes data of the given length. | |
Detailed Description
Network Message Class.
Manages a network message of variable length. Supports reading and writing to the message providing basic data types. Reading and writing is done like with a file stream with a stream position which is the same for reading and writing as well as end of message functions. An exception is raised if an attempt is made to read past the end of the message. The buffer is increased in size if a write attempt is made past the end of the message. This way the buffer can be filled with data making the message grow to the required size to hold all data. To Read data of a given size the SetLength call can be used to resize the buffer to at last a given length before reading the data into the message.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deNetworkMessage::deNetworkMessage | ( | ) |
Creates a new network message object.
| virtual deNetworkMessage::~deNetworkMessage | ( | ) | [virtual] |
Cleans up the network message object.
Member Function Documentation
| void deNetworkMessage::Clear | ( | ) |
Clears the message data.
| bool deNetworkMessage::EndOfMessage | ( | ) | const [inline] |
Determines if the end of message has been reached.
| char* deNetworkMessage::GetBuffer | ( | ) | const [inline] |
Retrieves the buffer data.
| int deNetworkMessage::GetDataLength | ( | ) | const [inline] |
Retrieves the length of the message data.
| int deNetworkMessage::GetPosition | ( | ) | const [inline] |
Retrieves the current position.
| signed char deNetworkMessage::ReadChar | ( | ) |
Reads an 8-bit signed char.
| void deNetworkMessage::ReadData | ( | void * | data, |
| int | length | ||
| ) |
Reads data of the given length.
| float deNetworkMessage::ReadDouble | ( | ) |
Reads a 64-bit float.
| float deNetworkMessage::ReadFloat | ( | ) |
Reads a 32-bit float.
| signed long deNetworkMessage::ReadLong | ( | ) |
Reads a 32-bit signed long.
| signed short deNetworkMessage::ReadShort | ( | ) |
Reads a 16-bit signed short.
| unsigned char deNetworkMessage::ReadUChar | ( | ) |
Reads an 8-bit unsigned char.
| unsigned long deNetworkMessage::ReadULong | ( | ) |
Reads a 32-bit unsigned long.
| unsigned short deNetworkMessage::ReadUShort | ( | ) |
Reads a 16-bit unsigned short.
| void deNetworkMessage::Rewind | ( | ) |
Rewinds the position to the start of the message.
| void deNetworkMessage::SetDataLength | ( | int | dataLength ) |
Sets the length of the message data.
| void deNetworkMessage::SetPosition | ( | int | position ) |
Sets the position relative to the start of the stream.
| void deNetworkMessage::WriteChar | ( | signed char | value ) |
Writes an 8-bit signed char.
| void deNetworkMessage::WriteData | ( | const void * | data, |
| int | length | ||
| ) |
Writes data of the given length.
| void deNetworkMessage::WriteDouble | ( | double | value ) |
Writes a 64-bit float.
| void deNetworkMessage::WriteFloat | ( | float | value ) |
Writes a 32-bit float.
| void deNetworkMessage::WriteLong | ( | long | value ) |
Writes a 32-bit signed long.
| void deNetworkMessage::WriteShort | ( | signed short | value ) |
Writes a 16-bit signed short.
| void deNetworkMessage::WriteUChar | ( | unsigned char | value ) |
Writes an 8-bit unsigned char.
| void deNetworkMessage::WriteULong | ( | unsigned long | value ) |
Writes a 32-bit unsigned long.
| void deNetworkMessage::WriteUShort | ( | unsigned short | value ) |
Writes a 16-bit unsigned short.
The documentation for this class was generated from the following file:
