Cpl::Persistent::DataRecord Class Reference

This mostly concrete class implements the Cpl::Persistent::DataRecord interface where a DataRecord instance contains an unmanaged data store. More...

Detailed Description

This mostly concrete class implements the Cpl::Persistent::DataRecord interface where a DataRecord instance contains an unmanaged data store.

A final child class is needed to provide the specifics of the 'data store' (i.e. implement the Cpl::Persistent::Payload interface).

The data is only read/written from Persistent storage 'on demand' from the application.

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

#include <DataRecord.h>

Inheritance diagram for Cpl::Persistent::DataRecord:

Collaboration diagram for Cpl::Persistent::DataRecord:

Public Member Functions
	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.
void	start (Cpl::Dm::MailboxServer &myMbox) noexcept
	See Cpl::Persistent::DataRecord.
void	stop () noexcept
	See Cpl::Persistent::DataRecord.
Public Member Functions inherited from Cpl::Persistent::Record
virtual	~Record ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Persistent::Payload
virtual size_t	getData (void *dst, size_t maxDstLen) noexcept=0
	This method returns a Record's data payload contents.
virtual bool	putData (const void *src, size_t srcLen) noexcept=0
	This method used to transfer persistently stored data into a Record.
virtual	~Payload ()
	Virtual destructor.

Protected Member Functions
virtual bool	processNoValidData () noexcept=0
	This method is responsible for updating the 'data store' in RAM to default values.

Protected Attributes
Cpl::Persistent::Chunk &	m_chunkHandler
	Chunk handler for the DataRecord.
bool	m_started
	Remember my started state.

Constructor & Destructor Documentation

DataRecord()

Cpl::Persistent::DataRecord::DataRecord ( Cpl::Persistent::Chunk &  chunkHandler )

noexcept

Constructor.

~DataRecord()

Cpl::Persistent::DataRecord::~DataRecord

(

)

Destructor.

Member Function Documentation

processNoValidData()

virtual bool Cpl::Persistent::DataRecord::processNoValidData ( )

protectedpure virtualnoexcept

This method is responsible for updating the 'data store' in RAM to default values.

This method is called when there is NO valid data when reading the record's data from persistence storage.

The method returns true if the 'data store' is in an acceptable state and the end of the call; else if there is error or there is no acceptable state of the 'data store' then false is returned

Implemented in Cpl::Persistent::IndexedEntryRecord, and Cpl::Persistent::IndexRecord.

readFromMedia()

virtual bool Cpl::Persistent::DataRecord::readFromMedia ( size_t  index = 0 )

virtualnoexcept

This method is used by the application to read the DataRecord's data from persistent storage.

Note: This method calls the DataRecord's putData() method with the data read from persistent storage.

The 'index' offset can be used to 'index into' the RegionMedia instead of starting at offset zero. This argument should only be used when multiple instances of a Record is being stored in a single region.

The method returns true on success; else false if an error occurred

NOTE: This method is NOT THREAD SAFE and should only be called from the Record Server's thread.

start()

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

virtualnoexcept

See Cpl::Persistent::DataRecord.

Implements Cpl::Persistent::Record.

Reimplemented in Cpl::Persistent::IndexedEntryRecord, and Cpl::Persistent::IndexRecord.

stop()

void Cpl::Persistent::DataRecord::stop ( )

virtualnoexcept

See Cpl::Persistent::DataRecord.

Implements Cpl::Persistent::Record.

Reimplemented in Cpl::Persistent::IndexedEntryRecord, and Cpl::Persistent::IndexRecord.

writeToMedia()

virtual bool Cpl::Persistent::DataRecord::writeToMedia ( size_t  index = 0 )

virtualnoexcept

This method is used by the application to write the DataRecord's data to persistent storage.

Note: This method calls the DataRecord's getData() method for the data to write to persistent storage.

The 'index' offset can be used to 'index into' the RegionMedia instead of starting at offset zero. This argument should only be used when multiple instances of a Record is being stored in a single region.

The method returns true on success; else false if an error occurred.

NOTE: This method is NOT THREAD SAFE and should only be called from the Record Server's thread.

Member Data Documentation

m_chunkHandler

Cpl::Persistent::Chunk& Cpl::Persistent::DataRecord::m_chunkHandler

protected

Chunk handler for the DataRecord.

m_started

bool Cpl::Persistent::DataRecord::m_started

protected

Remember my started state.

---

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

• Cpl/Persistent/DataRecord.h