zeus::TAbstractMessage Class Reference

#include <AbstractMessage.h>

Inheritance diagram for zeus::TAbstractMessage:

List of all members.

Public Member Functions
virtual void MQUALIFIER	clearBody ()=0
virtual void MQUALIFIER	clearProperties ()
virtual void MQUALIFIER	getInterfaceID (InterfaceID &rIID) const =0
virtual Uint MQUALIFIER	getMessageID () const
virtual Uint MQUALIFIER	getPriority () const
virtual void MQUALIFIER	getSender (TypGUID &rValue) const
virtual void MQUALIFIER	getRecipients (IList< TypGUID > &rlstValue) const
virtual Retval MQUALIFIER	getPropertyValue (const IString &rName, IString &rValue) const
virtual Uint64 MQUALIFIER	getTimeStamp () const
virtual void MQUALIFIER	setMessageID (Uint uiValue)
virtual void MQUALIFIER	setPropertyValue (const IString &rName, const IString &rValue)
virtual void MQUALIFIER	setPriority (Uint uiValue)
virtual void MQUALIFIER	setSender (const TypGUID &rValue)
virtual void MQUALIFIER	setRecipient (const TypGUID &rValue)
virtual void MQUALIFIER	setRecipients (const IList< TypGUID > &rlstValue)
virtual void MQUALIFIER	setTimeStamp (const Uint64 &rui64Value)
	SERIAL_START_ABSTRACTCLASS (TAbstractMessage, L"TAbstractMessage") SERIAL_UINT32(m_uiID) SERIAL_UINT32(m_ulPriority) SERIAL_UINT32(m_uiReserved) SERIAL_UINT64(m_ui64Timestamp) SERIAL_STRING_STRINGMAP(m_mapProperties) SERIAL_GUID(m_SenderID) SERIAL_GUIDLIST(m_lstRecipients) virtual Retval MQUALIFIER askForInterface(const InterfaceID &rInterfaceID
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Public Attributes
IZUnknown *&	rpIface
Protected Member Functions
	TAbstractMessage ()
virtual	~TAbstractMessage ()
Protected Attributes
TCriticalSection &	m_rLock
	Data Lock.

---

Detailed Description

This message implements only the header of the Zeus Message. The header is needed for routing and meta data of the message

---

Constructor & Destructor Documentation

TAbstractMessage::TAbstractMessage

(

)

[protected]

Creates an abstract message

TAbstractMessage::~TAbstractMessage

(

)

[protected, virtual]

Destroys the abstract message

---

Member Function Documentation

virtual void MQUALIFIER zeus::TAbstractMessage::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TBinaryMessage, zeus::TLocalMapMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

virtual void MQUALIFIER zeus::TAbstractMessage::clearBody

(

)

[pure virtual]

Clears the body content.

Implements zeus::IMessage.

Implemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER TAbstractMessage::clearProperties

(

)

[virtual]

See also:

IMessage::clearProperties

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

virtual void MQUALIFIER zeus::TAbstractMessage::getInterfaceID

(

InterfaceID &

rIID )

const [pure virtual]

This method returns the interface id of the message. The difference between the getPrimaryType() from IStreamable and this method is, that this id represents the Message Object Type ID (format of the message), the primary type is the base object type.

Parameters:

rIID,:

Message Interface Type

Implements zeus::IMessage.

Implemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

Uint MQUALIFIER zeus::TAbstractMessage::getMessageID

(

)

const [inline, virtual]

See also:

IMessage::getMessageID

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

Uint MQUALIFIER zeus::TAbstractMessage::getPriority

(

)

const [inline, virtual]

See also:

IMessage::getPriority

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

Retval MQUALIFIER TAbstractMessage::getPropertyValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IMessage::getPropertyValue

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER zeus::TAbstractMessage::getRecipients

(

IList< TypGUID > &

rlstValue )

const [inline, virtual]

See also:

IMessage::getRecipients

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER zeus::TAbstractMessage::getSender

(

TypGUID &

rValue )

const [inline, virtual]

See also:

IMessage::getSender

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

Uint64 MQUALIFIER zeus::TAbstractMessage::getTimeStamp

(

)

const [inline, virtual]

See also:

IMessage::getTimestamp

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

virtual void MQUALIFIER zeus::TAbstractMessage::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TZObject.

Reimplemented in zeus::TBinaryMessage, zeus::TLocalMapMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

zeus::TAbstractMessage::SERIAL_START_ABSTRACTCLASS	(	TAbstractMessage	,
		L"TAbstractMessage"
	)		const

void MQUALIFIER TAbstractMessage::setMessageID

(

Uint

uiValue )

[virtual]

See also:

IMessage::setMessageID

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER TAbstractMessage::setPriority

(

Uint

uiValue )

[virtual]

See also:

IMessage::setPriority

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER TAbstractMessage::setPropertyValue	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IMessage::setPropertyValue

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER zeus::TAbstractMessage::setRecipient

(

const TypGUID &

rValue )

[inline, virtual]

See also:

IMessage::setRecipient

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER zeus::TAbstractMessage::setRecipients

(

const IList< TypGUID > &

rlstValue )

[inline, virtual]

See also:

IMessage::setRecipients

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER zeus::TAbstractMessage::setSender

(

const TypGUID &

rValue )

[inline, virtual]

See also:

IMessage::setSender

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

void MQUALIFIER TAbstractMessage::setTimeStamp

(

const Uint64 &

rui64Value )

[virtual]

See also:

IMessage::setTimestamp

Implements zeus::IMessage.

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

---

Member Data Documentation

TCriticalSection& zeus::TAbstractMessage::m_rLock [protected]

Data Lock.

IZUnknown*& zeus::TAbstractMessage::rpIface

Reimplemented in zeus::TBinaryMessage, zeus::TMapMessage, zeus::TObjectMessage, zeus::TTextMessage, and zeus::TXMLMessage.

---

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

• AbstractMessage.h
• AbstractMessage.cpp