This abstract class defines interface for appending a single 'entry' to a a collection of entries (i.e. More...

Detailed Description

This abstract class defines interface for appending a single 'entry' to a a collection of entries (i.e.

From a logical perspective, 'entries' are stored in a Ring Buffer and when the buffer is full, the oldest entries are overwritten.

Each entry that is stored has an 'index' value associated with it. This 'index' is used to uniquely identify each entry (even across overwritten entries) and it is used to identify the relative age between the entries.

NOTE: The max length entries (for a given IndexEntryRecord) IS a single fixed length. An 'unused' bytes/space are padded with zeros.

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

#include <IndexedEntryWriter.h>

Public Member Functions
virtual bool	addEntry (const Payload &src) noexcept=0
	This method appends entry to the list of Indexed Entries.

virtual bool	clearAllEntries () noexcept=0
	This method will 'clear' (i.e.

virtual	~IndexedEntryWriter ()
	Virtual destructor.

Constructor & Destructor Documentation

◆ ~IndexedEntryWriter()

virtual Cpl::Persistent::IndexedEntryWriter::~IndexedEntryWriter ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ addEntry()

virtual bool Cpl::Persistent::IndexedEntryWriter::addEntry ( const Payload & src )

pure virtualnoexcept

This method appends entry to the list of Indexed Entries.

The method is synchronous in that the method does not return until the entry has been 'written' the persistent media.

Returns true on success; else if an error occurred (e.g. IO error while writing) false is returned.

◆ clearAllEntries()

virtual bool Cpl::Persistent::IndexedEntryWriter::clearAllEntries ( )

pure virtualnoexcept

This method will 'clear' (i.e.

invalidate) ALL entries in persistent storage.

CAUTION: With great power comes, comes great responsibility!

Returns true when successful; else false is returned. When false is returned that state of 'entries' in persistent storage is undetermined.

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