Class: TStandardCaucusSendMessage

Declaration: StandardCaucus.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TStandardCaucusSendMessage is used to send a message to a caucus. The client sends a message by creating a TStandardCaucusSendMessage object, streaming data into it, and destroying the object (which forces the send). TStandardCaucusSendMessage should always be constructed on the stack. There is no limit on the size of the message that can be sent. Zero-byte messages are allowed.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardCaucusSendMessage::TStandardCaucusSendMessage

TStandardCaucusSendMessage (TStandardCaucusMember * memberAlias)

Interface Category:

API.

Purpose:

Creates a new TStandardCaucusMember to send a message for the specified member. Initiates the send operation.

Calling Context:

Called by the caucus member sending the message.

Parameters:

TStandardCaucusMember * memberAlias -The sender of the message. It must not be NIL.

Return Value:

None.

Exceptions:

Throws TCaucusException::kNotInCaucus if the member has not joined or is not longer a member of the caucus. All others are passed through.

Concurrency:

Multithread safe.

Other Considerations:

Always allocate on stack.

Member Function: TStandardCaucusSendMessage::~TStandardCaucusSendMessage

~ TStandardCaucusSendMessage ()

Interface Category:

API.

Purpose:

Destructor. Completes the send message (for example, calls the member's EndSend member function).

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws TCaucusException::kNotInCaucus if the member has not joined or is not longer a member of the caucus. All others are passed through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardCaucusSendMessage::operatorTStream&

operator TStream & () const

Interface Category:

API.

Purpose:

Returns the stream used to send 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 in to this object.

Parameters:

Takes no parameters.

Return Value:

Returns the stream used to send the message.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

There might be times when you need to explicitly call this conversion operator directly (for example, if the compiler doesn't or cannot do it for you).

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