Cpl::Persistent::RegionMedia Class Reference

This mostly abstract class defines the operations that can be performed on a persistent media. More...

Detailed Description

This mostly abstract class defines the operations that can be performed on a persistent media.

In addition there is concept of a persistent media being dividing into non-overlapping regions. Each Region has a starting offset, and length (in bytes) of the region. All read/write operations are relative the start of the region, i.e. offset zero is first byte of the region; offset 9 is the tenth byte in the region.

#include <RegionMedia.h>

Inheritance diagram for Cpl::Persistent::RegionMedia:

Public Member Functions
virtual void	start (Cpl::Dm::MailboxServer &myMbox) noexcept=0
	This method is to start/initialize the Region.
virtual void	stop () noexcept=0
	This method is to stop/shutdown the Region.
virtual bool	write (size_t offset, const void *srcData, size_t srcLen) noexcept=0
	This method writes 'srcLen' bytes to the media at the specified offset.
virtual size_t	read (size_t offset, void *dstBuffer, size_t bytesToRead) noexcept=0
	This method reads 'bytesToRead' bytes from the media at the specified offset.
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 Member Functions
	RegionMedia (size_t startAddress, size_t regionLength)
	Constructor. Note: A child class is required.

Protected Attributes
size_t	m_startAddress
	The Regions' starting address.
size_t	m_regionLength
	The length, in bytes, of the region.

Constructor & Destructor Documentation

~RegionMedia()

virtual Cpl::Persistent::RegionMedia::~RegionMedia ( )

inlinevirtual

Virtual destructor.

RegionMedia()

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

inlineprotected

Constructor. Note: A child class is required.

Member Function Documentation

getRegionLength()

virtual size_t Cpl::Persistent::RegionMedia::getRegionLength ( ) const

inlinevirtual

Returns the Region's length in bytes.

getStartAddress()

virtual size_t Cpl::Persistent::RegionMedia::getStartAddress ( ) const

inlinevirtual

Returns the Region's starting address.

read()

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

pure virtualnoexcept

This method reads 'bytesToRead' bytes from the media at the specified offset.

The offset is relative to the start of the Region's start address.

The method returns the number of bytes read. A return value of ZERO indicates that an error occurred.

Implemented in Cpl::Persistent::FileAdapter, Cpl::Persistent::NullRegionMedia, and Cpl::Persistent::NVAdapter.

start()

virtual void Cpl::Persistent::RegionMedia::start ( Cpl::Dm::MailboxServer &  myMbox )

pure virtualnoexcept

This method is to start/initialize the Region.

It is typically only called once at the startup of the application. However, start() can be called after a previous call to the stop() method.

This method is called when the corresponding Chunk instance is 'started'

The 'myMbox' is a reference to the RecordServer's ITC mailbox, i.e. the mailbox for the thread that the Record executes in. The 'myEventLoop' is a reference to the RecordServer's Event Loop.

Implemented in Cpl::Persistent::FileAdapter, Cpl::Persistent::NullRegionMedia, and Cpl::Persistent::NVAdapter.

stop()

virtual void Cpl::Persistent::RegionMedia::stop ( )

pure virtualnoexcept

This method is to stop/shutdown the Region.

It is typically only called once during an orderly shutdown of the application. However, start() can be after a previous call to the stop() method.

Implemented in Cpl::Persistent::FileAdapter, Cpl::Persistent::NullRegionMedia, and Cpl::Persistent::NVAdapter.

write()

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

pure virtualnoexcept

This method writes 'srcLen' bytes to the media at the specified offset.

The offset is relative to the start of the Region's start address.

The method return true of the write operation was successful, else false is returned.

Implemented in Cpl::Persistent::FileAdapter, Cpl::Persistent::NullRegionMedia, and Cpl::Persistent::NVAdapter.

Member Data Documentation

m_regionLength

size_t Cpl::Persistent::RegionMedia::m_regionLength

protected

The length, in bytes, of the region.

m_startAddress

size_t Cpl::Persistent::RegionMedia::m_startAddress

protected

The Regions' starting address.

---

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

• Cpl/Persistent/RegionMedia.h