Cpl::Itc::Message Class Reference

This abstract class defines the operations for an ITC message. More...

Detailed Description

This abstract class defines the operations for an ITC message.

#include <Message.h>

Inheritance diagram for Cpl::Itc::Message:

Collaboration diagram for Cpl::Itc::Message:

Public Member Functions
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

~Message()

virtual Cpl::Itc::Message::~Message ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

process()

virtual void Cpl::Itc::Message::process ( )

pure virtualnoexcept

This abstract operation is invoked by the mailbox owner to cause the message to be processed after it has been retrieved from the mailbox.

Implemented in Cpl::Itc::RequestMessage< SERVER, PAYLOAD >, and Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >.

---

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

• Cpl/Itc/Message.h