Apama  9.12.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AP_EngineStatus_Functions Struct Reference

EngineStatus function API. More...

#include <engine_client_c.h>

Public Member Functions

 AP_bool (AP_ENGINE_CLIENT_CALL *print)(AP_EngineStatus *status
 Format the status into the given buffer. More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getUptime)(AP_EngineStatus *status)
 Get the time in ms that the Engine has been running for. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumMonitors)(AP_EngineStatus *status)
 Get the number of monitors defined in the Engine. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumProcesses)(AP_EngineStatus *status)
 Get the number of monitor processes or active sub-monitors. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumListeners)(AP_EngineStatus *status)
 Get the number of active listeners. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumEventTypes)(AP_EngineStatus *status)
 Get the number of event types defined. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumQueuedFastTrack)(AP_EngineStatus *status)
 Get the total number of events waiting on the route queues (value of 'rq' in the correlator status line). More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumQueuedInput)(AP_EngineStatus *status)
 Get the total number of events waiting on the input queues (value of 'iq' in the correlator status line). More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getNumReceived)(AP_EngineStatus *status)
 Get the number of events received since the Engine started (including those discarded because they were invalid). More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getNumFastTracked)(AP_EngineStatus *status)
 Get the number of events received on the internal input queue since the Engine started. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumConsumers)(AP_EngineStatus *status)
 Get the number of event consumers connected to the engine. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumOutputEventsQueued)(AP_EngineStatus *status)
 Get the number of events waiting on the output queue. More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getNumOutputEventsCreated)(AP_EngineStatus *status)
 Gets the number of output events which have been put onto the output queue. More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getNumOutputEventsSent)(AP_EngineStatus *status)
 This is the number of output events sent out by the correlator process. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumJavaApplications)(AP_EngineStatus *status)
 Get the number of java applications defined in the Engine. More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getNumProcessed)(AP_EngineStatus *status)
 Get the number of events taken off the input queue and processed since the Engine started. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumSubListeners)(AP_EngineStatus *status)
 Get the number of active listeners. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNumContexts)(AP_EngineStatus *status)
 Get the number of active contexts. More...
 
const AP_char8
*AP_ENGINE_CLIENT_CALL * 
getMostBackedUpInput (AP_EngineStatus *status)
 Get the name of the most backed up (slowest) context. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getMostBackedUpQueueSize)(AP_EngineStatus *status)
 Get the queue size of the most backed up (slowest) context. More...
 
const AP_char8
*AP_ENGINE_CLIENT_CALL * 
getSlowestReceiver (AP_EngineStatus *status)
 Get the name of the slowest receiver. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getSlowestReceiverQueueSize)(AP_EngineStatus *status)
 Get the queue size of the slowest receiver. More...
 
 AP_uint32 (AP_ENGINE_CLIENT_CALL *getNextStatusItem)(AP_EngineStatus *status
 Sets arguments with the next status item name and value. More...
 
const AP_char8
*AP_ENGINE_CLIENT_CALL * 
getStatusValue (AP_EngineStatus *status, const char *key)
 Get the status value with the specified key. More...
 
 AP_uint64 (AP_ENGINE_CLIENT_CALL *getStatusIntValue)(AP_EngineStatus *status
 Get the status value with the specified key, as an integer. More...
 
 void (AP_ENGINE_CLIENT_CALL *deleteStatus)(AP_EngineStatus *status)
 Delete the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus()) More...
 
AP_EngineStatus
*AP_ENGINE_CLIENT_CALL * 
copyStatus (AP_EngineStatus *status)
 Copy the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus()) More...
 
void *AP_ENGINE_CLIENT_CALL * copyIterator (AP_EngineStatus *status, void *opaque_state)
 Copy an opaque_state as returned by getNextStatusItem. More...
 
 void (AP_ENGINE_CLIENT_CALL *disposeIterator)(AP_EngineStatus *status
 Delete the opaque_state as returned by getNextStatusItem. More...
 
 AP_int64 (AP_ENGINE_CLIENT_CALL *getUserInt)(AP_EngineStatus *status
 Get a user value of type AP_int64. More...
 
 AP_int64 (AP_ENGINE_CLIENT_CALL *getUserIntOr)(AP_EngineStatus *status
 Get a user value of type AP_int64 or the alt value if it cannot be found. More...
 
 AP_float64 (AP_ENGINE_CLIENT_CALL *getUserFloat)(AP_EngineStatus *status
 Get a user value of type AP_float64. More...
 
 AP_float64 (AP_ENGINE_CLIENT_CALL *getUserFloatOr)(AP_EngineStatus *status
 Get a user value of type AP_float64 or the alt value if it cannot be found. More...
 
 AP_bool (AP_ENGINE_CLIENT_CALL *getUserBool)(AP_EngineStatus *status
 Get a user value of type AP_bool. More...
 
 AP_bool (AP_ENGINE_CLIENT_CALL *getUserBoolOr)(AP_EngineStatus *status
 Get a user value of type AP_bool or the alt value if it cannot be found. More...
 
const AP_char8
*AP_ENGINE_CLIENT_CALL * 
getUserString (AP_EngineStatus *status, const char *key)
 Get a user value of type AP_char8*. More...
 
const AP_char8
*AP_ENGINE_CLIENT_CALL * 
getUserStringOr (AP_EngineStatus *status, const char *key, const AP_char8 *alt)
 Get a user value of type AP_char8* or the alt value if it cannot be found. More...
 

Detailed Description

EngineStatus function API.

Deprecated:
The C++ API should be used in preference

Member Function Documentation

AP_EngineStatus_Functions::AP_bool ( AP_ENGINE_CLIENT_CALL *  print)

Format the status into the given buffer.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_bool ( AP_ENGINE_CLIENT_CALL *  getUserBool)

Get a user value of type AP_bool.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_bool ( AP_ENGINE_CLIENT_CALL *  getUserBoolOr)

Get a user value of type AP_bool or the alt value if it cannot be found.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_float64 ( AP_ENGINE_CLIENT_CALL *  getUserFloat)

Get a user value of type AP_float64.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_float64 ( AP_ENGINE_CLIENT_CALL *  getUserFloatOr)

Get a user value of type AP_float64 or the alt value if it cannot be found.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_int64 ( AP_ENGINE_CLIENT_CALL *  getUserInt)

Get a user value of type AP_int64.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_int64 ( AP_ENGINE_CLIENT_CALL *  getUserIntOr)

Get a user value of type AP_int64 or the alt value if it cannot be found.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumMonitors)

Get the number of monitors defined in the Engine.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumProcesses)

Get the number of monitor processes or active sub-monitors.

If a monitor spawns it creates a new process.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumListeners)

Get the number of active listeners.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumEventTypes)

Get the number of event types defined.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumQueuedFastTrack)

Get the total number of events waiting on the route queues (value of 'rq' in the correlator status line).

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumQueuedInput)

Get the total number of events waiting on the input queues (value of 'iq' in the correlator status line).

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumConsumers)

Get the number of event consumers connected to the engine.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumOutputEventsQueued)

Get the number of events waiting on the output queue.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumJavaApplications)

Get the number of java applications defined in the Engine.

AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumSubListeners)

Get the number of active listeners.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNumContexts)

Get the number of active contexts.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getMostBackedUpQueueSize)

Get the queue size of the most backed up (slowest) context.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getSlowestReceiverQueueSize)

Get the queue size of the slowest receiver.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint32 ( AP_ENGINE_CLIENT_CALL *  getNextStatusItem)

Sets arguments with the next status item name and value.

Sample usage: void *opaque_state = 0; const char *name; const char *value; while (status->getNextStatusItem(&name, &value, &opaque_state)) { //Do stuff with name,value } status->disposeIterator(opaque_state);

Returns
1 if the name and the value were set, or 0 if there were no more status items, in which case the name and the value arguments are not set
Parameters
namecontains the name of the status item upon return of the function
valuecontains the value of the status item upon return of the function
opaque_statea state pointer which must be initiazed to null when the function is called the first time. This pointer must be free'd by calling disposeIterator.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getUptime)

Get the time in ms that the Engine has been running for.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getNumReceived)

Get the number of events received since the Engine started (including those discarded because they were invalid).

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getNumFastTracked)

Get the number of events received on the internal input queue since the Engine started.

AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getNumOutputEventsCreated)

Gets the number of output events which have been put onto the output queue.

This corresponds to the number of MonitorScript emit commands executed.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getNumOutputEventsSent)

This is the number of output events sent out by the correlator process.

This differs from getNumOutEventsCreated since events can be of interest to a varying number of consumers.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getNumProcessed)

Get the number of events taken off the input queue and processed since the Engine started.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::AP_uint64 ( AP_ENGINE_CLIENT_CALL *  getStatusIntValue)

Get the status value with the specified key, as an integer.

Deprecated:
The C++ API should be used in preference
void* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::copyIterator ( AP_EngineStatus status,
void opaque_state 
)

Copy an opaque_state as returned by getNextStatusItem.

Deprecated:
The C++ API should be used in preference
AP_EngineStatus* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::copyStatus ( AP_EngineStatus status)

Copy the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus())

Deprecated:
The C++ API should be used in preference
const AP_char8* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::getMostBackedUpInput ( AP_EngineStatus status)

Get the name of the most backed up (slowest) context.

Deprecated:
The C++ API should be used in preference
const AP_char8* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::getSlowestReceiver ( AP_EngineStatus status)

Get the name of the slowest receiver.

Deprecated:
The C++ API should be used in preference
const AP_char8* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::getStatusValue ( AP_EngineStatus status,
const char *  key 
)

Get the status value with the specified key.

Deprecated:
The C++ API should be used in preference
const AP_char8* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::getUserString ( AP_EngineStatus status,
const char *  key 
)

Get a user value of type AP_char8*.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
const AP_char8* AP_ENGINE_CLIENT_CALL* AP_EngineStatus_Functions::getUserStringOr ( AP_EngineStatus status,
const char *  key,
const AP_char8 *  alt 
)

Get a user value of type AP_char8* or the alt value if it cannot be found.

Exceptions
EngineException
Returns
The user status.
Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::void ( AP_ENGINE_CLIENT_CALL *  deleteStatus)

Delete the supplied AP_EngineStatus (returned from a previous call to AP_EngineManagement->getStatus())

Deprecated:
The C++ API should be used in preference
AP_EngineStatus_Functions::void ( AP_ENGINE_CLIENT_CALL *  disposeIterator)

Delete the opaque_state as returned by getNextStatusItem.

Deprecated:
The C++ API should be used in preference

The documentation for this struct was generated from the following file: