This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %Monitor.Adaptor

%Monitor.Adaptor

abstract class %Monitor.Adaptor extends %Library.RegisteredObject

Monitor enabling class. Users inherit from this class to register as a Monitor class.

Method Inventory

Parameters

parameter APPLICATION;
User name for application. Default = Package name
parameter GROUPNAME;
User name for this group of metrics. Default = classname
parameter INDEX;
Comma separated list of properties to act as primary key for instances. Default = ""
parameter SECURITYRESOURCE;
Comma separated list of Resources required to view the CSP page. Default = ""

Methods

abstract method GetSample() as %Status
USER MUST IMPLEMENT THIS METHOD
This method is called to initialize and populate properties for successive sample instances.
A return code of $$$OK indicates there is a new sample instance.
A return code of 0 indicates there is no sample instance.

NOTE: If an INDEX is specified, i.e. we expect to collect multiple samples for each sampling period, then the System Monitor will loop calling GetSample() until "0" is returned. Users code MUST return "0" when all indexed sample have been collected for a period, in order to terminate the loop.
method Initialize() as %Status
USER MAY IMPLEMENT THIS METHOD
This method is called to initialize the control for the first sample of a set of sample instances.
A return code of $$$OK indicates there is a new sample instance.
A return code of 0 indicates there is no sample instance.
method Shutdown() as %Status
USER MAY IMPLEMENT THIS METHOD
This method is called once when the control object is closed at the end of sampling. The user may cleanup the control class.
method Startup() as %Status
USER MAY IMPLEMENT THIS METHOD
This method is called once when the control object is created at the beginning of sampling. The user may initialize the control class.

Inherited Members

Inherited Methods

FeedbackOpens in a new window