This class represents a defined message, which is posted to a mailbox-server as a request. More...

Detailed Description

This class represents a defined message, which is posted to a mailbox-server as a request.

It includes members which enable the client to be notified when the server thread has completed the request.

Inheritance diagram for Cpl::Itc::ServiceMessage:

Collaboration diagram for Cpl::Itc::ServiceMessage:

Public Member Functions
	ServiceMessage (ReturnHandler &rh) noexcept
	Constructor.

void	returnToSender () noexcept
	This operation is invoked by the server when it has completed the operation implemented as a part of this message.

Public Member Functions inherited from Cpl::Itc::Message
virtual void	process () noexcept=0
	This abstract operation is invoked by the mailbox owner to cause the message to be processed after it has been retrieved from the mailbox.

virtual	~Message ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

Cpl::Itc::ServiceMessage::ServiceMessage ( ReturnHandler & rh )

noexcept

Constructor.

void Cpl::Itc::ServiceMessage::returnToSender ( )

noexcept

This operation is invoked by the server when it has completed the operation implemented as a part of this message.

Use of this operation relinquishes the ownership of the message from the server (which invokes the operation) to the client.

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