GM6000 Digital Heater Controller Branch: main
SDX-1330
List of all members | Classes | Public Types | Public Member Functions
Cpl::Dm::Persistent::EraseRequest Class Referenceabstract

This abstract class define ITC message type and payload for the application to request invalidating/corrupting the Record in persistent storage (i.e. More...

Detailed Description

This abstract class define ITC message type and payload for the application to request invalidating/corrupting the Record in persistent storage (i.e.

logically erase the record in persistent storage)

See the Cpl/Itc/README.txt file for the semantics for the 'ownership' of the payload contents.

NOTE: This interface can/should NOT be used synchronously. The application is required to only use asynchronous semantics.

#include <EraseRequest.h>

Inheritance diagram for Cpl::Dm::Persistent::EraseRequest:
[legend]

Classes

class  Payload
 Payload for Message. More...
 

Public Types

typedef Cpl::Itc::SAP< EraseRequestSAP
 SAP for this API.
 
typedef Cpl::Itc::RequestMessage< EraseRequest, PayloadEraseMsg
 Message Type:
 

Public Member Functions

virtual void request (EraseMsg &msg)=0
 Request: Erase message.
 
virtual ~EraseRequest ()
 Virtual Destructor.
 

Member Typedef Documentation

◆ EraseMsg

Message Type:

◆ SAP

SAP for this API.

Constructor & Destructor Documentation

◆ ~EraseRequest()

virtual Cpl::Dm::Persistent::EraseRequest::~EraseRequest ( )
inlinevirtual

Virtual Destructor.

Member Function Documentation

◆ request()

virtual void Cpl::Dm::Persistent::EraseRequest::request ( EraseMsg msg)
pure virtual

Request: Erase message.

Implemented in Cpl::Dm::Persistent::Record.


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