This concrete class implements the Cpl::Persistent::Record interface to store a collection 'entries'. More...

Detailed Description

This concrete class implements the Cpl::Persistent::Record interface to store a collection 'entries'.

All 'entries' are required to the same/fixed length. A single Chunk handler is used to read/write all of the entries.

The content of the entry data is defined by a single instance of a application specific child class of the Cpl::Persistent::Payload class.

The individual entries are logically stored in a Ring Buffer. This means that once the Ring Buffer is full (i.e. all of the space available in the RegionMedia has been written to) older entries are over written when there is request to write a new entry. In addition a 'secondary record' (with its own chunk handler) is used to persistently store the 'head pointer' of the Ring Buffer.

NOTE: The 'secondary record' is wholly managed by the IndexedEntryRecord, i.e. the secondary record instance should NOT be directly added to the Record Server's list of records to manage.

A 'index value' is associated with each entry. The index value is a free running counter that is used to determine the relative age between entries. The larger an 'index value' is, the newer the entry is.

NOTE: This interface/class is NOT THREAD SAFE and should only be 'used' from the Record Server's thread.

#include <IndexedEntryRecord.h>

Inheritance diagram for Cpl::Persistent::IndexedEntryRecord:

[legend]

Collaboration diagram for Cpl::Persistent::IndexedEntryRecord:

[legend]

Public Member Functions
	IndexedEntryRecord (Chunk &entryChunkHandler, size_t singleEntrySizeInBytes, RegionMedia &entryRegion, IndexRecord &secondaryRecord, Cpl::Dm::Mp::Uint64 &mpForLatestIndexValue) noexcept
	Constructor.

void	start (Cpl::Dm::MailboxServer &myMbox) noexcept
	See Cpl::Persistent::Record.

void	stop () noexcept
	See Cpl::Persistent::Record.

size_t	getData (void *dst, size_t maxDstLen) noexcept
	See Cpl::Persistent::Payload (this is for 'entry' payload)

bool	putData (const void *src, size_t srcLen) noexcept
	See Cpl::Persistent::Payload (this is for 'entry' payload)

bool	processNoValidData () noexcept
	See Cpl::Persistent::DataRecord.

bool	addEntry (const Payload &src) noexcept
	See Cpl::Persistent::IndexedEntryWriter.

bool	clearAllEntries () noexcept
	See Cpl::Persistent::IndexedEntryWriter.

bool	getLatest (Payload &dst, IndexedEntryReader::EntryMarker_T &entryMarker) noexcept
	See Cpl::Persistent::IndexedEntryReader.

bool	getNext (uint64_t newerThan, const IndexedEntryReader::EntryMarker_T beginHereMarker, Payload &dst, IndexedEntryReader::EntryMarker_T &entryMarker) noexcept
	See Cpl::Persistent::IndexedEntryReader.

bool	getPrevious (uint64_t olderThan, const IndexedEntryReader::EntryMarker_T beginHereMarker, Payload &dst, IndexedEntryReader::EntryMarker_T &entryMarker) noexcept
	See Cpl::Persistent::IndexedEntryReader.

bool	getByBufferIndex (size_t bufferIndex, Payload &dst, IndexedEntryReader::EntryMarker_T &entryMarker) noexcept
	See Cpl::Persistent::IndexedEntryReader.

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

size_t	getMetadataLength () const noexcept
	Helper method: returns the size of 'meta-data' that is added to entry.

Public Member Functions inherited from Cpl::Persistent::DataRecord
	DataRecord (Cpl::Persistent::Chunk &chunkHandler) noexcept
	Constructor.

	~DataRecord ()
	Destructor.

virtual bool	writeToMedia (size_t index=0) noexcept
	This method is used by the application to write the DataRecord's data to persistent storage.

virtual bool	readFromMedia (size_t index=0) noexcept
	This method is used by the application to read the DataRecord's data from persistent storage.

Public Member Functions inherited from Cpl::Persistent::Record
virtual	~Record ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Persistent::Payload
virtual	~Payload ()
	Virtual destructor.

Protected Member Functions
void	verifyIndex () noexcept
	Helper method: Verifies the 'correctness' of the index/head pointer and 'fixes' the head pointer if it is 'bad'.

void	scanAllEntries ()
	Helper method: scans all of the 'flash' and returns the newest value found. If no valid entries found - everything is set to zero.

size_t	incrementOffset (size_t offsetToIncrement) const noexcept
	Helper method: 'increments' the offset by the size of entry (and handles the 'roll-over' case)

size_t	decrementOffset (size_t offsetToDecrement) const noexcept
	Helper method: 'decrements' the offset by the size of entry (and handles the 'roll-over' case)

bool	getByOffset (size_t offset, Payload &dst, IndexedEntryReader::EntryMarker_T &entryMarker) noexcept
	Helper method: get an entry by its offset.

Protected Attributes
uint64_t	m_latestTimestamp
	Index value of the latest record.

uint64_t	m_entryTimestamp
	Index value to store/push when reading/writing an entry to persistent storage.

Cpl::Dm::Mp::Uint64 &	m_mpIndex
	Model point to report out the Newest index value.

IndexRecord &	m_indexRecord
	Index record for storing head/tail pointers.

RegionMedia &	m_entryRegion
	Handle the region used for the entries.

Payload *	m_entryPayloadHandlerPtr
	Application specific Payload handler for an entry.

size_t	m_entrySize
	Size, in bytes, of individual Entry.

size_t	m_maxEntries
	Maximum number of entry that can be stored in the allocated space.

size_t	m_maxOffset
	The maximum offset value that can be used to store entry without exceeded the allocate entry space.

size_t	m_latestOffset
	Offset of the latest record.

Protected Attributes inherited from Cpl::Persistent::DataRecord
Cpl::Persistent::Chunk &	m_chunkHandler
	Chunk handler for the DataRecord.

bool	m_started
	Remember my started state.

Constructor & Destructor Documentation

◆ IndexedEntryRecord()

Cpl::Persistent::IndexedEntryRecord::IndexedEntryRecord	(	Chunk &	entryChunkHandler,
		size_t	singleEntrySizeInBytes,
		RegionMedia &	entryRegion,
		IndexRecord &	secondaryRecord,
		Cpl::Dm::Mp::Uint64 &	mpForLatestIndexValue
	)

noexcept

Constructor.

Member Function Documentation

◆ addEntry()

bool Cpl::Persistent::IndexedEntryRecord::addEntry ( const Payload & src )

noexcept

See Cpl::Persistent::IndexedEntryWriter.

◆ clearAllEntries()

bool Cpl::Persistent::IndexedEntryRecord::clearAllEntries ( )

noexcept

See Cpl::Persistent::IndexedEntryWriter.

◆ decrementOffset()

size_t Cpl::Persistent::IndexedEntryRecord::decrementOffset ( size_t offsetToDecrement ) const

protectednoexcept

Helper method: 'decrements' the offset by the size of entry (and handles the 'roll-over' case)

◆ getByBufferIndex()

bool Cpl::Persistent::IndexedEntryRecord::getByBufferIndex	(	size_t	bufferIndex,
		Payload &	dst,
		IndexedEntryReader::EntryMarker_T &	entryMarker
	)

noexcept

See Cpl::Persistent::IndexedEntryReader.

◆ getByOffset()

bool Cpl::Persistent::IndexedEntryRecord::getByOffset	(	size_t	offset,
		Payload &	dst,
		IndexedEntryReader::EntryMarker_T &	entryMarker
	)

protectednoexcept

Helper method: get an entry by its offset.

◆ getData()

size_t Cpl::Persistent::IndexedEntryRecord::getData	(	void *	dst,
		size_t	maxDstLen
	)

virtualnoexcept

See Cpl::Persistent::Payload (this is for 'entry' payload)

Implements Cpl::Persistent::Payload.

◆ getLatest()

bool Cpl::Persistent::IndexedEntryRecord::getLatest	(	Payload &	dst,
		IndexedEntryReader::EntryMarker_T &	entryMarker
	)

noexcept

See Cpl::Persistent::IndexedEntryReader.

◆ getMaxIndex()

size_t Cpl::Persistent::IndexedEntryRecord::getMaxIndex ( ) const

noexcept

See Cpl::Persistent::IndexedEntryReader.

◆ getMetadataLength()

size_t Cpl::Persistent::IndexedEntryRecord::getMetadataLength ( ) const

noexcept

Helper method: returns the size of 'meta-data' that is added to entry.

◆ getNext()

bool Cpl::Persistent::IndexedEntryRecord::getNext	(	uint64_t	newerThan,
		const IndexedEntryReader::EntryMarker_T	beginHereMarker,
		Payload &	dst,
		IndexedEntryReader::EntryMarker_T &	entryMarker
	)

noexcept

See Cpl::Persistent::IndexedEntryReader.

◆ getPrevious()

bool Cpl::Persistent::IndexedEntryRecord::getPrevious	(	uint64_t	olderThan,
		const IndexedEntryReader::EntryMarker_T	beginHereMarker,
		Payload &	dst,
		IndexedEntryReader::EntryMarker_T &	entryMarker
	)

noexcept

See Cpl::Persistent::IndexedEntryReader.

◆ incrementOffset()

size_t Cpl::Persistent::IndexedEntryRecord::incrementOffset ( size_t offsetToIncrement ) const

protectednoexcept

Helper method: 'increments' the offset by the size of entry (and handles the 'roll-over' case)

◆ processNoValidData()

bool Cpl::Persistent::IndexedEntryRecord::processNoValidData ( )

virtualnoexcept

See Cpl::Persistent::DataRecord.

Implements Cpl::Persistent::DataRecord.

◆ putData()

bool Cpl::Persistent::IndexedEntryRecord::putData	(	const void *	src,
		size_t	srcLen
	)

virtualnoexcept

See Cpl::Persistent::Payload (this is for 'entry' payload)

Implements Cpl::Persistent::Payload.

◆ scanAllEntries()

void Cpl::Persistent::IndexedEntryRecord::scanAllEntries ( )

protected

Helper method: scans all of the 'flash' and returns the newest value found. If no valid entries found - everything is set to zero.

◆ start()

void Cpl::Persistent::IndexedEntryRecord::start ( Cpl::Dm::MailboxServer & myMbox )

virtualnoexcept

See Cpl::Persistent::Record.

Reimplemented from Cpl::Persistent::DataRecord.

◆ stop()

void Cpl::Persistent::IndexedEntryRecord::stop ( )

virtualnoexcept

See Cpl::Persistent::Record.

Reimplemented from Cpl::Persistent::DataRecord.

◆ verifyIndex()

void Cpl::Persistent::IndexedEntryRecord::verifyIndex ( )

protectednoexcept

Helper method: Verifies the 'correctness' of the index/head pointer and 'fixes' the head pointer if it is 'bad'.

Member Data Documentation

◆ m_entryPayloadHandlerPtr

Payload* Cpl::Persistent::IndexedEntryRecord::m_entryPayloadHandlerPtr

protected

Application specific Payload handler for an entry.

◆ m_entryRegion

RegionMedia& Cpl::Persistent::IndexedEntryRecord::m_entryRegion

protected

Handle the region used for the entries.

◆ m_entrySize

size_t Cpl::Persistent::IndexedEntryRecord::m_entrySize

protected

Size, in bytes, of individual Entry.

◆ m_entryTimestamp

uint64_t Cpl::Persistent::IndexedEntryRecord::m_entryTimestamp

protected

Index value to store/push when reading/writing an entry to persistent storage.

◆ m_indexRecord

IndexRecord& Cpl::Persistent::IndexedEntryRecord::m_indexRecord

protected

Index record for storing head/tail pointers.

◆ m_latestOffset

size_t Cpl::Persistent::IndexedEntryRecord::m_latestOffset

protected

Offset of the latest record.

◆ m_latestTimestamp

uint64_t Cpl::Persistent::IndexedEntryRecord::m_latestTimestamp

protected

Index value of the latest record.

◆ m_maxEntries

size_t Cpl::Persistent::IndexedEntryRecord::m_maxEntries

protected

Maximum number of entry that can be stored in the allocated space.

◆ m_maxOffset

size_t Cpl::Persistent::IndexedEntryRecord::m_maxOffset

protected

The maximum offset value that can be used to store entry without exceeded the allocate entry space.

◆ m_mpIndex

Cpl::Dm::Mp::Uint64& Cpl::Persistent::IndexedEntryRecord::m_mpIndex

protected

Model point to report out the Newest index value.

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

Cpl/Persistent/IndexedEntryRecord.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ IndexedEntryRecord()

Member Function Documentation

◆ addEntry()

◆ clearAllEntries()

◆ decrementOffset()

◆ getByBufferIndex()

◆ getByOffset()

◆ getData()

◆ getLatest()

◆ getMaxIndex()

◆ getMetadataLength()

◆ getNext()

◆ getPrevious()

◆ incrementOffset()

◆ processNoValidData()

◆ putData()

◆ scanAllEntries()

◆ start()

◆ stop()

◆ verifyIndex()

Member Data Documentation

◆ m_entryPayloadHandlerPtr

◆ m_entryRegion

◆ m_entrySize

◆ m_entryTimestamp

◆ m_indexRecord

◆ m_latestOffset

◆ m_latestTimestamp

◆ m_maxEntries

◆ m_maxOffset

◆ m_mpIndex