com.apama.statusreport
Event StatusPublisher
This event is a utility that makes it easy to publish com.apama.statusreport data from any service. This allows the service to be monitored e.g. by scenarios.
It will listen to subscriptions and unsubscriptions, reference count the subscriptions and send Status events to the subscribers to indicate new status.
-
Since:
- CMF 1.1.0
-
Version:
- 10.11
-
Listens:
-
com.apama.statusreport.SubscribeStatusFromContext -
-
com.apama.statusreport.UnsubscribeStatusFromContext -
Action summary |
void |
createPublisher(string serviceID, string object, string subServiceID, string connection)
This action is used to create an instance of the status publisher. The parameters specify which subscriptions the publisher will listen to, and the values for the data it will publish. |
void |
setData(string description, sequence<string> summaries, boolean available, dictionary<string, string> extraParams)
This action is used to set the data in the Status events published. |
void |
setPublisherStatus(boolean killPublisher, string status)
This action can be used to set the status of the status stream. |
isMultiContext
boolean isMultiContext
outputContexts
dictionary<context, integer> outputContexts
routeIt
boolean routeIt
createPublisher
void createPublisher(string serviceID, string object, string subServiceID, string connection)
This action is used to create an instance of the status publisher. The parameters specify which subscriptions the publisher will listen to, and the values for the data it will publish.
-
Parameters:
-
serviceID - The serviceID to publish data on
-
object - The object to publish data on
-
subServiceID - The sub service to publish data on.
-
connection - The connection to publish data on.
-
See Also:
- SubscribeStatus - The parameters in this constructor will be used to match SubscribeData events
- Status - The parameters in this constructor will be used in the published Status events
setData
void setData(string description, sequence<string> summaries, boolean available, dictionary<string, string> extraParams)
This action is used to set the data in the Status events published.
-
Parameters:
-
description - The description published
-
summaries - The summaries published
-
available - The availability data published
-
extraParams - The extra parameters published
-
See Also:
- Status - The data that this action will publish.
setPublisherStatus
void setPublisherStatus(boolean killPublisher, string status)
This action can be used to set the status of the status stream.
-
Parameters:
-
killPublisher - Whether the status publish has terminated
-
status - The status information published
-
See Also:
- StatusError - The event that this action publishes