Cpl::Persistent::NullRegionMedia Class Reference

This concrete class provides a 'null' implementation of the RegionMedia interface. More...

Detailed Description

This concrete class provides a 'null' implementation of the RegionMedia interface.

This class can be used to 'satisfy' persistent storage clients when there is no physical persistent storage available on the platform.

#include <NullRegionMedia.h>

Inheritance diagram for Cpl::Persistent::NullRegionMedia:

Collaboration diagram for Cpl::Persistent::NullRegionMedia:

Public Member Functions
	NullRegionMedia (size_t startAddress, size_t regionLength)
	Constructor.
void	start (Cpl::Dm::MailboxServer &myMbox) noexcept
	See Cpl::Persistent::RegionMedia.
void	stop () noexcept
	See Cpl::Persistent::RegionMedia.
bool	write (size_t offset, const void *srcData, size_t srcLen) noexcept
	See Cpl::Persistent::RegionMedia.
size_t	read (size_t offset, void *dstBuffer, size_t bytesToRead) noexcept
	See Cpl::Persistent::RegionMedia.
Public Member Functions inherited from Cpl::Persistent::RegionMedia
virtual size_t	getStartAddress () const
	Returns the Region's starting address.
virtual size_t	getRegionLength () const
	Returns the Region's length in bytes.
virtual	~RegionMedia ()
	Virtual destructor.

Additional Inherited Members
Protected Member Functions inherited from Cpl::Persistent::RegionMedia
	RegionMedia (size_t startAddress, size_t regionLength)
	Constructor. Note: A child class is required.
Protected Attributes inherited from Cpl::Persistent::RegionMedia
size_t	m_startAddress
	The Regions' starting address.
size_t	m_regionLength
	The length, in bytes, of the region.

Constructor & Destructor Documentation

NullRegionMedia()

Cpl::Persistent::NullRegionMedia::NullRegionMedia ( size_t  startAddress, size_t  regionLength  )

inline

Constructor.

Member Function Documentation

read()

size_t Cpl::Persistent::NullRegionMedia::read ( size_t  offset, void *  dstBuffer, size_t  bytesToRead  )

inlinevirtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

start()

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

inlinevirtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

stop()

void Cpl::Persistent::NullRegionMedia::stop ( )

inlinevirtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

write()

bool Cpl::Persistent::NullRegionMedia::write ( size_t  offset, const void *  srcData, size_t  srcLen  )

inlinevirtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

---

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

• Cpl/Persistent/NullRegionMedia.h