---

rmClientTypes.h File Reference

#include <posix_evlog.h>

Go to the source code of this file.

Compounds
struct	eventData
Typedefs
typedef enum _MonitorCommand	MonitorCommand
typedef enum _NotificationFlag	NotificationFlag
typedef enum _EventCommand	EventCommand
typedef enum _EventNotificationPurpose	EventNotificationPurpose
typedef enum _RowStatus	RowStatus
typedef enum _RMEntity	RMEntity
typedef enum _RMAttribute	RMAttribute
Enumerations
enum	_MonitorCommand {   NEW_MONITORENTRY = 1, CREATE_MONITOR, START_MONITOR, STOP_MONITOR,   RESET_MONITOR, DELETE_MONITOR, PAUSE_NOTIFICATION, RESET_NOTIFICATION }
enum	_NotificationFlag { NOTIFY_ALWAYS = 1, NOTIFY_ONCE_ONLY }
enum	_EventCommand { CREATE_NOTIFICATION = 1, REMOVE_NOTIFICATION }
enum	_EventNotificationPurpose { PURPOSE_NOTIFY = 1, PURPOSE_SEEK, PURPOSE_GENERAL }
enum	_RowStatus {   NOTEXIST = 0, ACTIVE = 1, NOTINSERVICE, NOTREADY,   CREATEANDGO, CREATEANDWAIT, DESTROY }
enum	_RMEntity {   GENERICCONFIG = 1, THRESHOLDCONFIG, WATERMARKCONFIG, LEAKYBUCKETCONFIG,   GENERICCONTROL, THRESHOLDCONTROL, LEAKYBUCKETCONTROL, MONITOR,   EVENTQUERY, EVENTNOTIFICATION, EVENTHANDLER, EVENTACTION,   EVENTLOG, SUBSYSTEMINFO, RESORUCEINFO, STATISTICINFO,   INLINEMONITORINFO, DATACAPTUREPLUGININFO }
enum	_RMAttribute {   GENERICCONFIG_MONITORTYPE = 1, GENERICCONFIG_SUBSYSTEMID, GENERICCONFIG_STATISTICID, GENERICCONFIG_RESOURCEID,   GENERICCONFIG_STATISTICTRANSFORM, GENERICCONFIG_THRESHOLDID, GENERICCONFIG_WATERMARKID, GENERICCONFIG_LEAKYBUCKETID,   GENERICCONFIG_REFCOUNT, GENERICCONFIG_STATUS, THRESHOLDCONFIG_TYPE, THRESHOLDCONFIG_VALUE32,   THRESHOLDCONFIG_VALUE64, THRESHOLDCONFIG_TESTCONDITION, THRESHOLDCONFIG_PRECONDITION, THRESHOLDCONFIG_EVENTSEVERITY,   THRESHOLDCONFIG_CANCELEVENTSEVERITY, THRESHOLDCONFIG_REFCOUNT, THRESHOLDCONFIG_STATUS, WATERMARKCONFIG_TYPE,   WATERMARKCONFIG_REFCOUNT, WATERMARKCONFIG_STATUS, LEAKYBUCKETCONFIG_BUCKETSIZE32, LEAKYBUCKETCONFIG_BUCKETSIZE64,   LEAKYBUCKETCONFIG_FILLVALUE32, LEAKYBUCKETCONFIG_FILLVALUE64, LEAKYBUCKETCONFIG_EVENTSEVERITY, LEAKYBUCKETCONFIG_REFCOUNT,   LEAKYBUCKETCONFIG_STATUS, GENERICCONTROL_MONITORTYPE, GENERICCONTROL_MONITORUUID, GENERICCONTROL_MONITORLOCATION,   GENERICCONTROL_DATACAPTURE, GENERICCONTROL_MONITORLIFE, GENERICCONTROL_MONITORRATE, GENERICCONTROL_MONITORMICRORATE,   GENERICCONTROL_THRESHOLDID, GENERICCONTROL_LEAKYBUCKETID, GENERICCONTROL_REFCOUNT, GENERICCONTROL_STATUS,   THRESHOLDCONTROL_TOLERANCE32, THRESHOLDCONTROL_TOLERANCE64, THRESHOLDCONTROL_SAMPLETIME, THRESHOLDCONTROL_LOGRATE,   THRESHOLDCONTROL_REFCOUNT, THRESHOLDCONTROL_STATUS, LEAKYBUCKETCONTROL_LOGGINGRATE, LEAKYBUCKETCONTROL_REFCOUNT,   LEAKYBUCKETCONTROL_STATUS, MONITOR_UUID, MONITOR_CONTROLID, MONITOR_CONFIGID,   MONITOR_LOCATION, MONITOR_TYPE, MONITOR_STATUS, MONITOR_NOTIFICATIONPAUSED,   MONITOR_SUBSYSTEMID, MONITOR_SUBSYSTEMUUID, MONITOR_RESORUCEID, MONITOR_STATISTICID,   MONITOR_LASTVALUE32, MONITOR_LASTVALUE64, MONITOR_STARTTIME, MONITOR_STOPTIME,   MONITOR_THRESHOLDLASTEVENTTIME, MONITOR_WATERMARKHIGHTIME, MONITOR_WATERMARKLOWTIME, MONITOR_WATERMARKHIGH32,   MONITOR_WATERMARKHIGH64, MONITOR_WATERMARKLOW32, MONITOR_WATERMARKLOW64, MONITOR_LEAKYBUCKETLEVEL32,   MONITOR_LEAKYBUCKETLEVEL64, MONITOR_LEAKYBUCKETLASTEVENTTIME, MONITOR_COMMAND, MONITOR_SNMPTRAP,   EVENTQUERY_STRING, EVENTQUERY_PURPOSE, EVENTQUERY_REFCOUNT, EVENTQUERY_STATUS,   EVENTNOTIFICATION_QUERYID, EVENTNOTIFICATION_ONCEONLY, EVENTNOTIFICATION_TRAPGENERIC, EVENTNOTIFICATION_STATUS,   EVENTHANDLER_COMMAND, EVENTHANDLER_USER, EVENTHANDLER_REFCOUNT, EVENTHANDLER_STATUS,   EVENTACTION_QUERYID, EVENTACTION_HANDLER, EVENTACTION_TYPE, EVENTACTION_STATUS,   EVENTLOG_DEFAULTQUERY, EVENTLOG_DEFAULTFILE, EVENTLOG_SIZE, EVENTLOG_FORMAT,   EVENTLOG_TYPE, EVENTLOG_FACILITY, EVENTLOG_SEVERITY, EVENTLOG_UID,   EVENTLOG_GID, EVENTLOG_PID, EVENTLOG_PGID, EVENTLOG_TIMESTAMP,   EVENTLOG_FLAG, EVENTLOG_THREAD, EVENTLOG_PROCESSOR, EVENTLOG_STRING,   EVENTLOG_BINARY, SUBSYSTEMINFO_NAME, SUBSYSTEMINFO_DESCRIPTION, SUBSYSTEMINFO_UUID,   SUBSYSTEMINFO_RESOURCECOUNT, SUBSYSTEMINFO_STATISTICCOUNT, RESORUCEINFO_NAME, RESOURCEINFO_DESCRIPTION,   RESOURCEINFO_SUBSYSTEMUUID, RESOURCEINFO_RESOURCEID, RESOURCEINFO_SUBSYSTEMID, STATISTICINFO_NAME,   STATISTICINFO_DESCRIPTION, STATISTICINFO_UNITS, STATISTICINFO_SUBSYSTEMUUID, STATISTICINFO_SUBSYSTEMID,   STATISTICINFO_RESOURCEID, STATISTICINFO_ID, STATISTICINFO_TYPE, STATISTICINFO_SIZE,   STATISTICINFO_SCALE, STATISTICINFO_COUNTERRESET, STATISTICINFO_COUNTERRESETVALUE32, STATISTICINFO_COUNTERRESETVALUE64,   STATISTICINFO_GAUGEUPPERBOUND32, STATISTICINFO_GAUGEUPPERBOUND64, DATACAPTUREPLUGININFO_UUID, DATACAPTUREPLUGININFO_NAME }
Variables
const int	UUID_STRING_LENGTH = 37
	The length of a UUID string, including the trailing NULL character. More...

---

Typedef Documentation

typedef enum _EventCommand EventCommand

typedef enum _EventNotificationPurpose EventNotificationPurpose

typedef enum _MonitorCommand MonitorCommand

The list of commands that can be applied to a monitor. Most of them map to a specific method in ResourceMonitor Daemon API. The only exception is NEW_MONITORENTRY. This command would only creates a monitor entry in Monitor table using the default values. The purpose of that is to support SNMP row creation in "dribble mode". In this mode, the monitor entry will be created in memory, but the monitor does not exists in ResourceMonitor Daemon yet. Client has to supply more parameters, such as the configuration and control information, before the real monitor can be created in the ResourceMonitor Daemon. When the monitor entry is ready, clients issue the command "CREATE_MONITOR". This will create the "real monitor" in ResourceMonitor Daemon.

typedef enum _NotificationFlag NotificationFlag

typedef enum _RMAttribute RMAttribute

The list of attributes. These names represents columns of the table. The format of the name is TABLENAME_ATTRIBUTENAME. So it is very easy to tell which attributes belongs to which table. And the data type and access rights is also documented here. Notice: ronly means the attribute is read-only. Unless specified, all attributes have an acces right of read-write. Todo: add the sysinfo into this list and convert all the old function calls into this new interface. Referenced by getBinary, subagentBase::getBinary, rmBaseArray< Monitor >::getBinary, eventLog::getBinary, statisticInfo::getInteger32, rmMonitor::getInteger32, rmLeakyBucketMonitorControl::getInteger32, rmThresholdMonitorControl::getInteger32, rmGenericMonitorControl::getInteger32, rmLeakyBucketMonitorConfig::getInteger32, rmWatermarkMonitorConfig::getInteger32, rmThresholdMonitorConfig::getInteger32, rmGenericMonitorConfig::getInteger32, getInteger32, subagentBase::getInteger32, rmBaseArray< Monitor >::getInteger32, eventQuery::getInteger32, eventLog::getInteger32, dataCaptureInfo::getString, statisticInfo::getString, resourceInfo::getString, subsystemInfo::getString, getString, subagentBase::getString, rmBaseArray< Monitor >::getString, eventQuery::getString, eventLog::getString, statisticInfo::getUnsigned, resourceInfo::getUnsigned, subsystemInfo::getUnsigned, rmMonitor::getUnsigned, rmLeakyBucketMonitorControl::getUnsigned, rmThresholdMonitorControl::getUnsigned, rmGenericMonitorControl::getUnsigned, rmLeakyBucketMonitorConfig::getUnsigned, rmThresholdMonitorConfig::getUnsigned, rmGenericMonitorConfig::getUnsigned, getUnsigned, subagentBase::getUnsigned, rmBaseArray< Monitor >::getUnsigned, eventLog::getUnsigned, statisticInfo::getUnsigned64, rmMonitor::getUnsigned64, rmThresholdMonitorControl::getUnsigned64, rmLeakyBucketMonitorConfig::getUnsigned64, rmThresholdMonitorConfig::getUnsigned64, getUnsigned64, subagentBase::getUnsigned64, rmBaseArray< Monitor >::getUnsigned64, eventLog::getUnsigned64, statisticInfo::getUUID, resourceInfo::getUUID, subsystemInfo::getUUID, rmMonitor::getUUID, rmGenericMonitorControl::getUUID, getUUID, subagentBase::getUUID, rmBaseArray< Monitor >::getUUID, eventLog::getUUID, dataCaptureInfo::getUUIDString, statisticInfo::getUUIDString, resourceInfo::getUUIDString, subsystemInfo::getUUIDString, rmMonitor::getUUIDString, rmGenericMonitorControl::getUUIDString, getUUIDString, subagentBase::getUUIDString, rmBaseArray< Monitor >::getUUIDString, eventLog::getUUIDString, statisticInfo::setInteger32, rmMonitor::setInteger32, rmLeakyBucketMonitorControl::setInteger32, rmThresholdMonitorControl::setInteger32, rmGenericMonitorControl::setInteger32, rmLeakyBucketMonitorConfig::setInteger32, rmWatermarkMonitorConfig::setInteger32, rmThresholdMonitorConfig::setInteger32, rmGenericMonitorConfig::setInteger32, setInteger32, subagentBase::setInteger32, rmBaseArray< Monitor >::setInteger32, eventQuery::setInteger32, eventLog::setInteger32, setString, subagentBase::setString, rmBaseArray< Monitor >::setString, eventQuery::setString, eventLog::setString, statisticInfo::setUnsigned, rmMonitor::setUnsigned, rmLeakyBucketMonitorControl::setUnsigned, rmThresholdMonitorControl::setUnsigned, rmGenericMonitorControl::setUnsigned, rmLeakyBucketMonitorConfig::setUnsigned, rmThresholdMonitorConfig::setUnsigned, rmGenericMonitorConfig::setUnsigned, setUnsigned, subagentBase::setUnsigned, rmBaseArray< Monitor >::setUnsigned, eventLog::setUnsigned, statisticInfo::setUnsigned64, rmThresholdMonitorControl::setUnsigned64, rmLeakyBucketMonitorConfig::setUnsigned64, rmThresholdMonitorConfig::setUnsigned64, setUnsigned64, subagentBase::setUnsigned64, rmBaseArray< Monitor >::setUnsigned64, eventLog::setUnsigned64, rmGenericMonitorControl::setUUIDString, setUUIDString, subagentBase::setUUIDString, rmBaseArray< Monitor >::setUUIDString, and eventLog::setUUIDString.

typedef enum _RMEntity RMEntity

The list of entities, or tables. Each memeber represents a table (or a list) that will be managed by the client library. Todo: add the sysinfo into this list and convert all the old function calls into this new interface. Referenced by deleteEntry, subagentBase::deleteEntry, findId, subagentBase::findId, getBinary, subagentBase::getBinary, getCount, subagentBase::getCount, rmClient::getEntity, getInteger32, subagentBase::getInteger32, getNewId, subagentBase::getNewId, getNextId, subagentBase::getNextId, getString, subagentBase::getString, getUnsigned, subagentBase::getUnsigned, getUnsigned64, subagentBase::getUnsigned64, getUUID, subagentBase::getUUID, getUUIDString, subagentBase::getUUIDString, newEntry, subagentBase::newEntry, setInteger32, subagentBase::setInteger32, setString, subagentBase::setString, setUnsigned, subagentBase::setUnsigned, setUnsigned64, subagentBase::setUnsigned64, setUUIDString, and subagentBase::setUUIDString.

typedef enum _RowStatus RowStatus

The list of statuses an entry could have. Most of them map to the RowStatus that is defined in SNMPv2 MIB. The only exception is "NOTEXIST". In SNMPv2 MIB, NOTEXIST is just a internal state that will never be returned since, well, obviously, the row does not exist yet. But in our case, we will return NOTEXIST to represent a monitor that is currently only exists in the Monitor table, but not in ResourceMonitor Daemon. In another word, the monitor does not exist yet.

---

Enumeration Type Documentation

enum _EventCommand

Enumeration values: CREATE_NOTIFICATION  REMOVE_NOTIFICATION  Definition at line 43 of file rmClientTypes.h.

enum _EventNotificationPurpose

Enumeration values: PURPOSE_NOTIFY  PURPOSE_SEEK  PURPOSE_GENERAL  Definition at line 49 of file rmClientTypes.h.

enum _MonitorCommand

The list of commands that can be applied to a monitor. Most of them map to a specific method in ResourceMonitor Daemon API. The only exception is NEW_MONITORENTRY. This command would only creates a monitor entry in Monitor table using the default values. The purpose of that is to support SNMP row creation in "dribble mode". In this mode, the monitor entry will be created in memory, but the monitor does not exists in ResourceMonitor Daemon yet. Client has to supply more parameters, such as the configuration and control information, before the real monitor can be created in the ResourceMonitor Daemon. When the monitor entry is ready, clients issue the command "CREATE_MONITOR". This will create the "real monitor" in ResourceMonitor Daemon. Enumeration values: NEW_MONITORENTRY  CREATE_MONITOR  START_MONITOR  STOP_MONITOR  RESET_MONITOR  DELETE_MONITOR  PAUSE_NOTIFICATION  RESET_NOTIFICATION  Definition at line 25 of file rmClientTypes.h.

enum _NotificationFlag

Enumeration values: NOTIFY_ALWAYS  NOTIFY_ONCE_ONLY  Definition at line 37 of file rmClientTypes.h.

enum _RMAttribute

The list of attributes. These names represents columns of the table. The format of the name is TABLENAME_ATTRIBUTENAME. So it is very easy to tell which attributes belongs to which table. And the data type and access rights is also documented here. Notice: ronly means the attribute is read-only. Unless specified, all attributes have an acces right of read-write. Todo: add the sysinfo into this list and convert all the old function calls into this new interface. Enumeration values: GENERICCONFIG_MONITORTYPE  GENERICCONFIG_SUBSYSTEMID  GENERICCONFIG_STATISTICID  GENERICCONFIG_RESOURCEID  GENERICCONFIG_STATISTICTRANSFORM  GENERICCONFIG_THRESHOLDID  GENERICCONFIG_WATERMARKID  GENERICCONFIG_LEAKYBUCKETID  GENERICCONFIG_REFCOUNT  GENERICCONFIG_STATUS  THRESHOLDCONFIG_TYPE  THRESHOLDCONFIG_VALUE32  THRESHOLDCONFIG_VALUE64  THRESHOLDCONFIG_TESTCONDITION  THRESHOLDCONFIG_PRECONDITION  THRESHOLDCONFIG_EVENTSEVERITY  THRESHOLDCONFIG_CANCELEVENTSEVERITY  THRESHOLDCONFIG_REFCOUNT  THRESHOLDCONFIG_STATUS  WATERMARKCONFIG_TYPE  WATERMARKCONFIG_REFCOUNT  WATERMARKCONFIG_STATUS  LEAKYBUCKETCONFIG_BUCKETSIZE32  LEAKYBUCKETCONFIG_BUCKETSIZE64  LEAKYBUCKETCONFIG_FILLVALUE32  LEAKYBUCKETCONFIG_FILLVALUE64  LEAKYBUCKETCONFIG_EVENTSEVERITY  LEAKYBUCKETCONFIG_REFCOUNT  LEAKYBUCKETCONFIG_STATUS  GENERICCONTROL_MONITORTYPE  GENERICCONTROL_MONITORUUID  GENERICCONTROL_MONITORLOCATION  GENERICCONTROL_DATACAPTURE  GENERICCONTROL_MONITORLIFE  GENERICCONTROL_MONITORRATE  GENERICCONTROL_MONITORMICRORATE  GENERICCONTROL_THRESHOLDID  GENERICCONTROL_LEAKYBUCKETID  GENERICCONTROL_REFCOUNT  GENERICCONTROL_STATUS  THRESHOLDCONTROL_TOLERANCE32  THRESHOLDCONTROL_TOLERANCE64  THRESHOLDCONTROL_SAMPLETIME  THRESHOLDCONTROL_LOGRATE  THRESHOLDCONTROL_REFCOUNT  THRESHOLDCONTROL_STATUS  LEAKYBUCKETCONTROL_LOGGINGRATE  LEAKYBUCKETCONTROL_REFCOUNT  LEAKYBUCKETCONTROL_STATUS  MONITOR_UUID  MONITOR_CONTROLID  MONITOR_CONFIGID  MONITOR_LOCATION  MONITOR_TYPE  MONITOR_STATUS  MONITOR_NOTIFICATIONPAUSED  MONITOR_SUBSYSTEMID  MONITOR_SUBSYSTEMUUID  MONITOR_RESORUCEID  MONITOR_STATISTICID  MONITOR_LASTVALUE32  MONITOR_LASTVALUE64  MONITOR_STARTTIME  MONITOR_STOPTIME  MONITOR_THRESHOLDLASTEVENTTIME  MONITOR_WATERMARKHIGHTIME  MONITOR_WATERMARKLOWTIME  MONITOR_WATERMARKHIGH32  MONITOR_WATERMARKHIGH64  MONITOR_WATERMARKLOW32  MONITOR_WATERMARKLOW64  MONITOR_LEAKYBUCKETLEVEL32  MONITOR_LEAKYBUCKETLEVEL64  MONITOR_LEAKYBUCKETLASTEVENTTIME  MONITOR_COMMAND  MONITOR_SNMPTRAP  EVENTQUERY_STRING  EVENTQUERY_PURPOSE  EVENTQUERY_REFCOUNT  EVENTQUERY_STATUS  EVENTNOTIFICATION_QUERYID  EVENTNOTIFICATION_ONCEONLY  EVENTNOTIFICATION_TRAPGENERIC  EVENTNOTIFICATION_STATUS  EVENTHANDLER_COMMAND  EVENTHANDLER_USER  EVENTHANDLER_REFCOUNT  EVENTHANDLER_STATUS  EVENTACTION_QUERYID  EVENTACTION_HANDLER  EVENTACTION_TYPE  EVENTACTION_STATUS  EVENTLOG_DEFAULTQUERY  EVENTLOG_DEFAULTFILE  EVENTLOG_SIZE  EVENTLOG_FORMAT  EVENTLOG_TYPE  EVENTLOG_FACILITY  EVENTLOG_SEVERITY  EVENTLOG_UID  EVENTLOG_GID  EVENTLOG_PID  EVENTLOG_PGID  EVENTLOG_TIMESTAMP  EVENTLOG_FLAG  EVENTLOG_THREAD  EVENTLOG_PROCESSOR  EVENTLOG_STRING  EVENTLOG_BINARY  SUBSYSTEMINFO_NAME  SUBSYSTEMINFO_DESCRIPTION  SUBSYSTEMINFO_UUID  SUBSYSTEMINFO_RESOURCECOUNT  SUBSYSTEMINFO_STATISTICCOUNT  RESORUCEINFO_NAME  RESOURCEINFO_DESCRIPTION  RESOURCEINFO_SUBSYSTEMUUID  RESOURCEINFO_RESOURCEID  RESOURCEINFO_SUBSYSTEMID  STATISTICINFO_NAME  STATISTICINFO_DESCRIPTION  STATISTICINFO_UNITS  STATISTICINFO_SUBSYSTEMUUID  STATISTICINFO_SUBSYSTEMID  STATISTICINFO_RESOURCEID  STATISTICINFO_ID  STATISTICINFO_TYPE  STATISTICINFO_SIZE  STATISTICINFO_SCALE  STATISTICINFO_COUNTERRESET  STATISTICINFO_COUNTERRESETVALUE32  STATISTICINFO_COUNTERRESETVALUE64  STATISTICINFO_GAUGEUPPERBOUND32  STATISTICINFO_GAUGEUPPERBOUND64  DATACAPTUREPLUGININFO_UUID  DATACAPTUREPLUGININFO_NAME  Definition at line 136 of file rmClientTypes.h.

enum _RMEntity

The list of entities, or tables. Each memeber represents a table (or a list) that will be managed by the client library. Todo: add the sysinfo into this list and convert all the old function calls into this new interface. Enumeration values: GENERICCONFIG  THRESHOLDCONFIG  WATERMARKCONFIG  LEAKYBUCKETCONFIG  GENERICCONTROL  THRESHOLDCONTROL  LEAKYBUCKETCONTROL  MONITOR  EVENTQUERY  EVENTNOTIFICATION  EVENTHANDLER  EVENTACTION  EVENTLOG  SUBSYSTEMINFO  RESORUCEINFO  STATISTICINFO  INLINEMONITORINFO  DATACAPTUREPLUGININFO  Definition at line 96 of file rmClientTypes.h.

enum _RowStatus

The list of statuses an entry could have. Most of them map to the RowStatus that is defined in SNMPv2 MIB. The only exception is "NOTEXIST". In SNMPv2 MIB, NOTEXIST is just a internal state that will never be returned since, well, obviously, the row does not exist yet. But in our case, we will return NOTEXIST to represent a monitor that is currently only exists in the Monitor table, but not in ResourceMonitor Daemon. In another word, the monitor does not exist yet. Enumeration values: NOTEXIST  ACTIVE  NOTINSERVICE  NOTREADY  CREATEANDGO  CREATEANDWAIT  DESTROY  Definition at line 75 of file rmClientTypes.h.

---

Variable Documentation

const int UUID_STRING_LENGTH = 37 [static]

The length of a UUID string, including the trailing NULL character. Definition at line 7 of file rmClientTypes.h.

---