GM6000 Digital Heater Controller Branch: main
SDX-1330
List of all members | Public Member Functions
Cpl::Itc::CloseSync Class Reference

This partially concrete class implements the synchronous ITC close call for the CloseApi. More...

Detailed Description

This partially concrete class implements the synchronous ITC close call for the CloseApi.

The subclass is still required to implement the ITC request() method.

NOTE: This class is derived from OpenSync -->if you support a close(), call, you better have had an open() call.

#include <CloseSync.h>

Inheritance diagram for Cpl::Itc::CloseSync:
[legend]
Collaboration diagram for Cpl::Itc::CloseSync:
[legend]

Public Member Functions

 CloseSync (PostApi &myMbox) noexcept
 Constructor.
 
bool close (void *args=nullptr)
 See CloseSync.
 
- Public Member Functions inherited from Cpl::Itc::OpenSync
 OpenSync (PostApi &myMbox) noexcept
 Constructor.
 
bool open (void *args=nullptr)
 See OpenApi.
 
- Public Member Functions inherited from Cpl::Itc::OpenApi
virtual ~OpenApi ()
 Virtual destructor.
 
- Public Member Functions inherited from Cpl::Itc::OpenRequest
virtual void request (OpenMsg &msg)=0
 Request: Open.
 
- Public Member Functions inherited from Cpl::Itc::CloseApi
virtual ~CloseApi ()
 Virtual destructor.
 
- Public Member Functions inherited from Cpl::Itc::CloseRequest
virtual void request (CloseMsg &msg)=0
 Request: Close.
 

Additional Inherited Members

- Public Types inherited from Cpl::Itc::OpenRequest
typedef Cpl::Itc::SAP< OpenRequestSAP
 SAP for this API.
 
typedef RequestMessage< OpenRequest, OpenPayloadOpenMsg
 Message Type: Open.
 
- Public Types inherited from Cpl::Itc::CloseRequest
typedef Cpl::Itc::SAP< CloseRequestSAP
 SAP for this API.
 
typedef RequestMessage< CloseRequest, ClosePayloadCloseMsg
 Message Type: Close.
 
- Protected Attributes inherited from Cpl::Itc::OpenSync
PostApim_mbox
 Mailbox (of the server implementing the ITC request() method.
 

Constructor & Destructor Documentation

◆ CloseSync()

Cpl::Itc::CloseSync::CloseSync ( PostApi myMbox)
noexcept

Constructor.

Member Function Documentation

◆ close()

bool Cpl::Itc::CloseSync::close ( void *  args = nullptr)
virtual

See CloseSync.

Implements Cpl::Itc::CloseApi.


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