zeus::IMessage Class Reference

#include <IMessage.hpp>

Inheritance diagram for zeus::IMessage:

List of all members.

Public Member Functions
virtual void MQUALIFIER	clearBody ()=0
virtual void MQUALIFIER	clearProperties ()=0
virtual void MQUALIFIER	getInterfaceID (InterfaceID &rIID) const =0
virtual Uint MQUALIFIER	getMessageID () const =0
virtual Uint MQUALIFIER	getPriority () const =0
virtual void MQUALIFIER	getSender (TypGUID &rValue) const =0
virtual void MQUALIFIER	getRecipients (IList< TypGUID > &rValue) const =0
virtual Retval MQUALIFIER	getPropertyValue (const IString &rstrName, IString &rstrValue) const =0
virtual Uint64 MQUALIFIER	getTimeStamp () const =0
virtual void MQUALIFIER	setMessageID (Uint uiValue)=0
virtual void MQUALIFIER	setPropertyValue (const IString &rstrName, const IString &rstrValue)=0
virtual void MQUALIFIER	setPriority (Uint uiValue)=0
virtual void MQUALIFIER	setSender (const TypGUID &rValue)=0
virtual void MQUALIFIER	setRecipient (const TypGUID &rValue)=0
virtual void MQUALIFIER	setRecipients (const IList< TypGUID > &rValue)=0
virtual void MQUALIFIER	setTimeStamp (const Uint64 &rui64Value)=0

---

Detailed Description

This interface defines a general message object. The messages are streamed and sent between different remote systems using the ZMS (Zeus Message System). There are different sub types of this message interface, like IBinaryMessage, IObjectMessage etc.

---

Member Function Documentation

virtual void MQUALIFIER zeus::IMessage::clearBody

(

)

[pure virtual]

Clears the body content.

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

virtual void MQUALIFIER zeus::IMessage::clearProperties

(

)

[pure virtual]

Clears the properies entries. The header and the body is not cleared.

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

virtual void MQUALIFIER zeus::IMessage::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

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

virtual Uint MQUALIFIER zeus::IMessage::getMessageID

(

)

const [pure virtual]

Returns the ID header field of the message

Returns:

Message ID

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

virtual Uint MQUALIFIER zeus::IMessage::getPriority

(

)

const [pure virtual]

Returns the priority header field of the message

Returns:

Priority of message

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

virtual Retval MQUALIFIER zeus::IMessage::getPropertyValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

gets a property

Parameters:

rstrName,:	Name of the property
rstrValue,:	return value

Return values:

RET_NOERROR,:	property returned
RET_REQUEST_FAILED,:	no such attribute found

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

virtual void MQUALIFIER zeus::IMessage::getRecipients

(

IList< TypGUID > &

rValue )

const [pure virtual]

Returns the IDs of the recipient instances

Parameters:

rValue,:

return parameter of the ID list

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

virtual void MQUALIFIER zeus::IMessage::getSender

(

TypGUID &

rValue )

const [pure virtual]

returns the ID of the sender instance

Parameters:

rValue,:

return parameter

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

virtual Uint64 MQUALIFIER zeus::IMessage::getTimeStamp

(

)

const [pure virtual]

Returns the time stamp field of the header

Returns:

Timestamp

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

virtual void MQUALIFIER zeus::IMessage::setMessageID

(

Uint

uiValue )

[pure virtual]

Sets the ID header field of the message. This field is set automatically when the message is sent.

Parameters:

uiValue,:

ID of the message

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

virtual void MQUALIFIER zeus::IMessage::setPriority

(

Uint

uiValue )

[pure virtual]

Sets the priority header field of the message

Parameters:

uiValue,:

new priority

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

virtual void MQUALIFIER zeus::IMessage::setPropertyValue	(	const IString &	rstrName,
		const IString &	rstrValue
	)		[pure virtual]

sets a property

Parameters:

rstrName,:	Name of the property
rstrValue,:	property value

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

virtual void MQUALIFIER zeus::IMessage::setRecipient

(

const TypGUID &

rValue )

[pure virtual]

sets one recipient

Parameters:

rValue,:

ID of recipient

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

virtual void MQUALIFIER zeus::IMessage::setRecipients

(

const IList< TypGUID > &

rValue )

[pure virtual]

sets a list of recipients

Parameters:

rValue,:

list of recipients

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

virtual void MQUALIFIER zeus::IMessage::setSender

(

const TypGUID &

rValue )

[pure virtual]

Sets the sender name (or ID) of the

Parameters:

rValue,:

ID of sender

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

virtual void MQUALIFIER zeus::IMessage::setTimeStamp

(

const Uint64 &

rui64Value )

[pure virtual]

Sets the time stamp field of the header. This field is set if the message is sent.

Parameters:

rui64Value,:

new timestamp

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

---

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

• IMessage.hpp