Inheritance diagram for zeus::IMessagePool:

Public Member Functions
virtual Retval MQUALIFIER	createConnectionPipe (const IString &rPipeName)=0
virtual Retval MQUALIFIER	getConnectionPipe (const IString &rPipeName, IRemoteObject *&rpPipe) const =0
virtual Retval MQUALIFIER	sendMessage (const IString &rPipeName, const ISerializable &rMessage)=0
virtual Retval MQUALIFIER	receiveMessage (const IString &rPipeName, ISerializable *&rpMessage)=0

Detailed Description

This remote interface is used to access a message pool. The message pool provides different topics (pipes) to send messages through.

Member Function Documentation

virtual Retval MQUALIFIER zeus::IMessagePool::createConnectionPipe ( const IString & rPipeName ) [pure virtual]

creates a connection pipe by name. If a pipe with this name already exists the method sucerssfully returns .

Parameters:

rPipeName : Name of the pipe

Return values:

RET_NOERROR	: Pipe created or exists already
RET_REQUEST_FAILED	: Could not create the pipe

virtual Retval MQUALIFIER zeus::IMessagePool::getConnectionPipe	(	const IString &	rPipeName,
		IRemoteObject *&	rpPipe
	)		const `[pure virtual]`

returns a connection pipe by name.

Parameters:

rPipeName	: Name of the pipe
rpPipe,:	Return parameter (interface ICommPipe)

Return values:

RET_NOERROR	: Pipe returned
RET_REQUEST_FAILED	: Could not create the pipe

virtual Retval MQUALIFIER zeus::IMessagePool::receiveMessage	(	const IString &	rPipeName,
		ISerializable *&	rpMessage
	)		`[pure virtual]`

tries to receive a message from a named pipe

Parameters:

rPipeName	: Name of the pipe
rpMessage	: Return parameter

Return values:

RET_NOERROR	: message received
RET_REQUEST_FAILED	: Could not receive a message

virtual Retval MQUALIFIER zeus::IMessagePool::sendMessage	(	const IString &	rPipeName,
		const ISerializable &	rMessage
	)		`[pure virtual]`

sends a message to the named pipe

Parameters:

rPipeName	: Name of the pipe
rMessage	: Message to send

Return values:

RET_NOERROR	: message sent
RET_REQUEST_FAILED	: Could not send the message

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