Cpl::Persistent::Record Class Reference

This abstract class defines the public interface for a Record instance. More...

Detailed Description

This abstract class defines the public interface for a Record instance.

A Record is the atomic-unit that is managed in Persistent storage media.

#include <Record.h>

Inheritance diagram for Cpl::Persistent::Record:

Public Member Functions
virtual void	start (Cpl::Dm::MailboxServer &myMbox) noexcept=0
	This method is to start/initialize the record.
virtual void	stop () noexcept=0
	This method is to stop/shutdown the record.
virtual	~Record ()
	Virtual destructor.

Constructor & Destructor Documentation

~Record()

virtual Cpl::Persistent::Record::~Record ( )

inlinevirtual

Virtual destructor.

Reimplemented in Cpl::Dm::Persistent::Record.

Member Function Documentation

start()

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

pure virtualnoexcept

This method is to start/initialize the record.

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 RecordServer is 'opened'.

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

Implemented in Cpl::Dm::Persistent::Record, Cpl::Persistent::DataRecord, Cpl::Persistent::IndexedEntryRecord, and Cpl::Persistent::IndexRecord.

stop()

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

pure virtualnoexcept

This method is to stop/shutdown the record.

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::Dm::Persistent::Record, Cpl::Persistent::DataRecord, Cpl::Persistent::IndexedEntryRecord, and Cpl::Persistent::IndexRecord.

---

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

• Cpl/Persistent/Record.h