rad 6.2.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
rad::TrsHealth Class Reference

Adapter for ptpmond's TRS Health status to the state machine. More...

#include <trsHealth.hpp>

Inheritance diagram for rad::TrsHealth:

Public Member Functions

 TrsHealth (boost::asio::io_context &ioc, SMAdapter &sm, const std::string_view path=ptpmon::DEFAULT_SOCKET_PATH)
 Register callbacks and start connecting to the ptpmond socket.
 
virtual ~TrsHealth ()=default
 
 TrsHealth (const TrsHealth &)=delete
 
TrsHealthoperator= (const TrsHealth &)=delete
 
 TrsHealth (TrsHealth &&)=default
 
TrsHealthoperator= (TrsHealth &&)=default
 
const ptpmon::StatusMessage & GetStatus () const
 Retrieve the most recent status.
 
void Enable ()
 Enable TRS health status notification.
 
void Disable ()
 Disable TRS health status notification.
 

Protected Member Functions

void Notify (const ptpmon::StatusMessage &status) override
 

Detailed Description

Adapter for ptpmond's TRS Health status to the state machine.

Constructor & Destructor Documentation

◆ TrsHealth() [1/3]

rad::TrsHealth::TrsHealth ( boost::asio::io_context & ioc,
SMAdapter & sm,
const std::string_view path = ptpmon::DEFAULT_SOCKET_PATH )
explicit

Register callbacks and start connecting to the ptpmond socket.

Parameters
iocBoost.Asio context for callback registration
smthe state machine to post events to
paththe UNIX socket address of the ptpmond server
Exceptions
std::runtime_errorif good or @bad are missing

◆ ~TrsHealth()

virtual rad::TrsHealth::~TrsHealth ( )
virtualdefault

◆ TrsHealth() [2/3]

rad::TrsHealth::TrsHealth ( const TrsHealth & )
delete

◆ TrsHealth() [3/3]

rad::TrsHealth::TrsHealth ( TrsHealth && )
default

Member Function Documentation

◆ Disable()

void rad::TrsHealth::Disable ( )

Disable TRS health status notification.

◆ Enable()

void rad::TrsHealth::Enable ( )

Enable TRS health status notification.

◆ GetStatus()

const ptpmon::StatusMessage & rad::TrsHealth::GetStatus ( ) const

Retrieve the most recent status.

◆ Notify()

void rad::TrsHealth::Notify ( const ptpmon::StatusMessage & status)
overrideprotected

◆ operator=() [1/2]

TrsHealth & rad::TrsHealth::operator= ( const TrsHealth & )
delete

◆ operator=() [2/2]

TrsHealth & rad::TrsHealth::operator= ( TrsHealth && )
default

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