---

SubsystemMonitor::ISubsystemMonitor Class Reference

#include <ISubsystemMonitor.h>

List of all members.

Public Methods
virtual	~ISubsystemMonitor ()
virtual int	getSubsystemInterfaceVersion ()=0
	returns the interface version to the daemon. More...
virtual rmSubsystemInfo*	getSubsystemInfo ()=0
	this method the first call to the subsystem by the daemon process after successful subsystem registration. getSubsystemInfo() returns basic subsystem information. More...
virtual rmResourceInfo*	getResourceInfo (size_t index)=0
	is called by the daemon process after discovering the resource count in rmSubsystemInfo returned by getSubsystemInfo(). It is called noResources times incrementing the index for each call. rmResourceInfo() returns basic identification information about each resource. More...
virtual rmStatisticInfo*	getStatisticInfo (size_t index)=0
	is called by the daemon process after discovering the statistic count in rmSubsystemInfo returned by getSubsystemInfo(). It is called noStatistics times incrementing the index for each call. getStatisticInfo() returns basic identification information about each statistic. More...
virtual void	refreshSubsystemRegistration ()
	is called by the daemon process at the configurable "Registry Refresh Rate" to give the subsystem the opportunity to update the status of the resources in its subsystem. For every resource availability change detected, the subsystem should call IRMRegistration::resourceChange. This optional interface is intended for subsystems that monitor dynamic resources such as hot plug devices or mounted file systems. More...

---

Detailed Description

ISubsystemMonitor class contains methods for discovering subsystem's capabilities. This class is required by the resource monitor daemon. All the methods in this class except ISubsystemMonitor::refreshSubsystemRegistration are called once after the library has been loaded by the daemon. All the pointers returned by these methods must remain valid until the linrary is unloaded. All memory allocated by the subsystem must be deallocated when the library is unloaded. This can be done in a global class destructor.

Note:

Resources in a subsystem can change in availability. The ISubsystemMonitor::refreshSubsystemRegistration method gives the subsystem the opportunity to report any resource changes by calling IRMRegistration::resourceChange.

See also:

IRMRegistration::resourceChange

Note:

Subsystem code must define "InSubsystemMonitor" before including any resource monitor include files, i.e. #define InSubsystemMonitor or in the makefile. This adds name and description pointers to rmXXXInfo structures that the subsystem must initialize.

See also:

ResourceMonitorTypes.h to see how the compiler define is used. , SubsystemMonitor for debug note.

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

rmResourceInfo * SubsystemMonitor::ISubsystemMonitor::getResourceInfo ( size_t index ) [pure virtual]

is called by the daemon process after discovering the resource count in rmSubsystemInfo returned by getSubsystemInfo(). It is called noResources times incrementing the index for each call. rmResourceInfo() returns basic identification information about each resource. Parameters: index   range 0 to noResources - 1 Returns: pointer to the subsystems's rmResourceInfo See also: rmResourceInfo rmSubsystemInfo getSubsystemInfo

rmStatisticInfo * SubsystemMonitor::ISubsystemMonitor::getStatisticInfo ( size_t index ) [pure virtual]

is called by the daemon process after discovering the statistic count in rmSubsystemInfo returned by getSubsystemInfo(). It is called noStatistics times incrementing the index for each call. getStatisticInfo() returns basic identification information about each statistic. Parameters: index   range 0 to noStatistics - 1 Returns: pointer to the subsystems's rmStatisticInfo See also: rmStatisticInfo rmSubsystemInfo getSubsystemInfo

rmSubsystemInfo * SubsystemMonitor::ISubsystemMonitor::getSubsystemInfo ( ) [pure virtual]

this method the first call to the subsystem by the daemon process after successful subsystem registration. getSubsystemInfo() returns basic subsystem information. Returns: pointer to the subsystems's rmSubsystemInfo

int SubsystemMonitor::ISubsystemMonitor::getSubsystemInterfaceVersion ( ) [pure virtual]

returns the interface version to the daemon. Returns: compiled version of the subsystem

void SubsystemMonitor::ISubsystemMonitor::refreshSubsystemRegistration ( ) [virtual]

is called by the daemon process at the configurable "Registry Refresh Rate" to give the subsystem the opportunity to update the status of the resources in its subsystem. For every resource availability change detected, the subsystem should call IRMRegistration::resourceChange. This optional interface is intended for subsystems that monitor dynamic resources such as hot plug devices or mounted file systems. See also: IRMRegistration::resourceChange

---

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

• /root/resourcemonitord/resourcemonitord/ISubsystemMonitor.h

---