Output events
Once a consumer of status information (such as an application service monitor) is registered with the IAFStatusManager, it begins to receive status information in the form of IAFStatusManager output events. Output events include connection information, adapter availability, and any custom information put into the dictionary by the transport or codec. For more information about adding custom information, see
Connections and other custom properties.
The IAFStatusManager defines the following output events:
AdapterUp — An event routed from the IAF Signaling Service to notify that the adapter is up.
event AdapterUp {
string adapterName;
float latency;
dictionary<string, string> codecStatus;
dictionary<string, string> transportStatus;
}
The fields of the AdapterUp event are:
adapterName — This is the identifier used to refer to this transport and codec pair when monitoring adapter status.
latency — This is the difference (in seconds) between the time a request for status is sent from the IAFStatusManager to the IAF and the time the correlator receives the response.
codecStatus — Contains information about the adatper’s codec. Standard keys are
VERSION,
CONFIG_VERSION, and
CONNECTION (or in the case of multiple connections, keys of the form
CONNECTION_connectionName).
transportStatus — Contains information about the adatper’s transport. Standard keys are
VERSION,
CONFIG_VERSION, and
CONNECTION (or in the case of multiple connections, keys of the form
CONNECTION_connectionName).
AdapterError — An event routed from the IAF Signaling Service to tell that there was an error getting the status of the adapter.
event AdapterError {
string adapterName;
string description;
}
The fields of the AdapterError event are:
adapterName — This is the identifier used to refer to this transport and codec pair when monitoring adapter status.
description — A free form string describing the problem.
ConnectionClosed — An event routed when the IAF Signaling Service discovers that the adapter’s connection to an external service is closed.
event ConnectionClosed {
string adapterName;
string connectionName;
string connectionGeneration;
}
The fields of the ConnectionClosed event are:
adapterName — This is the identifier used to refer to this transport and codec pair when monitoring adapter status.
connectionName — This is a unique identifier for the connection. If the adapter manages more than one connection, this will be the connection name returned by the adapter as a
CONNECTION_connectionName getStatus key (but without the
CONNECTION_ prefix), or "" if the adapter only manages one connection. The
connectionName is often a number but could be a string. One event will be sent for each connection the adapter manages.
connectionGeneration — This identifies a successful connection attempt. If the connection fails, and then is successfully connected again, this will change. The
connectionGeneration is often a number that is initialized with a timestamp when the adapter is created, then incremented every time it reconnects.
ConnectionOpened — An event routed when the IAF Signaling Service discovers that the adapter’s connection to an external service is established.
event ConnectionOpened {
string adapterName;
string connectionName;
string connectionGeneration;
}
The fields of the ConnectionOpened event are:
adapterName — This is the identifier used to refer to this transport and codec pair when monitoring adapter status.
connectionName — This is a unique identifier for the connection. If the adapter manages more than one connection, this will be the connection name returned by the adapter as a
CONNECTION_connectionName getStatus key (but without the
CONNECTION_ prefix), or "" if the adapter only manages one connection. The
connectionName is often a number but could be a string. One event will be sent for each connection the adapter manages.
connectionGeneration — This identifies a successful connection attempt. If the connection fails, and then is successfully connected again, this will change. The connectionGeneration is often a number that is initialized with a timestamp when the adapter is created, then incremented every time it reconnects.