In file /home/eternity/Source/Common/GMessage/H/gMessage.h:

class GMessage : public Debugable

Generic message wrapper

Inheritance:

GMessage < Debugable


Public Methods

Size GMessage::CheckSum (char *input, Size len)
Kratky_komentar_s_teckou_na_konci
Void GMessage::Clear ()
Clears all MsgFields
Err GMessage::DebugHeaders (LogFile *aLogFile, Char *aLogLabel, LogLevel aLogLevel)
Debugging method
Err GMessage::Delete (Char *aFieldName)
Deletes a MsgField
GMessage::GMessage (LogFile *aLogFile)
Constructor for GMessage
GMessage::GMessage (const GMessage *aGMessage, LogFile *aLogFile)
Constructor for GMessage
GMessage::GMessage (Char *aFileName, LogFile *aLogFile)
Constructor - loading structure from a file
GMessage::GMessage (Void *aBuffer, Size aSize, LogFile *aLogFile)
Constructor - loading structure from a byte stream
Err GMessage::GetAsBasicTime (Char *aFieldName, BasicTime *t) const
Returns the contents of a MsgField as an BasicTime
Void* GMessage::GetAsBytes (Char *aFieldName, Size *aSize) const
Returns the contents of a MsgField as a byte stream
Err GMessage::GetAsFile (Char *aFieldName, Char *aFileName) const
Returns the contents of a MsgField as a file
GMessage* GMessage::GetAsGMessage (Char *aFieldName) const
Returns the contents of a MsgField as an GMessage
Err GMessage::GetAsID (Char *aFieldName, ID *t) const
Returns the contents of a MsgField as an int
Err GMessage::GetAsInt (Char *aFieldName, Int *i) const
Returns the contents of a MsgField as an int
MsgField* GMessage::GetAsMsgField (Char *aFieldName) const
Returns the contents of a MsgField as a MsgField
Err GMessage::GetAsSize (Char *aFieldName, Size *i) const
Returns the contents of a MsgField as an Size
Char* GMessage::GetAsString (Char *aFieldName) const
Returns the contents of a MsgField as a NULL terminated string
Void GMessage::Initialize ()
Initialization of attributes called from constructors
Err GMessage::LoadFromBytes (Void *aBuffer, Size aLength)
Loads the fields from a byte stream
Err GMessage::LoadFromFile (Char *aFileName)
Loads the fields from file
Char* GMessage::ReadBytesHeader (Void *aBuffer, Size aLength, Size *aSize, Size *anOffset)
Reads the field name + delimitor + size from the byte stream
Char* GMessage::ReadFileHeader (File *aFile, Size *aSize)
Reads the field name + delimitor + size from the file
Err GMessage::Rename (Char *aFieldName, Char *newFieldName)
Changes the name of a MsgField
Err GMessage::SetAsBasicTime (Char *aFieldName, BasicTime aVariable)
Sets the contents of a MsgField by copying it from bastime variable
Err GMessage::SetAsBytes (Char *aFieldName, Void *aBuffer, Size aSize)
Set the contents of a MsgField by copying it from a byte stream
Err GMessage::SetAsFile (Char *aFieldName, Char *aFileName)
Set the contents of a MsgField by copying it from a file
Err GMessage::SetAsGMessage (Char *aFieldName, GMessage *aGMessage)
Set the contents of a MsgField by copying it from an GMessage
Err GMessage::SetAsID (Char *aFieldName, ID aVariable)
Sets the contents of a MsgField by copying it from int variable
Err GMessage::SetAsInt (Char *aFieldName, Int aVariable)
Sets the contents of a MsgField by copying it from int variable
Err GMessage::SetAsMsgField (Char *aFieldName, MsgField *aField)
Set the contents of a MsgField by copying it from another MsgField
Err GMessage::SetAsSize (Char *aFieldName, Size aVariable)
Kratky_komentar_s_teckou_na_konci
Err GMessage::SetAsString (Char *aFieldName, Char *aString)
Set the contents of a MsgField by copying it from a NULL terminated str
Size GMessage::SizeOf () const
Returns the size of the eso message in bytes
Void* GMessage::StoreToBytes (Size *aSize) const
Stores information held by MsgFields into a byte stream
Err GMessage::StoreToFile (Char *aFileName) const
Stores information held by MsgFields into a file
MsgField* GMessage::StoreToMsgField (Char *aFieldName) const
Stores information held by MsgFields into a newly created MsgField
Size GMessage::Sum (char *input, Size len)
Kratky_komentar_s_teckou_na_konci
Err GMessage::WriteBytesHeader (Void *aBuffer, MsgField *aMsgField, Size *anOffset) const
Writes the field name + delimitor + size into the byte stream
Err GMessage::WriteFileHeader (File *aFile, MsgField *aMsgField) const
Writes the field name + delimitor + size into the file
GMessage::~GMessage ()
Denstructor for GMessage

Public

methods
GMessage (LogFile *aLogFile = NULL)
constructor
GMessage (const GMessage *, LogFile *aLogFile = NULL)
constructor
GMessage (Char *aFileName, LogFile *aLogFile = NULL)
constructor
GMessage (Void *aBuffer, Size aSize, LogFile *aLogFile = NULL)
constructor
~GMessage ()
destructor
Size SizeOf () const
Total size

debugging

loading the stored information into the MsgFields

storing the message

getting and setting the information contained in the fields

manipulating gMessage

Protected

attributes
FieldQueue* fields
MsgFields
methods

Inherited from Debugable:

Public Methods

string* Debugable::CreateString(char *firstStr, int firstInt, int secondInt)
Debugable::Debugable(LogFile * debugLogFile)
int Debugable::SetDebugOptions(int newLogOptions)
void Debugable::SetLogFile(LogFile *aLogFile)
void Debugable::WriteString(LogLevel debugLevel, char * format, ...)
Debugable::~Debugable()

Documentation

Generic message wrapper. enables reading and writing of named fields. Each is one of two types: BytesMsgField or FileMsgField, enabling to handle the contents of the field as a byte stream or as a file.

Description: This file contains the GMessage class which is used not only for parsing an incoming message or constructing an outcoming one. It is also used as a general information storing mechanism which enables usage of named fields.
Allows nested messages through SetAsMessage, GetAsMessage.

attributes

FieldQueue* fields
MsgFields

methods

methods

GMessage(LogFile *aLogFile = NULL)
constructor

GMessage(const GMessage *, LogFile *aLogFile = NULL)
constructor

GMessage(Char *aFileName, LogFile *aLogFile = NULL)
constructor

GMessage(Void *aBuffer, Size aSize, LogFile *aLogFile = NULL)
constructor

~GMessage()
destructor

Size SizeOf() const
Total size

debugging

loading the stored information into the MsgFields

storing the message

getting and setting the information contained in the fields

manipulating gMessage

Size GMessage::CheckSum(char *input, Size len)
Kratky_komentar_s_teckou_na_konci. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Void GMessage::Clear()
Clears all MsgFields. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::DebugHeaders(LogFile *aLogFile, Char *aLogLabel, LogLevel aLogLevel)
Debugging method. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::Delete(Char *aFieldName)
Deletes a MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage::GMessage(LogFile *aLogFile)
Constructor for GMessage. This file contains the GMessage class which is used for parsing an incoming message or constructing an outcoming one. It is also used in parameters of functions that serve messages coming to ESo from MIX. Allows nested messages through SetAsMessage, GetAsMessage.
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage::GMessage(const GMessage *aGMessage, LogFile *aLogFile)
Constructor for GMessage. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage::GMessage(Char *aFileName, LogFile *aLogFile)
Constructor - loading structure from a file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage::GMessage(Void *aBuffer, Size aSize, LogFile *aLogFile)
Constructor - loading structure from a byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::GetAsBasicTime(Char *aFieldName, BasicTime *t) const
Returns the contents of a MsgField as an BasicTime. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Void* GMessage::GetAsBytes(Char *aFieldName, Size *aSize) const
Returns the contents of a MsgField as a byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::GetAsFile(Char *aFieldName, Char *aFileName) const
Returns the contents of a MsgField as a file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage* GMessage::GetAsGMessage(Char *aFieldName) const
Returns the contents of a MsgField as an GMessage. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::GetAsID(Char *aFieldName, ID *t) const
Returns the contents of a MsgField as an int. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::GetAsInt(Char *aFieldName, Int *i) const
Returns the contents of a MsgField as an int. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

MsgField* GMessage::GetAsMsgField(Char *aFieldName) const
Returns the contents of a MsgField as a MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::GetAsSize(Char *aFieldName, Size *i) const
Returns the contents of a MsgField as an Size. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Char* GMessage::GetAsString(Char *aFieldName) const
Returns the contents of a MsgField as a NULL terminated string. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Void GMessage::Initialize()
Initialization of attributes called from constructors. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::LoadFromBytes(Void *aBuffer, Size aLength)
Loads the fields from a byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::LoadFromFile(Char *aFileName)
Loads the fields from file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Char* GMessage::ReadBytesHeader(Void *aBuffer, Size aLength, Size *aSize, Size *anOffset)
Reads the field name + delimitor + size from the byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Char* GMessage::ReadFileHeader(File *aFile, Size *aSize)
Reads the field name + delimitor + size from the file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::Rename(Char *aFieldName, Char *newFieldName)
Changes the name of a MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsBasicTime(Char *aFieldName, BasicTime aVariable)
Sets the contents of a MsgField by copying it from bastime variable. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsBytes(Char *aFieldName, Void *aBuffer, Size aSize)
Set the contents of a MsgField by copying it from a byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsFile(Char *aFieldName, Char *aFileName)
Set the contents of a MsgField by copying it from a file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsGMessage(Char *aFieldName, GMessage *aGMessage)
Set the contents of a MsgField by copying it from an GMessage. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsID(Char *aFieldName, ID aVariable)
Sets the contents of a MsgField by copying it from int variable. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsInt(Char *aFieldName, Int aVariable)
Sets the contents of a MsgField by copying it from int variable. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsMsgField(Char *aFieldName, MsgField *aField)
Set the contents of a MsgField by copying it from another MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsSize(Char *aFieldName, Size aVariable)
Kratky_komentar_s_teckou_na_konci. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::SetAsString(Char *aFieldName, Char *aString)
Set the contents of a MsgField by copying it from a NULL terminated str.. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Size GMessage::SizeOf() const
Returns the size of the eso message in bytes. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Void* GMessage::StoreToBytes(Size *aSize) const
Stores information held by MsgFields into a byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::StoreToFile(Char *aFileName) const
Stores information held by MsgFields into a file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

MsgField* GMessage::StoreToMsgField(Char *aFieldName) const
Stores information held by MsgFields into a newly created MsgField. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Size GMessage::Sum(char *input, Size len)
Kratky_komentar_s_teckou_na_konci. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::WriteBytesHeader(Void *aBuffer, MsgField *aMsgField, Size *anOffset) const
Writes the field name + delimitor + size into the byte stream. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

Err GMessage::WriteFileHeader(File *aFile, MsgField *aMsgField) const
Writes the field name + delimitor + size into the file. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka

GMessage::~GMessage()
Denstructor for GMessage. Dlouhy_komentar
Returns:
co
Parameters:
parametr -
Author:
Pavel
See Also:
co_se_toho_tyka


Direct child classes:
EsoAC
ArrayGMessage
Author:
Pavel
See Also:
co_se_toho_tyka

alphabetic index hierarchy of classes


generated by doc++