MessageHeader Class Reference

Describes the header of a message send from one client to another, or to the server. More...

#include <messageheader.h>

Inheritance diagram for MessageHeader:

BaseMessage List of all members.

Public Member Functions

 MessageHeader (int sessionID=0)
 Constructor.
 ~MessageHeader ()
 Destructor.
void toXML (XMLWriter &writer) const
 Write a BaseMessage XML representation.
void processMessage () const
 Process message instructions.
void setSessionID (int sessionID)
 Sets the header session ID.
int getSessionID () const
 Returns the header session ID.
std::string toString () const
 Returns a BaseMessage string represention.
MessageHeadercopy () const
 Returns a copy of this message.

Protected Attributes

int m_iSessionID
 Session ID.

Detailed Description

Describes the header of a message send from one client to another, or to the server.

Author:
Sylvain Archenault <sylvain.archenault@laposte.net>

Yves Houpert <yves.houpert@insa-rouen.fr>


Constructor & Destructor Documentation

MessageHeader::MessageHeader int  sessionID = 0  ) 
 

Constructor.

Parameters:
sessionID Session ID.


Member Function Documentation

MessageHeader & MessageHeader::copy  )  const [virtual]
 

Returns a copy of this message.

Returns:
Copy of the message.

Implements BaseMessage.

int MessageHeader::getSessionID  )  const [inline]
 

Returns the header session ID.

Returns:
Header session ID.

void MessageHeader::setSessionID int  sessionID  )  [inline]
 

Sets the header session ID.

Parameters:
sessionID Header session ID.

std::string MessageHeader::toString  )  const [virtual]
 

Returns a BaseMessage string represention.

Returns:
BaseMessage String representation.

Implements BaseMessage.

void MessageHeader::toXML XMLWriter writer  )  const [virtual]
 

Write a BaseMessage XML representation.

Parameters:
writer XMLWriter object used to writer XML representation.

Implements BaseMessage.


The documentation for this class was generated from the following files:
Generated on Fri May 19 12:15:55 2006 for Bamboo Ch@t by  doxygen 1.4.6