onboardapi  9.10.0
by Rheinmetall
M_Watchdog::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportWatchdogSettings (M_Watchdog::WatchdogSettingsType const &Settings)
 
virtual void ReportWatchStatus (std::string const &KeyWatchedClientId, std::string const &KeyAssociatedServiceName, M_Watchdog::WatchStatusType const &Status, bool IsRemoved)
 

Detailed Description

Watchdog client interface. Contains callback operations from the watchdog service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_Watchdog::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportWatchdogSettings()

void M_Watchdog::IClient::ReportWatchdogSettings ( M_Watchdog::WatchdogSettingsType const &  Settings)
virtual

Report watchdog static settings.

Parameters
SettingsWatchdog settings.

◆ ReportWatchStatus()

void M_Watchdog::IClient::ReportWatchStatus ( std::string const &  KeyWatchedClientId,
std::string const &  KeyAssociatedServiceName,
M_Watchdog::WatchStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report current status of specific watch.

Parameters
KeyWatchedClientIdIdentifies the client whose operations are to be watched.
KeyAssociatedServiceNameIdentifies the service name corresponding to the client that executes the operations to be watched.
StatusStatus of the specified client/service-mapped watch.
IsRemovedIndicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.