Apama  10.15.2.4
com::apama::engine::EngineStatus Class Reference

EngineStatus represents the operational status of the Engine. More...

#include <engine_client_cpp.hpp>

Classes

class  StatusIterator
 A class used for the iterating through all status items. More...
 

Public Types

typedef StatusIterator iterator
 Iterator type. More...
 
typedef StatusIterator const_iterator
 Iterator type for const EngineStatus. More...
 

Public Member Functions

AP_uint64 getUptime () const
 The time in milliseconds since the correlator was started. More...
 
AP_uint32 getNumContexts () const
 The number of contexts in the correlator, including the main context. More...
 
AP_uint32 getNumMonitors () const
 The number of EPL monitor definitions injected into the correlator. More...
 
AP_uint32 getNumProcesses () const
 The number of monitor instances, also known as sub-monitors. More...
 
AP_uint32 getNumJavaApplications () const
 The number of Java applications and Java EPL plug-ins loaded in the correlator. More...
 
AP_uint32 getNumListeners () const
 The number of listeners in all contexts. More...
 
AP_uint32 getNumEventTypes () const
 The number of event types defined within the correlator. More...
 
AP_uint32 getNumQueuedFastTrack () const
 The sum of routed events on the route queues of all contexts. More...
 
AP_uint32 getNumQueuedInput () const
 The number of executors on the input queues of all contexts. More...
 
AP_uint64 getNumReceived () const
 The number of events that the correlator has received from external sources since the correlator started. More...
 
AP_uint64 getNumFastTracked () const
 The number of events that have been routed across all contexts since the correlator was started. More...
 
AP_uint32 getNumConsumers () const
 The number of external consumers/receivers connected to receive emitted events. More...
 
AP_uint32 getNumOutEventsQueued () const
 The number of events waiting on output queues to be dispatched to any connected external consumers/receivers. More...
 
AP_uint64 getNumOutEventsCreated () const
 The number of events that have been sent or emitted to channels which have at least one external consumer/receiver subscribed. More...
 
AP_uint64 getNumOutEventsSent () const
 The number of events that have been delivered to external consumers/receivers. More...
 
AP_uint32 getNumInputQueuedInput () const
 The number of events on the input queues of all public contexts. More...
 
const AP_char8 * getMostBackedUpInput () const
 The name of the slowest context. More...
 
const AP_char8 * getSlowestReceiver () const
 The name of the consumer/receiver with the largest number of incoming events waiting to be processed. More...
 
AP_uint32 getSlowestReceiverQueueSize () const
 The number of events on the slowest consumer's/receiver's queue, as identified by the name of the slowest consumer/receiver. More...
 
AP_uint32 getMostBackedUpQueueSize () const
 The number of events on the slowest context's queue, as identified by the name of the slowest context. More...
 
AP_uint32 getNumSubListeners () const
 The number of sub-event-listeners that are active across all contexts. More...
 
AP_uint64 getNumProcessed () const
 The number of events processed by the correlator in all contexts. More...
 
const_iterator begin () const
 Returns an instance of the StatusIterator which allows to iterate over all status items. More...
 
const_iterator end () const
 Returns an instance of the StatusIterator which allows to iterate over all status items. More...
 
const AP_char8 * operator[] (const char *ref) const
 Returns the value of the status item with the given key. More...
 
const AP_char8 * operator[] (std::string &ref) const
 Returns the value of the status item with the given key. More...
 
AP_int64 getUserInt (const char *key)
 Get a user value of type AP_int64. More...
 
AP_int64 getUserIntOr (const char *key, int alt)
 Get a user value of type AP_int64 or the alt value if it cannot be found. More...
 
AP_float64 getUserFloat (const char *key)
 Get a user value of type AP_float64. More...
 
AP_float64 getUserFloatOr (const char *key, float alt)
 Get a user value of type AP_float64 or the alt value if it cannot be found. More...
 
AP_bool getUserBool (const char *key)
 Get a user value of type AP_bool. More...
 
AP_bool getUserBoolOr (const char *key, bool alt)
 Get a user value of type AP_bool or the alt value if it cannot be found. More...
 
const AP_char8 * getUserString (const char *key)
 Get a user value of type AP_char8*. More...
 
const AP_char8 * getUserStringOr (const char *key, const char *alt)
 Get a user value of type AP_char8* or the alt value if it cannot be found. More...
 
std::string getAllStatusValues ()
 Get all the status values available, formatted for terminal output. More...
 
std::string getStandardStatusValues ()
 Get the standard status values, formatted for terminal output. More...
 
std::string getRawHeaderAll ()
 Get a header for the raw output, useful for indentifying values. More...
 
std::string getStandardStatusValuesRaw ()
 Get the standard status values, formatted for parsers (values separated by ,). More...
 
std::string getAllStatusValuesRaw ()
 Get all the status values available, formatted for parsers (values separated by ,). More...
 
 ~EngineStatus ()
 Destroy the underlying status data. More...
 
 EngineStatus (const EngineStatus &other)
 Copy constructor. More...
 
EngineStatusoperator= (const EngineStatus &other)
 Copy assignment. More...
 
 EngineStatus ()
 Create a default-constructed (empty) EngineStatus. More...
 

Static Public Member Functions

static std::string getRawHeader ()
 Get a header for the raw output, useful for indentifying values. More...
 

Detailed Description

EngineStatus represents the operational status of the Engine.

EngineStatus objects are returned by com::apama::engine::EngineManagement::getStatus

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ ~EngineStatus()

com::apama::engine::EngineStatus::~EngineStatus ( )
inline

Destroy the underlying status data.

◆ EngineStatus() [1/2]

com::apama::engine::EngineStatus::EngineStatus ( const EngineStatus other)
inline

Copy constructor.

◆ EngineStatus() [2/2]

com::apama::engine::EngineStatus::EngineStatus ( )
inline

Create a default-constructed (empty) EngineStatus.

Valid EngineStatus objects are returned by EngineManagement::getStatus.

Member Function Documentation

◆ begin()

const_iterator com::apama::engine::EngineStatus::begin ( ) const
inline

Returns an instance of the StatusIterator which allows to iterate over all status items.

Returns
StatusIterator object pointing to the first element

◆ end()

const_iterator com::apama::engine::EngineStatus::end ( ) const
inline

Returns an instance of the StatusIterator which allows to iterate over all status items.

Returns
StatusIterator object pointing after the last element

◆ getAllStatusValues()

std::string com::apama::engine::EngineStatus::getAllStatusValues ( )
inline

Get all the status values available, formatted for terminal output.

This includes any user statuses.

Returns
The standard and user status values.

◆ getAllStatusValuesRaw()

std::string com::apama::engine::EngineStatus::getAllStatusValuesRaw ( )
inline

Get all the status values available, formatted for parsers (values separated by ,).

This includes any user statuses.

Returns
The standard and user status values.

◆ getMostBackedUpInput()

const AP_char8* com::apama::engine::EngineStatus::getMostBackedUpInput ( ) const
inline

The name of the slowest context.

◆ getMostBackedUpQueueSize()

AP_uint32 com::apama::engine::EngineStatus::getMostBackedUpQueueSize ( ) const
inline

The number of events on the slowest context's queue, as identified by the name of the slowest context.

◆ getNumConsumers()

AP_uint32 com::apama::engine::EngineStatus::getNumConsumers ( ) const
inline

The number of external consumers/receivers connected to receive emitted events.

◆ getNumContexts()

AP_uint32 com::apama::engine::EngineStatus::getNumContexts ( ) const
inline

The number of contexts in the correlator, including the main context.

◆ getNumEventTypes()

AP_uint32 com::apama::engine::EngineStatus::getNumEventTypes ( ) const
inline

The number of event types defined within the correlator.

◆ getNumFastTracked()

AP_uint64 com::apama::engine::EngineStatus::getNumFastTracked ( ) const
inline

The number of events that have been routed across all contexts since the correlator was started.

◆ getNumInputQueuedInput()

AP_uint32 com::apama::engine::EngineStatus::getNumInputQueuedInput ( ) const
inline

The number of events on the input queues of all public contexts.

◆ getNumJavaApplications()

AP_uint32 com::apama::engine::EngineStatus::getNumJavaApplications ( ) const
inline

The number of Java applications and Java EPL plug-ins loaded in the correlator.

◆ getNumListeners()

AP_uint32 com::apama::engine::EngineStatus::getNumListeners ( ) const
inline

The number of listeners in all contexts.

◆ getNumMonitors()

AP_uint32 com::apama::engine::EngineStatus::getNumMonitors ( ) const
inline

The number of EPL monitor definitions injected into the correlator.

◆ getNumOutEventsCreated()

AP_uint64 com::apama::engine::EngineStatus::getNumOutEventsCreated ( ) const
inline

The number of events that have been sent or emitted to channels which have at least one external consumer/receiver subscribed.

◆ getNumOutEventsQueued()

AP_uint32 com::apama::engine::EngineStatus::getNumOutEventsQueued ( ) const
inline

The number of events waiting on output queues to be dispatched to any connected external consumers/receivers.

◆ getNumOutEventsSent()

AP_uint64 com::apama::engine::EngineStatus::getNumOutEventsSent ( ) const
inline

The number of events that have been delivered to external consumers/receivers.

This counts for each external consumer/receiver an event is sent to.

◆ getNumProcessed()

AP_uint64 com::apama::engine::EngineStatus::getNumProcessed ( ) const
inline

The number of events processed by the correlator in all contexts.

◆ getNumProcesses()

AP_uint32 com::apama::engine::EngineStatus::getNumProcesses ( ) const
inline

The number of monitor instances, also known as sub-monitors.

◆ getNumQueuedFastTrack()

AP_uint32 com::apama::engine::EngineStatus::getNumQueuedFastTrack ( ) const
inline

The sum of routed events on the route queues of all contexts.

◆ getNumQueuedInput()

AP_uint32 com::apama::engine::EngineStatus::getNumQueuedInput ( ) const
inline

The number of executors on the input queues of all contexts.

As well as events, this can include clock ticks, spawns, injections and other operations.

◆ getNumReceived()

AP_uint64 com::apama::engine::EngineStatus::getNumReceived ( ) const
inline

The number of events that the correlator has received from external sources since the correlator started.

◆ getNumSubListeners()

AP_uint32 com::apama::engine::EngineStatus::getNumSubListeners ( ) const
inline

The number of sub-event-listeners that are active across all contexts.

◆ getRawHeader()

static std::string com::apama::engine::EngineStatus::getRawHeader ( )
inlinestatic

Get a header for the raw output, useful for indentifying values.

Returns
The standard status header.

◆ getRawHeaderAll()

std::string com::apama::engine::EngineStatus::getRawHeaderAll ( )
inline

Get a header for the raw output, useful for indentifying values.

This includes any user statuses.

Returns
The standard and user status header.

◆ getSlowestReceiver()

const AP_char8* com::apama::engine::EngineStatus::getSlowestReceiver ( ) const
inline

The name of the consumer/receiver with the largest number of incoming events waiting to be processed.

◆ getSlowestReceiverQueueSize()

AP_uint32 com::apama::engine::EngineStatus::getSlowestReceiverQueueSize ( ) const
inline

The number of events on the slowest consumer's/receiver's queue, as identified by the name of the slowest consumer/receiver.

◆ getStandardStatusValues()

std::string com::apama::engine::EngineStatus::getStandardStatusValues ( )
inline

Get the standard status values, formatted for terminal output.

Returns
The standard status values.

◆ getStandardStatusValuesRaw()

std::string com::apama::engine::EngineStatus::getStandardStatusValuesRaw ( )
inline

Get the standard status values, formatted for parsers (values separated by ,).

Returns
The standard status values.

◆ getUptime()

AP_uint64 com::apama::engine::EngineStatus::getUptime ( ) const
inline

The time in milliseconds since the correlator was started.

◆ getUserBool()

AP_bool com::apama::engine::EngineStatus::getUserBool ( const char *  key)
inline

Get a user value of type AP_bool.

Exceptions
EngineException.
Returns
The user status.

◆ getUserBoolOr()

AP_bool com::apama::engine::EngineStatus::getUserBoolOr ( const char *  key,
bool  alt 
)
inline

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

Exceptions
EngineException.
Returns
The user status.

◆ getUserFloat()

AP_float64 com::apama::engine::EngineStatus::getUserFloat ( const char *  key)
inline

Get a user value of type AP_float64.

Exceptions
EngineException
Returns
The user status.

◆ getUserFloatOr()

AP_float64 com::apama::engine::EngineStatus::getUserFloatOr ( const char *  key,
float  alt 
)
inline

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

Exceptions
EngineException.
Returns
The user status.

◆ getUserInt()

AP_int64 com::apama::engine::EngineStatus::getUserInt ( const char *  key)
inline

Get a user value of type AP_int64.

Exceptions
EngineException.
Returns
The user status.

◆ getUserIntOr()

AP_int64 com::apama::engine::EngineStatus::getUserIntOr ( const char *  key,
int  alt 
)
inline

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

Exceptions
EngineException.
Returns
The user status.

◆ getUserString()

const AP_char8* com::apama::engine::EngineStatus::getUserString ( const char *  key)
inline

Get a user value of type AP_char8*.

Exceptions
EngineException.
Returns
The user status.

◆ getUserStringOr()

const AP_char8* com::apama::engine::EngineStatus::getUserStringOr ( const char *  key,
const char *  alt 
)
inline

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

Exceptions
EngineException.
Returns
The user status.

◆ operator=()

EngineStatus& com::apama::engine::EngineStatus::operator= ( const EngineStatus other)
inline

Copy assignment.

◆ operator[]() [1/2]

const AP_char8* com::apama::engine::EngineStatus::operator[] ( const char *  ref) const
inline

Returns the value of the status item with the given key.

◆ operator[]() [2/2]

const AP_char8* com::apama::engine::EngineStatus::operator[] ( std::string &  ref) const
inline

Returns the value of the status item with the given key.


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