com.apama.correlator
Event Component


EPL interface to the generic component management functionality of the correlator.
Constant Summary
 constant integerCONNECT_LEGACY := 0

Argument for attach/detachAsEventConsumer - use legacy mode. In this mode, all events are delivered in serial to the receiver on the default channel.
 constant integerCONNECT_PARALLEL := 1

Argument for attach/detachAsEventConsumer - use parallel mode. In this mode, all events are delivered in parallel per channel.
 
Action Summary
 voidstatic attachAsEventConsumerTo(string host, integer port, sequence<string > channels, boolean disconnectSlow, integer connectMode)

Connect to another Apama component to receive events on the specified channels. connectMode should be one of CONNECT_LEGACY or CONNECT_PARALLEL.
 voidstatic deleteUserStatus(string name)

Delete a specific user added status.
 voidstatic detachAsEventConsumerFrom(string host, integer port, sequence<string > channels, integer connectMode)

Disconnect from another Apama component to receive events on the specified channels. connectMode should be one of CONNECT_LEGACY or CONNECT_PARALLEL.
 stringstatic getComponentLogicalId()

Get the correlator's logical ID. This is a unique ID assigned to every correlator process at startup.
 stringstatic getComponentName()

Get the component name of the correlator.
 stringstatic getComponentPhysicalId()

Get the correlator's physical ID. This is a unique ID generated for a component.
 integerstatic getComponentPort()

Get the port the correlator is running on. This is the main port number; extra ports specified via the config file are not accessible.
 stringstatic getHostname()

Get the hostname of the server the correlator is running on.
 stringstatic getLicenseMode()

Get the current license mode of the correlator - either "nolicensefile" or "licensefilesupplied".
 integerstatic getNumberCPUs()

Get the number of CPUs the correlator has available to it.
 com.apama.correlator.EngineStatusstatic getStatus()

Get the correlator status, internal values and user added stats.
 booleanstatic isExternallyClocked()

Get whether or not correlator is running with external clocking on.
 voidstatic setUserStatus(string name, string value)

Set a specific value on a user added status, If the status doesn't already exist this will add it.
 
Constant Detail

CONNECT_LEGACY

constant integer CONNECT_LEGACY := 0
Argument for attach/detachAsEventConsumer - use legacy mode. In this mode, all events are delivered in serial to the receiver on the default channel.

CONNECT_PARALLEL

constant integer CONNECT_PARALLEL := 1
Argument for attach/detachAsEventConsumer - use parallel mode. In this mode, all events are delivered in parallel per channel.
Action Detail

attachAsEventConsumerTo

void static attachAsEventConsumerTo(string host, integer port, sequence<string > channels, boolean disconnectSlow, integer connectMode)
Connect to another Apama component to receive events on the specified channels. connectMode should be one of CONNECT_LEGACY or CONNECT_PARALLEL.
Parameters:
host
port
channels
disconnectSlow
connectMode

deleteUserStatus

void static deleteUserStatus(string name)
Delete a specific user added status.
Parameters:
name - The name of the user status value to delete.

detachAsEventConsumerFrom

void static detachAsEventConsumerFrom(string host, integer port, sequence<string > channels, integer connectMode)
Disconnect from another Apama component to receive events on the specified channels. connectMode should be one of CONNECT_LEGACY or CONNECT_PARALLEL.
Parameters:
host
port
channels
connectMode

getComponentLogicalId

string static getComponentLogicalId()
Get the correlator's logical ID. This is a unique ID assigned to every correlator process at startup.

getComponentName

string static getComponentName()
Get the component name of the correlator.

getComponentPhysicalId

string static getComponentPhysicalId()
Get the correlator's physical ID. This is a unique ID generated for a component.

getComponentPort

integer static getComponentPort()
Get the port the correlator is running on. This is the main port number; extra ports specified via the config file are not accessible.

getHostname

string static getHostname()
Get the hostname of the server the correlator is running on.

getLicenseMode

string static getLicenseMode()
Get the current license mode of the correlator - either "nolicensefile" or "licensefilesupplied".

getNumberCPUs

integer static getNumberCPUs()
Get the number of CPUs the correlator has available to it.

getStatus

com.apama.correlator.EngineStatus static getStatus()
Get the correlator status, internal values and user added stats.
Returns:
EngineStatus a representation of all status values including user added values.

isExternallyClocked

boolean static isExternallyClocked()
Get whether or not correlator is running with external clocking on.

setUserStatus

void static setUserStatus(string name, string value)
Set a specific value on a user added status, If the status doesn't already exist this will add it.

Note the value must be in string format.
Parameters:
name - The name of the user status to add.
value - The value associated with the user Status value.