SkyGI::DesktopCommunicationMessage Class Reference

Inheritance diagram for SkyGI::DesktopCommunicationMessage:[legend]Collaboration diagram for SkyGI::DesktopCommunicationMessage:[legend]List of all members.

Public Member Functions
	DesktopCommunicationMessage (const String &szType)
	DesktopCommunicationMessage (DataCollection *pDataCollection)
	~DesktopCommunicationMessage ()
DataCollection *	GetDataCollection ()
void	Add (const String &cKey, const Variant &pVariant)
void	Set (const String &cKey, const Variant &pVariant)
bool	Get (const String &cKey, Variant &pVariant, int iIndex=0)
bool	Get (const String &cKey, String &cString, int iIndex=0)
bool	Get (const String &cKey, int &iValue, int iIndex=0)
bool	Get (const String &cKey, long long &llValue, int iIndex=0)
Variant	GetVariant (const String &cKey, int iIndex=0)
bool	Ok ()
bool	Failed ()
int	GetErrorCode ()
void *	GetNative ()
void	SetNative (void *vpData)
void	SetSender (const String &szString)
String	GetSender (void)
bool	SenderIsWaiting ()
bool	Send (DesktopCommunicationInterface *pInterface, const String &szDestinationInterfacePath, bool bWantReply=false)
bool	Send (const String &szDestinationInterfacePath, bool bWantReply=false)
DesktopCommunicationMessage *	Wait (DesktopCommunicationInterface *pInterface, int iTimeOutInMsecs=0)
DesktopCommunicationMessage *	Wait (int iTimeOutInMsecs=0)
bool	Reply (DesktopCommunicationInterface *pInterface, DesktopCommunicationMessage &pMessage, int ErrorCode)
void	Dump ()
Classes
class	Private

---

Detailed Description

Examples:

eventsource.cpp.

---

Constructor & Destructor Documentation

DesktopCommunicationMessage::DesktopCommunicationMessage

(

const String &

szType

)

DesktopCommunicationMessage::DesktopCommunicationMessage

(

DataCollection *

pDataCollection

)

DesktopCommunicationMessage::~DesktopCommunicationMessage

(

)

---

Member Function Documentation

DataCollection * DesktopCommunicationMessage::GetDataCollection

(

)

void DesktopCommunicationMessage::Add	(	const String &	cKey,
		const Variant &	pVariant
	)

void DesktopCommunicationMessage::Set	(	const String &	cKey,
		const Variant &	pVariant
	)

bool DesktopCommunicationMessage::Get	(	const String &	cKey,
		Variant &	pVariant,
		int	iIndex = 0
	)

bool DesktopCommunicationMessage::Get	(	const String &	cKey,
		String &	cString,
		int	iIndex = 0
	)

bool DesktopCommunicationMessage::Get	(	const String &	cKey,
		int &	iValue,
		int	iIndex = 0
	)

bool DesktopCommunicationMessage::Get	(	const String &	cKey,
		long long &	llValue,
		int	iIndex = 0
	)

Variant SkyGI::DesktopCommunicationMessage::GetVariant	(	const String &	cKey,
		int	iIndex = 0
	)

bool DesktopCommunicationMessage::Ok

(

)

Check message error code

Description:

Returns true if the function contains an ErrorCode parameter which is zero. (Note: Not all message may contain such an ErrorCode parameter)

bool DesktopCommunicationMessage::Failed

(

)

Check message error code

Description:

Returns true if the function doesn't contain an ErrorCode parameter or the ErrorCode parameter is non zero. (Note: Not all message may contain such an ErrorCode parameter)

int DesktopCommunicationMessage::GetErrorCode

(

)

Check message error code

Description:

Returns -1 if the function doesn't contain an ErrorCode parameter or the value of the ErrorCode parameter

void* SkyGI::DesktopCommunicationMessage::GetNative

(

)

void SkyGI::DesktopCommunicationMessage::SetNative

(

void *

vpData

)

void DesktopCommunicationMessage::SetSender

(

const String &

szString

)

String DesktopCommunicationMessage::GetSender

(

void

)

bool DesktopCommunicationMessage::SenderIsWaiting

(

)

Returns if sender is waiting for an answer

Description:

If the sender placed a WantReply parameter in the message and it is set to true, this function returns true.
In this case you should send a appropriate reply to the sender using DesktopCommunicationMessage::Reply

bool DesktopCommunicationMessage::Send	(	DesktopCommunicationInterface *	pInterface,
		const String &	szDestinationInterfacePath,
		bool	bWantReply = false
	)

Send a message

Description:

Sends a message using the specified Desktop Communication Interface.

bool DesktopCommunicationMessage::Send	(	const String &	szDestinationInterfacePath,
		bool	bWantReply = false
	)

Send a message using a temporary Desktop Communication Interface

Description:

Sends a message using a temporary Desktop Communication Interface. This unique interface is created when this function gets called the first time. When the object gets destroyed the interface gets destroyed too.
It should be noted that creating temporary interfaces can be rather slow, and it is preferred to directly use the DesktopCommunicationInterface::SendMessage function.
If the target which gets this message replies with another message you must use the DesktopCommunicationMessage::Wait function to wait on the temporary interface.

DesktopCommunicationMessage * DesktopCommunicationMessage::Wait	(	DesktopCommunicationInterface *	pInterface,
		int	iTimeOutInMsecs = 0
	)

Wait for a message on the specified Desktop Communication Interface

See also:

DesktopCommunicationInterface::Send

DesktopCommunicationMessage * DesktopCommunicationMessage::Wait

(

int

iTimeOutInMsecs = 0

)

Wait for a message on the temporary Desktop Communication Interface

See also:

DesktopCommunicationInterface::Send

bool DesktopCommunicationMessage::Reply	(	DesktopCommunicationInterface *	pInterface,
		DesktopCommunicationMessage &	pMessage,
		int	ErrorCode
	)

Reply to message

Description:

If this message was received with Wait() this function replies the passed message to the original sender and automatically attaches the ErrorCode to it

void DesktopCommunicationMessage::Dump

(

)

---