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

rmMonitorControl Struct Reference

#include <ResourceMonitorTypes.h>

List of all members.

Public Attributes

enum rmMonitorType monitorType
 used to switch on the typeControl union. More...

enum rmMonitorLocation location
 specifies the inline or daemon location to use. if rmInLineDaemon is specified on monitor creation, location will be set to rmInLine or rmDaemon when the monitor is created. More...

rmUID uid
 The monitor uuid will be part of an event record to uniquely identify this monitor. The resource monitoring facility generates this unique ID when a monitor is created if the uid is clear and is returned when ResourceMonitor::rmCreateMonitor is succesful, else the provided uuid is used.
See also:
clearMonitorUID setMonitorUID.
More...


rmUID dataCapture
 the resource monitoring facility registers data capture libraries using unique ID's. Each library provides a different storage method. Clearing this field indicates that no data capture will be done for this monitor
See also:
clearDataCapture setDataCapture TextDataCapture
Note:
Data capture only captures the raw reading, not the transformed value.
More...


rmTimeInterval monitoringInterval
 seconds to monitor once started. The daemon automatically stops monitoring at the end of the interval. More...

rmTimeInterval monitoringRate
 seconds between each sample taken by the monitor: 60 = 1 sample/minute, etc. monitoringRate can not be set to zero for daemon monitors. More...

rmMicroTimeInterval microMonitoringRate
 microseconds between each sample taken by the monitor added to monitoringRate Daemon monitors only use monitoringRate. More...

union {
   rmThresholdControl   threshold
   rmLeakyBucketControl   leakyBucket
typeControl
 monitor type specific control parameters. More...


Detailed Description

rmMonitorControl parameters are primarily for the control of the location and logging of a monitor.
Note:
the monitorType, uid, and location can NOT be changed once the monitor is created. The monitoring interval and monitoring rate can be changed with ResourceMonitor::rmSetMonitorControl.
See also:
rmMonitorConfiguration ResourceMonitor::rmSetMonitorControl


Member Data Documentation

rmUID rmMonitorControl::dataCapture
 

the resource monitoring facility registers data capture libraries using unique ID's. Each library provides a different storage method. Clearing this field indicates that no data capture will be done for this monitor

See also:
clearDataCapture setDataCapture TextDataCapture
Note:
Data capture only captures the raw reading, not the transformed value.

rmLeakyBucketControl rmMonitorControl::leakyBucket
 

enum rmMonitorLocation rmMonitorControl::location
 

specifies the inline or daemon location to use. if rmInLineDaemon is specified on monitor creation, location will be set to rmInLine or rmDaemon when the monitor is created.

rmMicroTimeInterval rmMonitorControl::microMonitoringRate
 

microseconds between each sample taken by the monitor added to monitoringRate Daemon monitors only use monitoringRate.

enum rmMonitorType rmMonitorControl::monitorType
 

used to switch on the typeControl union.

rmTimeInterval rmMonitorControl::monitoringInterval
 

seconds to monitor once started. The daemon automatically stops monitoring at the end of the interval.

rmTimeInterval rmMonitorControl::monitoringRate
 

seconds between each sample taken by the monitor: 60 = 1 sample/minute, etc. monitoringRate can not be set to zero for daemon monitors.

rmThresholdControl rmMonitorControl::threshold
 

union { ... } rmMonitorControl::typeControl
 

monitor type specific control parameters.

rmUID rmMonitorControl::uid
 

The monitor uuid will be part of an event record to uniquely identify this monitor. The resource monitoring facility generates this unique ID when a monitor is created if the uid is clear and is returned when ResourceMonitor::rmCreateMonitor is succesful, else the provided uuid is used.

See also:
clearMonitorUID setMonitorUID.


The documentation for this struct 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