Information about the monitors and types currently in an engine.
More...
#include <engine_client_cpp.hpp>
Information about the monitors and types currently in an engine.
Instances of this class are returned by EngineManagement::inspectEngine and can be deleted with the com::apama::engine::deleteInfo function.
When an EngineInfo class is deleted, everything returned by the getMonitors, getEventTypes, etc methods is deleted. This includes the arrays themselves, the classes pointed to by the arrays and any strings returned by those classes. This means that deleteInfo is the only cleanup method that needs to be called after an engine inspection.
◆ getAggregates()
Returns information about the aggregate functions in the engine, in the form of a NULL terminated array of pointers to NamedAggregateInfo objects.
The size of the array can be found by calling getNumAggregates (or looking for the NULL terminator).
◆ getContexts()
| virtual NamedContextInfo** com::apama::engine::EngineInfo::getContexts |
( |
| ) |
const |
|
pure virtual |
Returns information about the contexts in the engine, in the form of a NULL terminated array of pointers to ContextInfo objects.
The size of the array can be found by calling getNumContexts (or looking for the NULL terminator).
◆ getEventTypes()
Returns information about the event listener types in the engine, in the form of a NULL terminated array of pointers to NamedEventTypeInfo objects.
The size of the array can be found by calling getNumEventTypes (or looking for the NULL terminator).
◆ getJavaApplications()
Returns information about the Java applications in the engine, in the form of a NULL terminated array of pointers to JavaApplicationInfo objects.
The size of the array can be found by calling getNumJavaApplications (or looking for the NULL terminator).
◆ getMonitors()
| virtual NamedMonitorInfo** com::apama::engine::EngineInfo::getMonitors |
( |
| ) |
const |
|
pure virtual |
Returns information about the monitors in the engine, in the form of a NULL terminated array of pointers to MonitorInfo objects.
The size of the array can be found by calling getNumMonitors (or looking for the NULL terminator).
◆ getNumAggregates()
| virtual unsigned int com::apama::engine::EngineInfo::getNumAggregates |
( |
| ) |
const |
|
pure virtual |
Gets the number of aggregate functions in the engine.
◆ getNumContexts()
| virtual unsigned int com::apama::engine::EngineInfo::getNumContexts |
( |
| ) |
const |
|
pure virtual |
Gets the number of contexts in the engine.
◆ getNumEventTypes()
| virtual unsigned int com::apama::engine::EngineInfo::getNumEventTypes |
( |
| ) |
const |
|
pure virtual |
Gets the number of event listener types in the engine.
◆ getNumJavaApplications()
| virtual unsigned int com::apama::engine::EngineInfo::getNumJavaApplications |
( |
| ) |
const |
|
pure virtual |
Gets the number of Java applications in the engine.
◆ getNumMonitors()
| virtual unsigned int com::apama::engine::EngineInfo::getNumMonitors |
( |
| ) |
const |
|
pure virtual |
Gets the number of monitors in the engine.
◆ getNumPluginReceivers()
| virtual unsigned int com::apama::engine::EngineInfo::getNumPluginReceivers |
( |
| ) |
const |
|
pure virtual |
Gets the number of plugin receivers in the engine.
◆ getNumReceivers()
| virtual unsigned int com::apama::engine::EngineInfo::getNumReceivers |
( |
| ) |
const |
|
pure virtual |
Gets the number of receivers connected to the engine.
◆ getNumTimers()
| virtual unsigned int com::apama::engine::EngineInfo::getNumTimers |
( |
| ) |
const |
|
pure virtual |
Gets the number of timers in the engine.
◆ getPluginReceivers()
Returns information about the plugin receivers in the engine in the form of a NULL-terminated array of pointers to NamedReceiverInfo objects.
The size of the array can be can be found by calling getNumContexts or looking for the NULL terminator.
◆ getReceivers()
Returns information about the receivers connected to the engine in the form of a NULL-terminated array of pointers to NamedReceiverInfo objects.
The size of the array can be can be found by calling getNumContexts or looking for the NULL terminator.
◆ getTimers()
| virtual NamedTimerInfo** com::apama::engine::EngineInfo::getTimers |
( |
| ) |
const |
|
pure virtual |
Returns information about the timers in the engine, in the form of a NULL terminated array of pointers to NamedTimerInfo objects.
The size of the array can be found by calling getNumTimers (or looking for the NULL terminator).
◆ deleteInfo
| AP_ENGINE_CLIENT_API void deleteInfo |
( |
EngineInfo * |
info | ) |
|
|
friend |
This function allows deletion of an EngineInfo object.
All objects returned by any calls to the methods of the EngineInfo object are also deleted, so after calling inspectEngine, deleteInfo is the only method which needs to be called to clean up.
- Parameters
-
The documentation for this class was generated from the following file:
1.8.15