---

SubsystemMonitor::Statistic Class Reference

#include <Statistic.h>

List of all members.

Public Methods
virtual	~Statistic ()
virtual int	readValue (rmValue *a_value, time_t a_timestamp)=0
	returns the value of the statistic this class was created with. More...
virtual int	resetCounterValue (rmValue *val)
	sets a counter value to val. More...
virtual int	getUpperBound (rmValue *a_value)
	returns the upper bound of the gauge statistic this class was created with. More...

---

Detailed Description

Statistic class contains methods for accessing the subsystem's statistics. This class is required by the resource monitor daemon.

See also:

SubsystemMonitor for debug note.

---

Constructor & Destructor Documentation

SubsystemMonitor::Statistic::~Statistic ( ) [inline, virtual]

---

Member Function Documentation

int SubsystemMonitor::Statistic::getUpperBound ( rmValue * a_value ) [virtual]

returns the upper bound of the gauge statistic this class was created with. Parameters: a_value   pointer the value container. Returns: errno value that is passed on to the client application. ENOSYS is returned from the base class when the derived class does not implement this optional method. See also: ResourceMonitor::rmGetUpperBound

int SubsystemMonitor::Statistic::readValue ( rmValue * a_value, time_t a_timestamp ) [pure virtual]

returns the value of the statistic this class was created with. Parameters: a_value   pointer the value container. a_timestamp   the current time the resource monitor is gathering statistics. If the subsystem obtains multiple statistics with a single set of system calls, these values can be cached by the subsystem. All calls to readValue() with the same a_timestamp value can return values from the same cache of statistics. When a_timestamp is 0, the subsystem can not use its cache. Returns: errno value that is passed on to the client application. See also: ResourceMonitor::rmGetCurrentValue

int SubsystemMonitor::Statistic::resetCounterValue ( rmValue * val ) [virtual]

sets a counter value to val. Parameters: val   pointer the container of the new value. Returns: errno value that is passed on to the client application. ENOSYS is returned from the base class when the derived class does not implement this optional method. See also: ResourceMonitor::rmResetCounterStatistic Note: EINVAL should be returned if the counter can not be reset to val. Hardware maintained statistics usually can only be reset to zero.

---

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

• /root/resourcemonitord/resourcemonitord/Statistic.h

---