Class: TCaucusReceiveMessage

Declaration: Caucus.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TCaucusReceiveMessage is used to receive a message from a caucus. The client receives a message by creating a TCaucusReceiveMessage object, streaming data out of it, and destroying the object. TCaucusReceiveMessage is always constructed on the stack.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TCaucusReceiveMessage::TCaucusReceiveMessage

TCaucusReceiveMessage (TCaucusMember * memberAlias)
TCaucusReceiveMessage (TCaucusMember * memberAlias, TCaucusMember :: Identifier & senderID)
TCaucusReceiveMessage (TCaucusMember * memberAlias, TCaucusMember :: Identifier & senderID, bool & isLeaveMessage)

Interface Category:

API.

Purpose:

Creates a new TCaucusReceiveMessage to receive a message for the specified caucus member. Initiates a receive operation.
Creates a new TCaucusReceiveMessage to receive a message for the specified caucus member. Initiates a receive operation.
Creates a new TCaucusReceiveMessage to receive a message for the specified caucus member. Initiates a receive operation.

Calling Context:

Called by the caucus member receiving the message.
Called by the caucus member receiving the message.
Called by the caucus member receiving the message.

Parameters:

TCaucusMember * memberAlias -The message receiver. It must not be NIL.
TCaucusMember * memberAlias -The message receiver. It must not be NIL.
TCaucusMember :: Identifier & senderID -The identifier for the message sender.
TCaucusMember * memberAlias -The message receiver. It must not be NIL.
TCaucusMember :: Identifier & senderID -The identifier for the message sender.
bool & isLeaveMessage -A flag indicating whether the message received is a leave message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The constructor completes, only when there is a message to be received otherwise, it blocks. Use a separate thread to receive messages. Allocate one TCaucusReceiveMessage per caucus message.

Member Function: TCaucusReceiveMessage::~TCaucusReceiveMessage

~ TCaucusReceiveMessage ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TCaucusReceiveMessage::operatorTStream&

operator TStream & () const

Interface Category:

API.

Purpose:

Returns the stream used to receive the message.

Calling Context:

You do not need to call this function directly. The compiler should generate a stream conversion operator for you when you stream data out of this object.

Parameters:

Takes no parameters.

Return Value:

Returns the stream used to receive the message.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.