#include <EventTransport.h>

Public Attributes
AP_char8 *	status
	Free form text string containing a transport specific status message. More...

AP_uint64	totalReceived
	Total number of downstream events received since IAF was run. More...

AP_uint64	totalSent
	Total number of upstream events since the IAF was run. More...

AP_NormalisedEvent *	statusDictionary
	Additional status information about this transport. More...

Detailed Description

AP_EventTransportStatus.

Transport status information structure, filled in by the getStatus call.

The first field (status) is a free-form text string that the transport can use to report any custom status information it might have. The iaf_watch tool will display the contents of this string. Note that the length of the status string is limited, currently to 1024 characters. Longer strings will be silently truncated. The next two fields (totalReceived and totalSent) report the total number of events received and sent by the transport. The last field, a pointer to an AP_NormalisedEvent, can contain custom information such as the state of the adapter.

Member Data Documentation

◆ status

AP_char8* AP_EventTransportStatus::status

Free form text string containing a transport specific status message.

Strings longer than 1024 will be truncated

◆ statusDictionary

AP_NormalisedEvent* AP_EventTransportStatus::statusDictionary

Additional status information about this transport.

Standard statusDictionary keys are


VERSION=transport_version_string
CONFIG_VERSION=config_version_string
CONNECTION=connectionGeneration (If the adapter manages only one connection)
or
CONNECTION_connectionId=connectionGeneration (If the adpater manages multiple connections)

◆ totalReceived

AP_uint64 AP_EventTransportStatus::totalReceived

Total number of downstream events received since IAF was run.

◆ totalSent

AP_uint64 AP_EventTransportStatus::totalSent

Total number of upstream events since the IAF was run.

The documentation for this struct was generated from the following file: