This abstract class represents the interface used to send messages to a mailbox. More...

Detailed Description

This abstract class represents the interface used to send messages to a mailbox.

In a client-server relationship this interface is always invoked by the client.

#include <PostApi.h>

Inheritance diagram for Cpl::Itc::PostApi:

Public Member Functions
virtual void	post (Message &msg) noexcept=0
	This operation is called by clients, which wish to send a message to the owner of this mailbox.

virtual void	postSync (Message &msg) noexcept=0
	This operation is called by clients which wish to send a message to the owner of this mailbox, and then block on the client's thread semaphore.

virtual	~PostApi ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~PostApi()

virtual Cpl::Itc::PostApi::~PostApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ post()

virtual void Cpl::Itc::PostApi::post ( Message & msg )

pure virtualnoexcept

This operation is called by clients, which wish to send a message to the owner of this mailbox.

The message is threaded into the mailbox queue for the mailbox owner to receive, and the operation returns immediately. The client relinquishes ownership of the memory until the message's returnToSender() function is invoked.

Implemented in Cpl::Itc::Mailbox, and Cpl::Itc::SAP< SERVER >.

◆ postSync()

virtual void Cpl::Itc::PostApi::postSync ( Message & msg )

pure virtualnoexcept

This operation is called by clients which wish to send a message to the owner of this mailbox, and then block on the client's thread semaphore.

First, the message is threaded into the mailbox queue for the mailbox owner to receive. Next, the client waits on its thread semaphore until the semaphore is signaled.