This concrete template class implements the ITC messaging (and Model Point monitoring) needed to provide a thread-safe/asynchronous interface for reading/writing 'Indexed Entries'. More...

Detailed Description

template<class ENTRY>
class Cpl::Persistent::IndexedEntryServer< ENTRY >

This concrete template class implements the ITC messaging (and Model Point monitoring) needed to provide a thread-safe/asynchronous interface for reading/writing 'Indexed Entries'.

Template Args: ENTRY:= The Application specific class that defines an 'entry'

#include <IndexedEntryServer.h>

Inheritance diagram for Cpl::Persistent::IndexedEntryServer< ENTRY >:

[legend]

Collaboration diagram for Cpl::Persistent::IndexedEntryServer< ENTRY >:

[legend]

Public Member Functions
	IndexedEntryServer (Cpl::Dm::MailboxServer &myMbox, IndexedEntryRecord &indexedEntryRecord, Cpl::Container::RingBufferMP< ENTRY > &incomingEntriesBuffer) noexcept
	Constructor.

void	request (OpenMsg &msg)
	This method starts the server (See Cpl::Itc::OpenSync)

void	request (CloseMsg &msg)
	This method stops the server (See Cpl::Itc::CloseSync)

void	elementCountChanged (Cpl::Dm::Mp::Uint32 &mp, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Element Count Change notification.

void	request (GetLatestMsg &msg)
	See Cpl::Persistent::GetLatestRequest.

void	request (GetNextMsg &msg)
	See Cpl::Persistent::GetNextRequest.

void	request (GetPreviousMsg &msg)
	See Cpl::Persistent::GetPreviousRequest.

void	request (GetByBufferIndexMsg &msg)
	See Cpl::Persistent::GetByBufferIndexRequest.

size_t	getMaxIndex () const noexcept
	See Cpl::Persistent::IndexEntryReader.

void	request (ClearAllEntriesMsg &msg)
	See Cpl::Persistent::ClearAllEntriesRequest.

Public Member Functions inherited from Cpl::Itc::CloseSync
	CloseSync (PostApi &myMbox) noexcept
	Constructor.

bool	close (void *args=nullptr)
	See CloseSync.

Public Member Functions inherited from Cpl::Itc::OpenSync
	OpenSync (PostApi &myMbox) noexcept
	Constructor.

bool	open (void *args=nullptr)
	See OpenApi.

Public Member Functions inherited from Cpl::Itc::OpenApi
virtual	~OpenApi ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Itc::CloseApi
virtual	~CloseApi ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Persistent::GetLatestRequest
virtual	~GetLatestRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Persistent::GetNextRequest
virtual	~GetNextRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Persistent::GetPreviousRequest
virtual	~GetPreviousRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Persistent::GetByBufferIndexRequest
virtual	~GetByBufferIndexRequest ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Persistent::ClearAllEntriesRequest
virtual	~ClearAllEntriesRequest ()
	Virtual Destructor.

Protected Member Functions
virtual void	hookAddingEntry (ENTRY &src)
	Hook to allow a child class processing when an entry is added. This method is called just PRIOR to writing the data to persistent storage.

Protected Attributes
IndexedEntryRecord &	m_record
	Indexed Entry Record that handles the actual work to read/write the data.

Cpl::Dm::SubscriberComposer< IndexedEntryServer, Cpl::Dm::Mp::Uint32 >	m_observerElementCount
	Observer for change notification (to the RingBuffer)

Cpl::Container::RingBufferMP< ENTRY > &	m_addBuffer
	the 'add' buffer

bool	m_opened
	Track my open state.

Protected Attributes inherited from Cpl::Itc::OpenSync
PostApi &	m_mbox
	Mailbox (of the server implementing the ITC request() method.

Additional Inherited Members
Public Types inherited from Cpl::Itc::OpenRequest
typedef Cpl::Itc::SAP< OpenRequest >	SAP
	SAP for this API.

typedef RequestMessage< OpenRequest, OpenPayload >	OpenMsg
	Message Type: Open.

Public Types inherited from Cpl::Itc::CloseRequest
typedef Cpl::Itc::SAP< CloseRequest >	SAP
	SAP for this API.

typedef RequestMessage< CloseRequest, ClosePayload >	CloseMsg
	Message Type: Close.

Public Types inherited from Cpl::Persistent::GetLatestRequest
typedef Cpl::Itc::SAP< GetLatestRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< GetLatestRequest, Payload >	GetLatestMsg
	Message Type: GetLatest.

Public Types inherited from Cpl::Persistent::GetNextRequest
typedef Cpl::Itc::SAP< GetNextRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< GetNextRequest, Payload >	GetNextMsg
	Message Type: GetNext.

Public Types inherited from Cpl::Persistent::GetPreviousRequest
typedef Cpl::Itc::SAP< GetPreviousRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< GetPreviousRequest, Payload >	GetPreviousMsg
	Message Type: GetPrevious.

Public Types inherited from Cpl::Persistent::GetByBufferIndexRequest
typedef Cpl::Itc::SAP< GetByBufferIndexRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< GetByBufferIndexRequest, Payload >	GetByBufferIndexMsg
	Message Type: GetByBufferIndex.

Public Types inherited from Cpl::Persistent::ClearAllEntriesRequest
typedef Cpl::Itc::SAP< ClearAllEntriesRequest >	SAP
	SAP for this API.

typedef Cpl::Itc::RequestMessage< ClearAllEntriesRequest, Payload >	ClearAllEntriesMsg
	Message Type: GetPrevious.

Constructor & Destructor Documentation

◆ IndexedEntryServer()

template<class ENTRY >

Cpl::Persistent::IndexedEntryServer< ENTRY >::IndexedEntryServer	(	Cpl::Dm::MailboxServer &	myMbox,
		IndexedEntryRecord &	indexedEntryRecord,
		Cpl::Container::RingBufferMP< ENTRY > &	incomingEntriesBuffer
	)