Svc::HealthImpl Class Reference

Health component implementation class. More...

#include <Svc/Health/HealthComponentImpl.hpp>

Inheritance diagram for Svc::HealthImpl:

Classes
struct	PingEntry
	struct for ping entry More...

Public Member Functions
	HealthImpl (const char *const compName)
	HealthImpl constructor.
void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)
	HealthImpl initialization function.
void	setPingEntries (PingEntry *pingEntries, NATIVE_INT_TYPE numPingEntries, U32 watchDogCode)
	Set ping entry tables.
	~HealthImpl ()
	Component destructor.

Protected Member Functions
virtual void	doOtherChecks ()
	additional checks function

Detailed Description

Health component implementation class.

The health component iterates through each entry in its table and checks its status. If a ping entry tracker is enabled, it will ping its corresponding port with a provided key. If a ping return is outstanding, a counter is decremented, and its value is checked against warning and fault thresholds. A watchdog is always stroked in the run handler.

Definition at line 32 of file HealthComponentImpl.hpp.

Constructor & Destructor Documentation

HealthImpl()

Svc::HealthImpl::HealthImpl

(

const char *const

compName

)

HealthImpl constructor.

The constructor for Health

Parameters

compName

component name

Definition at line 23 of file HealthComponentImpl.cpp.

~HealthImpl()

Svc::HealthImpl::~HealthImpl

(

)

Component destructor.

The destructor for HealthImpl is empty

Definition at line 64 of file HealthComponentImpl.cpp.

Member Function Documentation

doOtherChecks()

void Svc::HealthImpl::doOtherChecks ( )

protectedvirtual

additional checks function

Does additional checks based on the platform

Definition at line 24 of file HealthComponentStubChecks.cpp.

init()

void Svc::HealthImpl::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance
	)

HealthImpl initialization function.

Initializes the autocoded base class, ping table, and data members

Parameters

queueDepth	Depth of queue
instance	The instance number

Definition at line 39 of file HealthComponentImpl.cpp.

setPingEntries()

void Svc::HealthImpl::setPingEntries	(	PingEntry *	pingEntries,
		NATIVE_INT_TYPE	numPingEntries,
		U32	watchDogCode
	)

Set ping entry tables.

Provides a table of ping entries

Parameters

pingEntries	Pointer to provided ping table entries
numPingEntries	Number of ping entries in table
watchDogCode	Value that is sent to watchdog

Definition at line 45 of file HealthComponentImpl.cpp.

---

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

• Svc/Health/HealthComponentImpl.hpp
• Svc/Health/HealthComponentImpl.cpp
• Svc/Health/Stub/HealthComponentStubChecks.cpp
• Svc/Health/VxWorks/HealthComponentVxWorksChecks.cpp