Cpl::Itc::SAP< SERVER > Class Template Reference

This concrete template class represents the interface to a ITC Service Access Point (SAP). More...

Detailed Description

template<class SERVER>
class Cpl::Itc::SAP< SERVER >

This concrete template class represents the interface to a ITC Service Access Point (SAP).

A SAP 'binds' a Request API with a mailbox interface. In effect a Service is the 'fully-qualified' identifier for posting a message to a specific Request API.

#include <SAP.h>

Inheritance diagram for Cpl::Itc::SAP< SERVER >:

Collaboration diagram for Cpl::Itc::SAP< SERVER >:

Public Member Functions
	SAP (SERVER &api, PostApi &mbox)
	This constructor requires a reference to the request API and its associated mailbox/post-message API.
SERVER &	getServer () noexcept
	Returns a reference to the associated Cpl::Itc::Request instance.
void	post (Message &msg) noexcept
	See PostApi
void	postSync (Message &msg) noexcept
	See PostApi.
Public Member Functions inherited from Cpl::Itc::PostApi
virtual	~PostApi ()
	Virtual destructor.

Protected Attributes
SERVER &	m_api
	Reference to the instance that implements the request service.
PostApi &	m_mbox
	Reference to the associated post-message/mailbox interface.

Constructor & Destructor Documentation

SAP()

template<class SERVER >

Cpl::Itc::SAP< SERVER >::SAP	(	SERVER &	api,
		PostApi &	mbox
	)

This constructor requires a reference to the request API and its associated mailbox/post-message API.

Member Function Documentation

getServer()

template<class SERVER >

SERVER & Cpl::Itc::SAP< SERVER >::getServer ( )

noexcept

Returns a reference to the associated Cpl::Itc::Request instance.

post()

template<class SERVER >

void Cpl::Itc::SAP< SERVER >::post ( Message &  msg )

virtualnoexcept

See PostApi

Implements Cpl::Itc::PostApi.

postSync()

template<class SERVER >

void Cpl::Itc::SAP< SERVER >::postSync ( Message &  msg )

virtualnoexcept

See PostApi.

Implements Cpl::Itc::PostApi.

Member Data Documentation

m_api

template<class SERVER >

SERVER& Cpl::Itc::SAP< SERVER >::m_api

protected

Reference to the instance that implements the request service.

m_mbox

template<class SERVER >

PostApi& Cpl::Itc::SAP< SERVER >::m_mbox

protected

Reference to the associated post-message/mailbox interface.

---

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

• Cpl/Itc/SAP.h