Cpl::Persistent::GetByBufferIndexRequest Class Reference

This abstract class define ITC message type and payload for the application to request read Indexed Entry data. More...

Detailed Description

This abstract class define ITC message type and payload for the application to request read Indexed Entry data.

See the Cpl/Itc/README.txt file for the semantics for the 'ownership' of the payload contents.

NOTE: This interface can/should NOT be used synchronously. The application is required to only use asynchronous semantics.

#include <IndexedEntryRequests.h>

Inheritance diagram for Cpl::Persistent::GetByBufferIndexRequest:

Classes
class	Payload
	Payload for Message: GetByBufferIndex. More...

Public Types
typedef Cpl::Itc::SAP< GetByBufferIndexRequest >	SAP
	SAP for this API.
typedef Cpl::Itc::RequestMessage< GetByBufferIndexRequest, Payload >	GetByBufferIndexMsg
	Message Type: GetByBufferIndex.

Public Member Functions
virtual void	request (GetByBufferIndexMsg &msg)=0
	Request: GetByBufferIndex message.
virtual size_t	getMaxIndex () const noexcept=0
	This method returns the maximum allowed 'bufferIndex' when calling getByIndex().
virtual	~GetByBufferIndexRequest ()
	Virtual Destructor.

Member Typedef Documentation

GetByBufferIndexMsg

typedef Cpl::Itc::RequestMessage<GetByBufferIndexRequest, Payload> Cpl::Persistent::GetByBufferIndexRequest::GetByBufferIndexMsg

Message Type: GetByBufferIndex.

SAP

typedef Cpl::Itc::SAP<GetByBufferIndexRequest> Cpl::Persistent::GetByBufferIndexRequest::SAP

SAP for this API.

Constructor & Destructor Documentation

~GetByBufferIndexRequest()

virtual Cpl::Persistent::GetByBufferIndexRequest::~GetByBufferIndexRequest ( )

inlinevirtual

Virtual Destructor.

Member Function Documentation

getMaxIndex()

virtual size_t Cpl::Persistent::GetByBufferIndexRequest::getMaxIndex ( ) const

pure virtualnoexcept

This method returns the maximum allowed 'bufferIndex' when calling getByIndex().

NOTE: THIS IS NOT AN ITC MESSAGE REQUEST - it is 'traditional' thread-safe function call.

Implemented in Cpl::Persistent::IndexedEntryServer< ENTRY >, and Cpl::Persistent::IndexedEntryServer< Cpl::Logging::EntryData_T >.

request()

virtual void Cpl::Persistent::GetByBufferIndexRequest::request ( GetByBufferIndexMsg &  msg )

pure virtual

Request: GetByBufferIndex message.

Implemented in Cpl::Persistent::IndexedEntryServer< ENTRY >, and Cpl::Persistent::IndexedEntryServer< Cpl::Logging::EntryData_T >.

---

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

• Cpl/Persistent/IndexedEntryRequests.h