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
 voidattachAsEventConsumerTo(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.
 voiddeleteUserStatus(string name)

Delete a specific user added status.
 voiddetachAsEventConsumerFrom(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.
 stringgetComponentLogicalId()

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

Get the component name of the correlator.
 stringgetComponentPhysicalId()

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

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

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

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

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

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

Get whether or not correlator is running with external clocking on.
 voidsetUserStatus(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 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 deleteUserStatus(string name)
Delete a specific user added status.
Parameters:
name - The name of the user status value to delete.

detachAsEventConsumerFrom

void 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 getComponentLogicalId()
Get the correlator's logical ID. This is a unique ID assigned to every correlator process at startup.

getComponentName

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

getComponentPhysicalId

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

getComponentPort

integer 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 getHostname()
Get the hostname of the server the correlator is running on.

getLicenseMode

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

getNumberCPUs

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

getStatus

com.apama.correlator.EngineStatus 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 isExternallyClocked()
Get whether or not correlator is running with external clocking on.

setUserStatus

void 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.