Micro Focus Content Manager SDK 10.1
|
Class to allow SDK clients to monitor the progress of Event processors. More...
Public Member Functions | |
EventMonitor (Database database, int refreshIntervalMilliseconds) | |
Setup an ApiEventMonitor object with a current database handle and a timer value in milliseconds that regulates how often counter data is checked for. The database handle should have 'AllowAccessFromMultipleThreads' set to true, otherwise it will attempt to enabled it. More... | |
EventProcessTypeList | GetAvailableProcessors () |
Gets a list of event processor types that can be polled for counters. Only those event processors that are enabled, or in a suspended state will be returned. Any event processors that are disabled will be omitted from the list. More... | |
string | Initialise () |
Initialise the session prior to setting up the event processors we want to gather data on. This returns a GUID or token which uniquely identifies this session. A session will have a limited lifetime. The token is used to gather data for as long as the session is alive. Once the session has expired, this method must be called again to generate a new token. The token can be stored externally and used to revitalise sessions between invocations of ApiEventMonitor objects (see SetToken()). Will return an empty string if it fails. More... | |
string | Initialise (EventProcessTypeList procs) |
If an existing token is passed to Initialise() as an argument, and the object belonging to the token still exists, the session can continue, otherwise a new monitor object will be initialised and the new token will be returned. More... | |
string | Initialise (string token) |
bool | setToken (string token) |
If a previous token has been saved, use this method to re-initialise the session. If the session is still alive on the remote server, returns true. It is not necessary to call Initialise() if this method returns true. More... | |
bool | EnableCounters () |
Enable all the available event processors for data gathering. An available event processor is one that is active, or in the suspended state. Disabled event processors are ignored. More... | |
bool | EnableCounters (EventProcessType processorType) |
Enable the specific event processor for data gathering. The processor type must be enabled on the remote server, otherwise a false value will be returned More... | |
bool | EnableCounters (EventProcessTypeList processorTypes) |
Enable the list of event processors for data gathering. All the processor types must be enabled on the remote server, otherwise a false value will be returned More... | |
EventProcessTypeList | GetEnabledCounters () |
Return the list of event processors that have data gathering enabled More... | |
bool | DisableCounters () |
Disable all event processors that are currently enabled. Returns true if any counters were disabled More... | |
bool | DisableCounters (EventProcessType processorType) |
Disable the event processor type supplied. Returns true if successful More... | |
bool | DisableCounters (EventProcessTypeList processorTypes) |
Disable the list of event processors supplied. Returns true if all were successfully disabled More... | |
bool | IsAlive () |
Determines if the Event Monitor object on the server is still viable based on the token for this object. If the workgroup server is restarted, then the current token will be invalid and this method will return false. It is then necessary to reinitialise the session using Initialise() which will return a new token. This method should be called prior to calling GetResults().. More... | |
EventProcessorCounters | GetResults (EventProcessType processorType) |
Return the locally cached counters of results from the last poll of the workgroup server. A call to GetResults() should always be preceded by a call to IsAlive() to ensure that the remote Event Monitor Object is still active, otherwise no results will be available. More... | |
EventProcessorCountersList | GetResults () |
bool | setRefreshInterval (int timeMilliseconds) |
Set the interval (in milliseconds) between polling for new counter values. There is a strict minimum value of 1000 milliseconds which overrides the value passed in, as well as the registry setting for the minimum which can be configured by administrators. If the registry value has been set, then this will override the value of the argument value (if it is less than the registry value). More... | |
Public Member Functions inherited from TRIM.SDK.TrimSDKObject | |
TrimSDKObject () | |
Properties | |
string | Token [get] |
Get the current token for this session. The value can be saved and used at a later date to revitalise sessions if they are still running on the remote server. More... | |
int | RefreshInterval [get] |
Get the value of the refresh interval (in milliseconds) More... | |
Properties inherited from TRIM.SDK.TrimSDKObject | |
string | ErrorMessage [get] |
All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More... | |
TrimException | Error [get] |
All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More... | |
Class to allow SDK clients to monitor the progress of Event processors.
TRIM.SDK.EventMonitor.EventMonitor | ( | Database | database, |
int | refreshIntervalMilliseconds | ||
) |
Setup an ApiEventMonitor object with a current database handle and a timer value in milliseconds that regulates how often counter data is checked for. The database handle should have 'AllowAccessFromMultipleThreads' set to true, otherwise it will attempt to enabled it.
bool TRIM.SDK.EventMonitor.DisableCounters | ( | ) |
Disable all event processors that are currently enabled. Returns true if any counters were disabled
bool TRIM.SDK.EventMonitor.DisableCounters | ( | EventProcessType | processorType | ) |
Disable the event processor type supplied. Returns true if successful
bool TRIM.SDK.EventMonitor.DisableCounters | ( | EventProcessTypeList | processorTypes | ) |
Disable the list of event processors supplied. Returns true if all were successfully disabled
bool TRIM.SDK.EventMonitor.EnableCounters | ( | ) |
Enable all the available event processors for data gathering. An available event processor is one that is active, or in the suspended state. Disabled event processors are ignored.
bool TRIM.SDK.EventMonitor.EnableCounters | ( | EventProcessType | processorType | ) |
Enable the specific event processor for data gathering. The processor type must be enabled on the remote server, otherwise a false value will be returned
bool TRIM.SDK.EventMonitor.EnableCounters | ( | EventProcessTypeList | processorTypes | ) |
Enable the list of event processors for data gathering. All the processor types must be enabled on the remote server, otherwise a false value will be returned
EventProcessTypeList TRIM.SDK.EventMonitor.GetAvailableProcessors | ( | ) |
Gets a list of event processor types that can be polled for counters. Only those event processors that are enabled, or in a suspended state will be returned. Any event processors that are disabled will be omitted from the list.
EventProcessTypeList TRIM.SDK.EventMonitor.GetEnabledCounters | ( | ) |
Return the list of event processors that have data gathering enabled
EventProcessorCountersList TRIM.SDK.EventMonitor.GetResults | ( | ) |
EventProcessorCounters TRIM.SDK.EventMonitor.GetResults | ( | EventProcessType | processorType | ) |
Return the locally cached counters of results from the last poll of the workgroup server. A call to GetResults() should always be preceded by a call to IsAlive() to ensure that the remote Event Monitor Object is still active, otherwise no results will be available.
string TRIM.SDK.EventMonitor.Initialise | ( | ) |
Initialise the session prior to setting up the event processors we want to gather data on. This returns a GUID or token which uniquely identifies this session. A session will have a limited lifetime. The token is used to gather data for as long as the session is alive. Once the session has expired, this method must be called again to generate a new token. The token can be stored externally and used to revitalise sessions between invocations of ApiEventMonitor objects (see SetToken()). Will return an empty string if it fails.
string TRIM.SDK.EventMonitor.Initialise | ( | EventProcessTypeList | procs | ) |
If an existing token is passed to Initialise() as an argument, and the object belonging to the token still exists, the session can continue, otherwise a new monitor object will be initialised and the new token will be returned.
string TRIM.SDK.EventMonitor.Initialise | ( | string | token | ) |
bool TRIM.SDK.EventMonitor.IsAlive | ( | ) |
Determines if the Event Monitor object on the server is still viable based on the token for this object. If the workgroup server is restarted, then the current token will be invalid and this method will return false. It is then necessary to reinitialise the session using Initialise() which will return a new token. This method should be called prior to calling GetResults()..
bool TRIM.SDK.EventMonitor.setRefreshInterval | ( | int | timeMilliseconds | ) |
Set the interval (in milliseconds) between polling for new counter values. There is a strict minimum value of 1000 milliseconds which overrides the value passed in, as well as the registry setting for the minimum which can be configured by administrators. If the registry value has been set, then this will override the value of the argument value (if it is less than the registry value).
bool TRIM.SDK.EventMonitor.setToken | ( | string | token | ) |
If a previous token has been saved, use this method to re-initialise the session. If the session is still alive on the remote server, returns true. It is not necessary to call Initialise() if this method returns true.
|
get |
Get the value of the refresh interval (in milliseconds)
|
get |
Get the current token for this session. The value can be saved and used at a later date to revitalise sessions if they are still running on the remote server.