Input events
The IAFStatusManager is a subscription based interface. This means that a consumer of adapter status information, such as an application service monitor, needs to send the input events
AdapterStatusRegister and
AdapterStatusDeregister events to register or deregister as a consumer for adapter status information. Once a subscription is made to the IAFStatusManager, the IAFStatusManager periodically receives information from the adapter and begins sending status information to the registered consumer in the form of output events — see
Output events.
The IAFStatusManager defines the following input events:
AdapterStatusRegister — An event sent by a client that is interested in receiving status events from the specified codec and transports. The fields of this event uniquely identify a subscription.
event AdapterStatusRegister {
string adapterName;
string codec;
string transport;
string codecVersion;
string transportVersion;
string configVersion;
string channel;
}
The fields of the AdapterStatusRegister event are:
adapterName — An identifier that will be used to refer to this transport and codec pair when registering, deregistering or monitoring adapter status.
codec — The name of the adapter’s codec as it is specified in the adapter configuration file.
transport — The name of the adapter’s transport as it is specified in the adapter configuration file.
codecVersion — The codec version that the client depends on, or an empty string ("") if the client can use any version of the codec.
transportVersion — The transport version that the client depends on, or an empty string ("") if the client can use any version of the transport.
configVersion — The value of this field can be empty, but if a value is specified it must agree with the
CONFIG_VERSION key returned in the
ExtendedTransportStatus or
ExtendedCodecStatus object (for Java) or in the
statusDictionary of an
AP_EventTransportStatus or
AP_EventCodecStatus (for C++).
channel — The name of the channel the IAF adapter is receiving events from.
AdapterStatusDeregister — An event sent by a client to unregister its subsciption for status events.
event AdapterStatusDeregister {
string adapterName;
}
The adapterName field is the identifier used to refer to this transport and codec pair when deregistering
.
Copyright © 2013
Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.