Cpl::Persistent::CrcChunk Class Reference

This concrete class implements the Chunk interface by using a 32Bit CRC for ensuring data integrity. More...

Detailed Description

This concrete class implements the Chunk interface by using a 32Bit CRC for ensuring data integrity.

#include <CrcChunk.h>

Inheritance diagram for Cpl::Persistent::CrcChunk:

Collaboration diagram for Cpl::Persistent::CrcChunk:

Public Member Functions
	CrcChunk (RegionMedia &region)
	Constructor.
void	start (Cpl::Dm::MailboxServer &myMbox) noexcept
	See Cpl::Persistent::Chunk.
void	stop () noexcept
	See Cpl::Persistent::Chunk.
bool	loadData (Payload &dstHandler, size_t index=0) noexcept
	See Cpl::Persistent::Chunk.
bool	updateData (Payload &srcHandler, size_t index=0, bool invalidate=false) noexcept
	See Cpl::Persistent::Chunk.
size_t	getMetadataLength () const noexcept
	See Cpl::Persistent::Chunk.
Public Member Functions inherited from Cpl::Persistent::Chunk
virtual	~Chunk ()
	Virtual destructor.

Static Public Attributes
static constexpr size_t	FRAME_OFFSET_DATA = sizeof( size_t )
	Start of data (aka overhead length)
static constexpr size_t	CRC_SIZE = sizeof( uint32_t )
	The size of the CRC.
static constexpr size_t	FRAME_OVERHEAD = FRAME_OFFSET_DATA + CRC_SIZE
	Total overhead size.

Protected Member Functions
virtual bool	pushToRecord (Payload &dstHandler)
	Helper method. Encapsulates pushing data to the record.
virtual size_t	pullFromRecord (Payload &srcHandler)
	Helper method. Encapsulates retrieving data from the record. Returns the length of the data.
virtual void	reset ()
	Helper method. Encapsulates actions that occur when there is NO VALID data.

Protected Attributes
RegionMedia &	m_region
	Region/Media.
size_t	m_dataLen
	Data Length for the record.

Constructor & Destructor Documentation

CrcChunk()

Cpl::Persistent::CrcChunk::CrcChunk

(

RegionMedia &

region

)

Constructor.

Member Function Documentation

getMetadataLength()

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

virtualnoexcept

See Cpl::Persistent::Chunk.

Implements Cpl::Persistent::Chunk.

loadData()

bool Cpl::Persistent::CrcChunk::loadData ( Payload &  dstHandler, size_t  index = 0  )

virtualnoexcept

See Cpl::Persistent::Chunk.

Implements Cpl::Persistent::Chunk.

pullFromRecord()

virtual size_t Cpl::Persistent::CrcChunk::pullFromRecord ( Payload &  srcHandler )

protectedvirtual

Helper method. Encapsulates retrieving data from the record. Returns the length of the data.

pushToRecord()

virtual bool Cpl::Persistent::CrcChunk::pushToRecord ( Payload &  dstHandler )

protectedvirtual

Helper method. Encapsulates pushing data to the record.

reset()

virtual void Cpl::Persistent::CrcChunk::reset ( )

protectedvirtual

Helper method. Encapsulates actions that occur when there is NO VALID data.

start()

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

virtualnoexcept

See Cpl::Persistent::Chunk.

Implements Cpl::Persistent::Chunk.

stop()

void Cpl::Persistent::CrcChunk::stop ( )

virtualnoexcept

See Cpl::Persistent::Chunk.

Implements Cpl::Persistent::Chunk.

updateData()

bool Cpl::Persistent::CrcChunk::updateData ( Payload &  srcHandler, size_t  index = 0, bool  invalidate = false  )

virtualnoexcept

See Cpl::Persistent::Chunk.

Implements Cpl::Persistent::Chunk.

Member Data Documentation

CRC_SIZE

constexpr size_t Cpl::Persistent::CrcChunk::CRC_SIZE = sizeof( uint32_t )

staticconstexpr

The size of the CRC.

FRAME_OFFSET_DATA

constexpr size_t Cpl::Persistent::CrcChunk::FRAME_OFFSET_DATA = sizeof( size_t )

staticconstexpr

Start of data (aka overhead length)

FRAME_OVERHEAD

constexpr size_t Cpl::Persistent::CrcChunk::FRAME_OVERHEAD = FRAME_OFFSET_DATA + CRC_SIZE

staticconstexpr

Total overhead size.

m_dataLen

size_t Cpl::Persistent::CrcChunk::m_dataLen

protected

Data Length for the record.

m_region

RegionMedia& Cpl::Persistent::CrcChunk::m_region

protected

Region/Media.

---

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

• Cpl/Persistent/CrcChunk.h