UserStatusChanged

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.15.1.2

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.correlator
Event UserStatusChanged

EPL event containing delta for a user-added status item.

When a user status is changed, an event of this type will be sent to the channel with the prefix "com.apama.UserStatus:" followed by the status key, for example: "com.apama.UserStatus:myStatusKey".

Therefore, to subscribe to these updates, subscribe to the appropriate channel, for example:

monitor.subscribe("com.apama.UserStatus:myStatusKey")

Additionally, a UserStatusChanged event will be sent (on the same channel described above) when a status key is added or removed. When added the previousValue will be "" and when removed the newValue will be "".

Since:: 10.2

See Also:: com.apama.correlator.EngineStatus#getUserString() - To get the current value of a user status item.; com.apama.correlator.Component#setUserStatus() - To set the value of a user status item from EPL (see documentation for information about how to set user status from connectivity plug-ins).

Member summary
`string`	`key` The key of the status item. This is the same key used in the com.apama.correlator.Component#setUserStatus() and com.apama.correlator.EngineStatus#getUserString() actions.
`string`	`previousValue` The previous value of the status item.
`string`	`newValue` The new (current) value of the status item.

Member detail

key

string key

The key of the status item. This is the same key used in the com.apama.correlator.Component#setUserStatus() and com.apama.correlator.EngineStatus#getUserString() actions.

newValue

string newValue

The new (current) value of the status item.

previousValue

string previousValue

The previous value of the status item.