Cpl::Persistent::FileAdapter Class Reference

This concrete class implements the RegionMedia interface using the Cpl::Io::File interfaces. More...

Detailed Description

This concrete class implements the RegionMedia interface using the Cpl::Io::File interfaces.

Each instance of this class uses a single file as the storage media. It is the responsibility of the application to ensure that each instance has a unique file name

#include <FileAdapter.h>

Inheritance diagram for Cpl::Persistent::FileAdapter:

Collaboration diagram for Cpl::Persistent::FileAdapter:

Public Member Functions
	FileAdapter (const char *fileName, size_t regionStartAddress, size_t regionLen) noexcept
	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.

Protected Attributes
const char *	m_fileName
	Remember my file name.
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.

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.

Constructor & Destructor Documentation

FileAdapter()

Cpl::Persistent::FileAdapter::FileAdapter ( const char *  fileName, size_t  regionStartAddress, size_t  regionLen  )

noexcept

Constructor.

Member Function Documentation

read()

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

virtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

start()

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

virtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

stop()

void Cpl::Persistent::FileAdapter::stop ( )

virtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

write()

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

virtualnoexcept

See Cpl::Persistent::RegionMedia.

Implements Cpl::Persistent::RegionMedia.

Member Data Documentation

m_fileName

const char* Cpl::Persistent::FileAdapter::m_fileName

protected

Remember my file name.

---

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

• Cpl/Persistent/FileAdapter.h