openjaus::core::services::LivenessSettings Class Reference

Encapsulates the configuration settings needed by the Liveness service. More...

#include <LivenessSettings.h>

Inherits openjaus::core::services::LivenessSettingsInterface.

Public Member Functions
virtual	~LivenessSettings ()
bool	isEnabled ()
HeartbeatMethod	getHeartbeatMethod ()
int	getHeartbeatInterval_sec ()
bool	broadcastShutdownIsEnabled ()
bool	timeoutIsEnabled ()
int	getLivenessTimeout_sec ()
Public Member Functions inherited from openjaus::core::services::LivenessSettingsInterface
	LivenessSettingsInterface ()
virtual	~LivenessSettingsInterface ()

Static Public Member Functions
static LivenessSettings *	loadFromConfFile (model::ComponentInfo *const component)

Private Member Functions
	LivenessSettings (model::ComponentInfo *const component)
void	verify ()

Static Private Member Functions
static HeartbeatMethod	loadHeartbeatMethod (std::string name)

Private Attributes
model::ComponentInfo *	component
bool	enabled
HeartbeatMethod	heartbeatMethod
int	heartbeatInterval_sec
bool	broadcastShutdownEnabled
int	livenessTimeout_sec
bool	timeoutEnabled

Additional Inherited Members
Public Types inherited from openjaus::core::services::LivenessSettingsInterface
enum	HeartbeatMethod { NONE, BROADCAST }

Detailed Description

Constructor & Destructor Documentation

~LivenessSettings()

openjaus::core::services::LivenessSettings::~LivenessSettings ( )

virtual

LivenessSettings()

openjaus::core::services::LivenessSettings::LivenessSettings ( model::ComponentInfo *const  component )

private

Member Function Documentation

broadcastShutdownIsEnabled()

bool openjaus::core::services::LivenessSettings::broadcastShutdownIsEnabled ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

getHeartbeatInterval_sec()

int openjaus::core::services::LivenessSettings::getHeartbeatInterval_sec ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

getHeartbeatMethod()

LivenessSettings::HeartbeatMethod openjaus::core::services::LivenessSettings::getHeartbeatMethod ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

getLivenessTimeout_sec()

int openjaus::core::services::LivenessSettings::getLivenessTimeout_sec ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

isEnabled()

bool openjaus::core::services::LivenessSettings::isEnabled ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

loadFromConfFile()

LivenessSettings * openjaus::core::services::LivenessSettings::loadFromConfFile ( model::ComponentInfo *const  component )

static

loadHeartbeatMethod()

LivenessSettings::HeartbeatMethod openjaus::core::services::LivenessSettings::loadHeartbeatMethod ( std::string  name )

staticprivate

timeoutIsEnabled()

bool openjaus::core::services::LivenessSettings::timeoutIsEnabled ( )

virtual

Implements openjaus::core::services::LivenessSettingsInterface.

verify()

void openjaus::core::services::LivenessSettings::verify ( )

private

Member Data Documentation

broadcastShutdownEnabled

bool openjaus::core::services::LivenessSettings::broadcastShutdownEnabled

private

component

model::ComponentInfo* openjaus::core::services::LivenessSettings::component

private

enabled

bool openjaus::core::services::LivenessSettings::enabled

private

heartbeatInterval_sec

int openjaus::core::services::LivenessSettings::heartbeatInterval_sec

private

heartbeatMethod

HeartbeatMethod openjaus::core::services::LivenessSettings::heartbeatMethod

private

livenessTimeout_sec

int openjaus::core::services::LivenessSettings::livenessTimeout_sec

private

timeoutEnabled

bool openjaus::core::services::LivenessSettings::timeoutEnabled

private

---

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

• include/openjaus/core/Services/Settings/LivenessSettings.h
• src/openjaus/core/Services/Settings/LivenessSettings.cpp