EngineStatus represents the operational status of a correlator. More...

Public Member Functions
bool	getUserBool (string key)
	Get a user value of type bool. More...

bool	getUserBoolOr (string key, bool alt)
	Get a user value of type bool or the alt value if it cannot be found. More...

float	getUserFloat (string key)
	Get a user value of type float. More...

float	getUserFloatOr (string key, float alt)
	Get a user value of type float or the alt value if it cannot be found. More...

int	getUserInt (string key)
	Get a user value of type int. More...

int	getUserIntOr (string key, int alt)
	Get a user value of type int or the alt value if it cannot be found. More...

string	getUserString (string key)
	Get a user value of type string. More...

string	getUserStringOr (string key, string alt)
	Get a user value of type string or the alt value if it cannot be found. More...

override string	ToString ()
	A multi-line string representation of this EngineStatus. More...

Properties
Dictionary< string, string >	AllValues `[get]`
	A dictionary of all status items. More...

string	MostBackedUpInput `[get]`
	The name of the slowest context. More...

uint	MostBackedUpQSize `[get]`
	The number of events on the slowest context's queue, as identified by the name of the slowest context. More...

uint	NumConsumers `[get]`
	The number of external consumers/receivers connected to receive emitted events. More...

uint	NumContexts `[get]`
	The number of contexts in the correlator, including the main context. More...

uint	NumEventTypes `[get]`
	The number of event types defined within the correlator. More...

ulong	NumFastTracked `[get]`
	The number of events that have been routed across all contexts since the correlator was started. More...

uint	NumInputQueuedInput `[get]`
	The number of events on the input queues of all public contexts. More...

uint	NumJavaApplications `[get]`
	The number of Java applications and Java EPL plug-ins loaded in the correlator. More...

uint	NumListeners `[get]`
	The number of listeners in all contexts. More...

uint	NumMonitors `[get]`
	The number of EPL monitor definitions injected into the correlator. More...

ulong	NumOutEventsCreated `[get]`
	The number of events that have been sent or emitted to channels which have at least one external consumer/receiver subscribed. More...

uint	NumOutEventsQueued `[get]`
	The number of events waiting on output queues to be dispatched to any connected external consumers/receivers. More...

ulong	NumOutEventsSent `[get]`
	The number of events that have been delivered to external consumers/receivers. This counts for each external consumer/receiver an event is sent to. More...

ulong	NumProcessed `[get]`
	The number of events processed by the correlator in all contexts. More...

uint	NumProcesses `[get]`
	The number of monitor instances, also known as sub-monitors. More...

uint	NumQueuedFastTrack `[get]`
	The sum of routed events on the route queues of all contexts. More...

uint	NumQueuedInput `[get]`
	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. More...

ulong	NumReceived `[get]`
	The number of events that the correlator has received from external sources since the correlator started. More...

uint	NumSubListeners `[get]`
	The number of sub-event-listeners that are active across all contexts. More...

string	SlowestReceiver `[get]`
	The name of the consumer/receiver with the largest number of incoming events waiting to be processed. More...

uint	SlowestReceiverQueueSize `[get]`
	The number of events on the slowest consumer's/receiver's queue, as identified by the name of the slowest consumer/receiver. More...

ulong	Uptime `[get]`
	The time in milliseconds since the correlator was started. More...

Detailed Description

EngineStatus represents the operational status of a correlator.

Member Function Documentation

◆ getUserBool()

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.

◆ getUserBoolOr()

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.

◆ getUserFloat()

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.

◆ getUserFloatOr()

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.

◆ getUserInt()

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.

◆ getUserIntOr()

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.

◆ getUserString()

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.

◆ getUserStringOr()

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.

◆ ToString()

override string Apama.Engine.EngineStatus.ToString ( )

A multi-line string representation of this EngineStatus.

Returns: A string representation of this EngineStatus.

Property Documentation

◆ AllValues

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

get

A dictionary of all status items.

◆ MostBackedUpInput

string Apama.Engine.EngineStatus.MostBackedUpInput

get

The name of the slowest context.

◆ MostBackedUpQSize

uint Apama.Engine.EngineStatus.MostBackedUpQSize

get

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

◆ NumConsumers

uint Apama.Engine.EngineStatus.NumConsumers

get

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

◆ NumContexts

uint Apama.Engine.EngineStatus.NumContexts

get

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

◆ NumEventTypes

uint Apama.Engine.EngineStatus.NumEventTypes

get

The number of event types defined within the correlator.

◆ NumFastTracked

ulong Apama.Engine.EngineStatus.NumFastTracked

get

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

◆ NumInputQueuedInput

uint Apama.Engine.EngineStatus.NumInputQueuedInput

get

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

◆ NumJavaApplications

uint Apama.Engine.EngineStatus.NumJavaApplications

get

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

◆ NumListeners

uint Apama.Engine.EngineStatus.NumListeners

get

The number of listeners in all contexts.

◆ NumMonitors

uint Apama.Engine.EngineStatus.NumMonitors

get

The number of EPL monitor definitions injected into the correlator.

◆ NumOutEventsCreated

ulong Apama.Engine.EngineStatus.NumOutEventsCreated

get

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

◆ NumOutEventsQueued

uint Apama.Engine.EngineStatus.NumOutEventsQueued

get

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

◆ NumOutEventsSent

ulong Apama.Engine.EngineStatus.NumOutEventsSent

get

The number of events that have been delivered to external consumers/receivers. This counts for each external consumer/receiver an event is sent to.

◆ NumProcessed

ulong Apama.Engine.EngineStatus.NumProcessed

get

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

◆ NumProcesses

uint Apama.Engine.EngineStatus.NumProcesses

get

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

◆ NumQueuedFastTrack

uint Apama.Engine.EngineStatus.NumQueuedFastTrack

get

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

◆ NumQueuedInput

uint Apama.Engine.EngineStatus.NumQueuedInput

get

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.

◆ NumReceived

ulong Apama.Engine.EngineStatus.NumReceived

get

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

◆ NumSubListeners

uint Apama.Engine.EngineStatus.NumSubListeners

get

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

◆ SlowestReceiver

string Apama.Engine.EngineStatus.SlowestReceiver

get

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

◆ SlowestReceiverQueueSize

uint Apama.Engine.EngineStatus.SlowestReceiverQueueSize

get

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

◆ Uptime

ulong Apama.Engine.EngineStatus.Uptime

get

The time in milliseconds since the correlator was started.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ getUserBool()

◆ getUserBoolOr()

◆ getUserFloat()

◆ getUserFloatOr()

◆ getUserInt()

◆ getUserIntOr()

◆ getUserString()

◆ getUserStringOr()

◆ ToString()

Property Documentation

◆ AllValues

◆ MostBackedUpInput

◆ MostBackedUpQSize

◆ NumConsumers

◆ NumContexts

◆ NumEventTypes

◆ NumFastTracked

◆ NumInputQueuedInput

◆ NumJavaApplications

◆ NumListeners

◆ NumMonitors

◆ NumOutEventsCreated

◆ NumOutEventsQueued

◆ NumOutEventsSent

◆ NumProcessed

◆ NumProcesses

◆ NumQueuedFastTrack

◆ NumQueuedInput

◆ NumReceived

◆ NumSubListeners

◆ SlowestReceiver

◆ SlowestReceiverQueueSize

◆ Uptime