Cpl::Persistent Namespace Reference

The 'Persistent' namespace provides a basic persistent storage mechanism for non-volatile data. More...

Detailed Description

The 'Persistent' namespace provides a basic persistent storage mechanism for non-volatile data.

The persistent sub-system has the following features:

o The sub-system organizes persistent data into Records.  The 
  Application is responsible for defining what the data content of record. 
  It is the responsibility of the concrete Record instances to initiate 
  updates to the persistent media. A 'Record' is the unit of atomic 
  read/write operations from/to persistent storage.

o On start-up the Records are read and the concrete Record instances
  process the incoming data.

o All persistently stored data is CRC'd to detect data corruption. 
  Note: The CRCs are only validated on start-up. 

o Record instances are responsible for defaulting their data (and subsequently
  initiating an update to the persistent media) when the stored data
  has been detected as corrupt (i.e. bad CRC)

o The sub-system is independent of the physical persistent storage
  media 

o The Record Server can process an unlimited number of records.  It is 
  also okay to have more than one Record Server instance.

Threading Model: The Record Server is a runnable-object and/or a Data Model Mailbox, aka is a thread. All read/write operations to the persistent media are performed in this thread. It is assumed that the business logic for individual records is also performed in this thread - and that each record instance is thread safe with respect to the rest of the system.

Classes
class	Chunk
	This abstract class defines the interface for a Chunk. More...
class	ClearAllEntriesRequest
	This abstract class define ITC message type and payload for the application to clear/delete all entries. More...
class	ClearAllEntriesResponse
	This abstract class define ITC message type and payload for asynchronous response (to the application) of a ClearAllEntries message. More...
class	CrcChunk
	This concrete class implements the Chunk interface by using a 32Bit CRC for ensuring data integrity. More...
class	DataRecord
	This mostly concrete class implements the Cpl::Persistent::DataRecord interface where a DataRecord instance contains an unmanaged data store. More...
class	FileAdapter
	This concrete class implements the RegionMedia interface using the Cpl::Io::File interfaces. More...
class	GetByBufferIndexRequest
	This abstract class define ITC message type and payload for the application to request read Indexed Entry data. More...
class	GetByBufferIndexResponse
	This abstract class define ITC message type and payload for asynchronous response (to the application) of a GetByBufferIndex message. More...
class	GetLatestRequest
	This abstract class define ITC message type and payload for the application to request read Indexed Entry data. More...
class	GetLatestResponse
	This abstract class define ITC message type and payload for asynchronous response (to the application) of a GetLatest message. More...
class	GetNextRequest
	This abstract class define ITC message type and payload for the application to request read Indexed Entry data. More...
class	GetNextResponse
	This abstract class define ITC message type and payload for asynchronous response (to the application) of a GetNext message. More...
class	GetPreviousRequest
	This abstract class define ITC message type and payload for the application to request read Indexed Entry data. More...
class	GetPreviousResponse
	This abstract class define ITC message type and payload for asynchronous response (to the application) of a GetPrevious message. More...
class	IndexedEntryReader
	This abstract class defines interface for reading/retrieve 'entries' from a a collection of entries (i.e. More...
class	IndexedEntryRecord
	This concrete class implements the Cpl::Persistent::Record interface to store a collection 'entries'. More...
class	IndexedEntryServer
	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...
class	IndexedEntryWriter
	This abstract class defines interface for appending a single 'entry' to a a collection of entries (i.e. More...
class	IndexRecord
	This concrete class extends the Cpl::Persistent::DataRecord interface to store a latest/oldest 'record index' into a RegionMedia. More...
class	MirroredChunk
	This concrete class implements the Chunk interface by storing two copies of the Record's data. More...
class	NullRegionMedia
	This concrete class provides a 'null' implementation of the RegionMedia interface. More...
class	NVAdapter
	This concrete class implements the RegionMedia interface using the Driver::NV::Api interface. More...
class	Payload
	This abstract class defines the interface accessing the 'data payload' of an individual Record instance. More...
class	Record
	This abstract class defines the public interface for a Record instance. More...
class	RecordServer
	This concrete class provides an Event driven Runnable object for executing the read/write operation to persistent storage media for N Records. More...
class	RegionMedia
	This mostly abstract class defines the operations that can be performed on a persistent media. More...

Variables
uint8_t	g_workBuffer_ [OPTION_CPL_PERSISTENT_WORK_BUFFER_SIZE]
	This PACKAGE SCOPED buffer is a singleton that is available as 'work buffer' for Chunk and Record instance to use WHEN executing in the RecordServer's thread.

Variable Documentation

g_workBuffer_

uint8_t Cpl::Persistent::g_workBuffer_[OPTION_CPL_PERSISTENT_WORK_BUFFER_SIZE]

extern

This PACKAGE SCOPED buffer is a singleton that is available as 'work buffer' for Chunk and Record instance to use WHEN executing in the RecordServer's thread.