Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

SubsystemMonitor::Monitor Class Reference

#include <Monitor.h>

List of all members.

Public Methods

virtual ~Monitor ()
 called when the monitor is being deleted or the daemon is stopping. Inline monitor must be stopped so no more eventing occurs. More...

virtual int startMonitor ()=0
 starts the monitor once it has been created and configured. More...

virtual int stopMonitor ()=0
 stops the monitor. The monitor retains its state and configuration so it can be resumed with startMonitor. More...

virtual int resetMonitor ()=0
 stops and resets the monitor state. The monitor state is reset to its created state. It can be restarted with startMonitor. More...

virtual int pauseNotification ()=0
 signals the monitor to suspend event notification but continue monitoring. More...

virtual int resetNotification ()=0
 signals the monitor to restart event notification that was paused by a call to pauseNotification(). The call should also re-arm one shot logging where the loggingRate is zero. More...

virtual int getMonitorConfiguration (rmMonitorConfiguration *config)=0
 returns the monitor's configuration data. More...

virtual int setMonitorConfiguration (rmMonitorConfiguration &config)=0
 set new the monitor configuration data. More...

virtual int getMonitorControl (rmMonitorControl *control)=0
 returns the monitor's control data. More...

virtual int setMonitorControl (rmMonitorControl &control)=0
 set new the monitor control data. More...

virtual int checkMonitor (rmMonitorState *state)=0
 returns the monitor's state data. More...


Detailed Description

Monitor class contains methods for accessing the subsystem's inline monitors. This class is required by the daemon only when the subsystem library reports support for inline monitors in rmStatisticInfo. Therefore it is optional for subsystems.
See also:
SubsystemMonitor for debug note.


Constructor & Destructor Documentation

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

called when the monitor is being deleted or the daemon is stopping. Inline monitor must be stopped so no more eventing occurs.

See also:
ResourceMonitor::rmDeleteMonitor


Member Function Documentation

int SubsystemMonitor::Monitor::checkMonitor ( rmMonitorState * state ) [pure virtual]
 

returns the monitor's state data.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmGetMonitorState

int SubsystemMonitor::Monitor::getMonitorConfiguration ( rmMonitorConfiguration * config ) [pure virtual]
 

returns the monitor's configuration data.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmGetMonitorConfiguration

int SubsystemMonitor::Monitor::getMonitorControl ( rmMonitorControl * control ) [pure virtual]
 

returns the monitor's control data.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmGetMonitorControl

int SubsystemMonitor::Monitor::pauseNotification ( ) [pure virtual]
 

signals the monitor to suspend event notification but continue monitoring.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmPauseNotification ResourceMonitor::rmResetNotification

int SubsystemMonitor::Monitor::resetMonitor ( ) [pure virtual]
 

stops and resets the monitor state. The monitor state is reset to its created state. It can be restarted with startMonitor.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmStopMonitor

int SubsystemMonitor::Monitor::resetNotification ( ) [pure virtual]
 

signals the monitor to restart event notification that was paused by a call to pauseNotification(). The call should also re-arm one shot logging where the loggingRate is zero.

Returns:
errno value that is passed on to the client application.
Note:
A reset and start sequence is required to reenable event notification.
See also:
ResourceMonitor::rmResetNotification ResourceMonitor::rmPauseNotification

int SubsystemMonitor::Monitor::setMonitorConfiguration ( rmMonitorConfiguration & config ) [pure virtual]
 

set new the monitor configuration data.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmSetMonitorConfiguration
Note:
No validation of the fields in rmMonitorConfiguration is done before sending it to the subsystem.

int SubsystemMonitor::Monitor::setMonitorControl ( rmMonitorControl & control ) [pure virtual]
 

set new the monitor control data.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmSetMonitorControl
Note:
No validation of the fields in rmMonitorControl is done before sending it to the subsystem.

int SubsystemMonitor::Monitor::startMonitor ( ) [pure virtual]
 

starts the monitor once it has been created and configured.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmCreateMonitor ResourceMonitor::rmStartMonitor

int SubsystemMonitor::Monitor::stopMonitor ( ) [pure virtual]
 

stops the monitor. The monitor retains its state and configuration so it can be resumed with startMonitor.

Returns:
errno value that is passed on to the client application.
See also:
ResourceMonitor::rmStopMonitor


The documentation for this class was generated from the following file:
Generated at Sat Sep 7 21:21:08 2002 for Resource Monitoring Facility by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001