Status

com.apama.statusreport
Event Status

Sent from the service monitor to the StatusReport channel to notify the application of status for a subscribed item.

Constant summary
`string`	`CHANNEL := "StatusReport"` The channel to subscribe to for receiving this event.

Field summary
`string`	`serviceID` Service ID to subscribe to - blank will target all services.
`string`	`object` Object to request status of.
`string`	`subServiceID` SubService ID to subscribe to.
`string`	`connection` Connection to subscribe to.
`string`	`description` Status description.
`sequence<string>`	`summaries` A sequence of summary strings specifying information about the status of the specified object.
`boolean`	`available` True if the object is "available" - the exact meaning is adapter specific; for example, connected, open for general orders, etc.
`dictionary<string, string>`	`extraParams` Extra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "Username", "CloseTime", etc.

Constant detail

CHANNEL

string CHANNEL := "StatusReport"

The channel to subscribe to for receiving this event.

Field detail

available

boolean available

True if the object is "available" - the exact meaning is adapter specific; for example, connected, open for general orders, etc.

connection

string connection

Connection to subscribe to.

Some services may expose several services. The interpretation of this string is adapter-specific.

description

string description

Status description.

A free-form text string giving a description of the status.

extraParams

dictionary<string, string> extraParams

Extra parameters that do not map into any of the above. Convention is that keys are in TitleCase. e.g. "Username", "CloseTime", etc.

object

string object

Object to request status of.

This may include: "Connection" - whether connected or not "MarketState" - a market may be "Open", "Closed", or other states

serviceID

string serviceID

Service ID to subscribe to - blank will target all services.

subServiceID

string subServiceID

SubService ID to subscribe to.

Some services may expose several services. The interpretation of this string is adapter-specific.

summaries

sequence<string> summaries

A sequence of summary strings specifying information about the status of the specified object.

This will be a well recognized sequence of words - for example, a financial market's "MarketState" may be "Open", "Closed", "PreOpen", etc. A Connection may be "Connected", "Disconnected", "Disconnected LoginFailed", "Disconnected TimedOut", etc.

com.apama.statusreportEvent Status