Apama.Engine.EngineStatus Class Reference

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

Public Member Functions
bool	getUserBool (string key)
	Get a user value of type bool. Parameters key The user status to look up. Returns The value of the the status. Exceptions Apama.Engine.EngineException Thrown when the key cannot be found or there is a type mismatch. More...
bool	getUserBoolOr (string key, bool alt)
	Get a user value of type bool or the alt value if it cannot be found. Parameters key The user status to look up. alt The alternate value. Returns The value of the the status or the alternate value if the key does not exist. Exceptions Apama.Engine.EngineException Thrown when there is a type mismatch. More...
float	getUserFloat (string key)
	Get a user value of type float. Parameters key The user status to look up. Returns The value of the the status. Exceptions Apama.Engine.EngineException Thrown when the key cannot be found or there is a type mismatch. More...
float	getUserFloatOr (string key, float alt)
	Get a user value of type float or the alt value if it cannot be found. Parameters key The user status to look up. alt The alternate value. Returns The value of the the status or the alternate value if the key does not exist. Exceptions Apama.Engine.EngineException Thrown when there is a type mismatch. More...
int	getUserInt (string key)
	Get a user value of type int. Parameters key The user status to look up. Returns The value of the the status. Exceptions Apama.Engine.EngineException Thrown when the key cannot be found or there is a type mismatch. More...
int	getUserIntOr (string key, int alt)
	Get a user value of type int or the alt value if it cannot be found. Parameters key The user status to look up. alt The alternate value. Returns The value of the the status or the alternate value if the key does not exist. Exceptions Apama.Engine.EngineException Thrown when there is a type mismatch. More...
string	getUserString (string key)
	Get a user value of type string. Parameters key The user status to look up. Returns The value of the the status. Exceptions Apama.Engine.EngineException Thrown when the key cannot be found or there is a type mismatch. More...
string	getUserStringOr (string key, string alt)
	Get a user value of type string or the alt value if it cannot be found. Parameters key The user status to look up. alt The alternate value. Returns The value of the the status or the alternate value if the key does not exist. Exceptions Apama.Engine.EngineException Thrown when there is a type mismatch. More...
override string	ToString ()
	Retrieve the event's type and its contents as a string. More...

Properties
Dictionary< string, string >	AllValues [get]
	Get the dictionary of all status items. More...
string	MostBackedUpInput [get]
	Get the name of the most backed up context. Returns The name of the slowest context. More...
uint	MostBackedUpQSize [get]
	Get the queue size of the most backed up context. Returns The size of the slowest context's queue. More...
uint	NumConsumers [get]
	Get the number of event consumers connected to the engine. Returns The number of event consumers. More...
uint	NumContexts [get]
	Get the number of contexts active in the Engine. Returns The number of contexts active. More...
uint	NumEventTypes [get]
	Get the number of event types defined. Returns The number of event types. More...
ulong	NumFastTracked [get]
	Get the number of events received on the internal input queue since the Engine started. Returns The number of events received. More...
uint	NumInputQueuedInput [get]
	Get the total number of events waiting on input contexts' input queues. Returns The number of events queued. More...
uint	NumJavaApplications [get]
	Get the number of java applications defined in the Engine. Returns The number of Java Applications. More...
uint	NumListeners [get]
	Get the number of active listeners. Returns The number of active listeners. More...
uint	NumMonitors [get]
	Get the number of monitors defined in the Engine. Returns The number of monitors defined. More...
ulong	NumOutEventsCreated [get]
	Gets the number of output events which have been put onto the output queue. This corresponds to the number of MonitorScript emit commands executed. Returns The number of events emitted. More...
uint	NumOutEventsQueued [get]
	Get the number of events waiting on the output queue. Returns The number of events waiting. More...
ulong	NumOutEventsSent [get]
	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. Returns The number of events sent. More...
ulong	NumProcessed [get]
	Get the number of events taken off the input queue and processed since the Engine started. Returns The number of monitor processes. More...
uint	NumProcesses [get]
	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. More...
uint	NumQueuedFastTrack [get]
	Get the number of events waiting on the internal input queue. Returns The number of waiting events. More...
uint	NumQueuedInput [get]
	Get the number of events waiting on the input queue. Returns The number of waiting events. More...
ulong	NumReceived [get]
	Get the number of events received since the Engine started (including those discarded because they were invalid) Returns The number of events received. More...
uint	NumSubListeners [get]
	Get the number of active sub-listeners. Returns The number of sub-listeners. More...
string	SlowestReceiver [get]
	Get the name of the slowest receiver. Returns The slowest receiver. More...
uint	SlowestReceiverQueueSize [get]
	Get the size of the slowest receiver's queue. Returns The size of the slowest queue. More...
ulong	Uptime [get]
	Get the time in ms that the Engine has been running for. Returns Return the uptime of the Engine. More...

Detailed Description

EngineStatus represents the operational status of the Engine.

Member Function Documentation

bool Apama.Engine.EngineStatus.getUserBool

(

string

key

)

Get a user value of type bool.

Parameters

key	The user status to look up.

Returns

The value of the the status.

Exceptions

Apama.Engine.EngineException

Thrown when the key cannot be found or there is a type mismatch.

bool Apama.Engine.EngineStatus.getUserBoolOr	(	string	key,
		bool	alt
	)

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

Parameters

key	The user status to look up.
alt	The alternate value.

Returns

The value of the the status or the alternate value if the key does not exist.

Exceptions

Apama.Engine.EngineException

Thrown when there is a type mismatch.

float Apama.Engine.EngineStatus.getUserFloat

(

string

key

)

Get a user value of type float.

Parameters

key	The user status to look up.

Returns

The value of the the status.

Exceptions

Apama.Engine.EngineException

Thrown when the key cannot be found or there is a type mismatch.

float Apama.Engine.EngineStatus.getUserFloatOr	(	string	key,
		float	alt
	)

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

Parameters

key	The user status to look up.
alt	The alternate value.

Returns

The value of the the status or the alternate value if the key does not exist.

Exceptions

Apama.Engine.EngineException

Thrown when there is a type mismatch.

int Apama.Engine.EngineStatus.getUserInt

(

string

key

)

Get a user value of type int.

Parameters

key	The user status to look up.

Returns

The value of the the status.

Exceptions

Apama.Engine.EngineException

Thrown when the key cannot be found or there is a type mismatch.

int Apama.Engine.EngineStatus.getUserIntOr	(	string	key,
		int	alt
	)

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

Parameters

key	The user status to look up.
alt	The alternate value.

Returns

The value of the the status or the alternate value if the key does not exist.

Exceptions

Apama.Engine.EngineException

Thrown when there is a type mismatch.

string Apama.Engine.EngineStatus.getUserString

(

string

key

)

Get a user value of type string.

Parameters

key	The user status to look up.

Returns

The value of the the status.

Exceptions

Apama.Engine.EngineException

Thrown when the key cannot be found or there is a type mismatch.

string Apama.Engine.EngineStatus.getUserStringOr	(	string	key,
		string	alt
	)

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

Parameters

key	The user status to look up.
alt	The alternate value.

Returns

The value of the the status or the alternate value if the key does not exist.

Exceptions

Apama.Engine.EngineException

Thrown when there is a type mismatch.

override string Apama.Engine.EngineStatus.ToString

(

)

Retrieve the event's type and its contents as a string.

Returns

C style string with the event's textual representation.

Property Documentation

Dictionary<string, string> Apama.Engine.EngineStatus.AllValues

get

Get the dictionary of all status items.

string Apama.Engine.EngineStatus.MostBackedUpInput

get

Get the name of the most backed up context.

Returns

The name of the slowest context.

uint Apama.Engine.EngineStatus.MostBackedUpQSize

get

Get the queue size of the most backed up context.

Returns

The size of the slowest context's queue.

uint Apama.Engine.EngineStatus.NumConsumers

get

Get the number of event consumers connected to the engine.

Returns

The number of event consumers.

uint Apama.Engine.EngineStatus.NumContexts

get

Get the number of contexts active in the Engine.

Returns

The number of contexts active.

uint Apama.Engine.EngineStatus.NumEventTypes

get

Get the number of event types defined.

Returns

The number of event types.

ulong Apama.Engine.EngineStatus.NumFastTracked

get

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

Returns

The number of events received.

uint Apama.Engine.EngineStatus.NumInputQueuedInput

get

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

Returns

The number of events queued.

uint Apama.Engine.EngineStatus.NumJavaApplications

get

Get the number of java applications defined in the Engine.

Returns

The number of Java Applications.

uint Apama.Engine.EngineStatus.NumListeners

get

Get the number of active listeners.

Returns

The number of active listeners.

uint Apama.Engine.EngineStatus.NumMonitors

get

Get the number of monitors defined in the Engine.

Returns

The number of monitors defined.

ulong Apama.Engine.EngineStatus.NumOutEventsCreated

get

Gets the number of output events which have been put onto the output queue. This corresponds to the number of MonitorScript emit commands executed.

Returns

The number of events emitted.

uint Apama.Engine.EngineStatus.NumOutEventsQueued

get

Get the number of events waiting on the output queue.

Returns

The number of events waiting.

ulong Apama.Engine.EngineStatus.NumOutEventsSent

get

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.

Returns

The number of events sent.

ulong Apama.Engine.EngineStatus.NumProcessed

get

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

Returns

The number of monitor processes.

uint Apama.Engine.EngineStatus.NumProcesses

get

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.

uint Apama.Engine.EngineStatus.NumQueuedFastTrack

get

Get the number of events waiting on the internal input queue.

Returns

The number of waiting events.

uint Apama.Engine.EngineStatus.NumQueuedInput

get

Get the number of events waiting on the input queue.

Returns

The number of waiting events.

ulong Apama.Engine.EngineStatus.NumReceived

get

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

Returns

The number of events received.

uint Apama.Engine.EngineStatus.NumSubListeners

get

Get the number of active sub-listeners.

Returns

The number of sub-listeners.

string Apama.Engine.EngineStatus.SlowestReceiver

get

Get the name of the slowest receiver.

Returns

The slowest receiver.

uint Apama.Engine.EngineStatus.SlowestReceiverQueueSize

get

Get the size of the slowest receiver's queue.

Returns

The size of the slowest queue.

ulong Apama.Engine.EngineStatus.Uptime

get

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

Returns

Return the uptime of the Engine.