GM6000 Digital Heater Controller Branch: main
SDX-1330
List of all members | Classes | Public Types | Public Member Functions
Cpl::Itc::AtomicRequest< ACCESS_API > Class Template Reference

This concrete class define the 'Atomic' Message request that allows a client to invoke multiple operation on a server/service as one single atomic operation. More...

Detailed Description

template<class ACCESS_API>
class Cpl::Itc::AtomicRequest< ACCESS_API >

This concrete class define the 'Atomic' Message request that allows a client to invoke multiple operation on a server/service as one single atomic operation.

The server typically inherits this class and implements the 'ACCESS_API'. The client is responsible for implementing the AtomicCallback interface.

TEMPLATE ARGS: ACCESS_API - API that the client uses to accomplish its "Atomic Operation"

#include <AtomicRequest.h>

Inheritance diagram for Cpl::Itc::AtomicRequest< ACCESS_API >:
[legend]
Collaboration diagram for Cpl::Itc::AtomicRequest< ACCESS_API >:
[legend]

Classes

class  Payload
 Payload for Message. More...
 

Public Types

typedef Cpl::Itc::SAP< Cpl::Itc::AtomicRequest< ACCESS_API > > SAP
 SAP for this API.
 
typedef RequestMessage< AtomicRequest, PayloadReqMsg
 Message Type:
 

Public Member Functions

virtual void request (ReqMsg &msg)
 Request.
 

Member Typedef Documentation

◆ ReqMsg

template<class ACCESS_API >
typedef RequestMessage<AtomicRequest, Payload> Cpl::Itc::AtomicRequest< ACCESS_API >::ReqMsg

◆ SAP

template<class ACCESS_API >
typedef Cpl::Itc::SAP< Cpl::Itc::AtomicRequest<ACCESS_API> > Cpl::Itc::AtomicRequest< ACCESS_API >::SAP

SAP for this API.

Member Function Documentation

◆ request()

template<class ACCESS_API >
virtual void Cpl::Itc::AtomicRequest< ACCESS_API >::request ( ReqMsg msg)
inlinevirtual

Request.


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