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
	Get the time in ms that the Engine has been running for. More...

AP_uint32	getNumContexts () const
	Get the number of contexts active in the Engine. More...

AP_uint32	getNumMonitors () const
	Get the number of monitors defined in the Engine. More...

AP_uint32	getNumProcesses () const
	Get the number of monitor processes or active sub-monitors. More...

AP_uint32	getNumJavaApplications () const
	Get the number of Java (JMon) Applications defined in the Engine. More...

AP_uint32	getNumListeners () const
	Get the number of active listeners. More...

AP_uint32	getNumEventTypes () const
	Get the number of event types defined in the Engine. More...

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

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

AP_uint64	getNumReceived () const
	Get the number of events received since the Engine started. More...

AP_uint64	getNumFastTracked () const
	Get the number of events received on the internal input queue since the Engine started. More...

AP_uint32	getNumConsumers () const
	Get the number of event consumers connected to the engine. More...

AP_uint32	getNumOutEventsQueued () const
	Get the number of events waiting on the output queue. More...

AP_uint64	getNumOutEventsCreated () const
	Get the number of output events which have been put onto the output queue. More...

AP_uint64	getNumOutEventsSent () const
	This is the number of output events sent out by the correlator process. More...

AP_uint32	getNumInputQueuedInput () const
	Get the total number of events on input contexts' queues. More...

const AP_char8 *	getMostBackedUpInput () const
	Get the name of the most backed up context. More...

const AP_char8 *	getSlowestReceiver () const
	Get the name of the slowest receiver. More...

AP_uint32	getSlowestReceiverQueueSize () const
	Get the queue size of the slowest receiver. More...

AP_uint32	getMostBackedUpQueueSize () const
	Get the queue size of the most backed up context. More...

AP_uint32	getNumSubListeners () const
	Get the number of active sub-listeners. More...

AP_uint64	getNumProcessed () const
	Get the number of events taken off the input queue and processed since the engine started. 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...

EngineStatus &	operator= (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

typedef StatusIterator com::apama::engine::EngineStatus::const_iterator

Iterator type for const EngineStatus.

typedef StatusIterator com::apama::engine::EngineStatus::iterator

Iterator type.

Constructor & Destructor Documentation

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

inline

Destroy the underlying status data.

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

inline

Copy constructor.

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

inline

Create a default-constructed (empty) EngineStatus.

Valid EngineStatus objects are returned by EngineManagement::getStatus.

Member Function Documentation

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

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

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.

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.

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

inline

Get the name of the most backed up context.

Returns: The name of the slowest context.

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

inline

Get the queue size of the most backed up context.

Returns: The size of the slowest context's queue.

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

inline

Get the number of event consumers connected to the engine.

Returns: The number of event consumers.

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

inline

Get the number of contexts active in the Engine.

Returns: The number of contexts active.

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

inline

Get the number of event types defined in the Engine.

Returns: The number of event types.

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

inline

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

Returns: The number of events received.

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

inline

Get the total number of events on input contexts' queues.

Returns: The number of events queued.

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

inline

Get the number of Java (JMon) Applications defined in the Engine.

Returns: The number of Java Applications.

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

inline

Get the number of active listeners.

Returns: The number of active listeners.

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

inline

Get the number of monitors defined in the Engine.

Returns: The number of monitors defined.

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

inline

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

This correpsonds to the number of MonitorScript emit commands executed.

Returns: The number of events emitted.

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

inline

Get the number of events waiting on the output queue.

Returns: The number of events waiting.

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

inline

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, and can be dropped by the output queue.

Returns: The number of events sent.

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

inline

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

Returns: The number of events processed.

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

inline

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

If a monitor spawns it creates a new process.

Returns: The number of monitor processes.

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

inline

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

Returns: The number of waiting events.

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

inline

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

Returns: The number of waiting events.

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

inline

Get the number of events received since the Engine started.

Returns: The number of events received.

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

inline

Get the number of active sub-listeners.

Returns: The number of sub-listeners.

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.

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.

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

inline

Get the name of the slowest receiver.

Returns: The slowest receiver.

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

inline

Get the queue size of the slowest receiver.

Returns: The size of the slowest queue.

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

inline

Get the standard status values, formatted for terminal output.

Returns: The standard status values.

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

inline

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

Returns: The standard status values.

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

inline

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

Returns: The uptime of the Engine.

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.

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.

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.

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.

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.

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.

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.

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.

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

inline

Copy assignment.

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

inline

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

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:

engine_client_cpp.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation