#include <EventCodec.h>

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

AP_uint64	totalDecoded
	Total number of downstream events decoded since IAF was run. More...

AP_uint64	totalEncoded
	Total number of encoded events since the IAF was run. More...

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

Detailed Description

AP_EventCodecStatus.

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

The first field (status) is a free-form text string that the codec can use to report any custom status information. Note that the length of status is limited to 1024 characters. Longer strings will be silently truncated. The next two fields (totalEncoded and totalDecoded) report the total number of events processed. The final field can contain custom information such as the state of the codec.

Member Data Documentation

◆ status

AP_char8* AP_EventCodecStatus::status

Free form text string containing a codec specific status message.

Strings longer than 1024 will be truncated

◆ statusDictionary

AP_NormalisedEvent* AP_EventCodecStatus::statusDictionary

Additional status information about this codec.

Standard statusDictionary keys are


VERSION=codec_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)

◆ totalDecoded

AP_uint64 AP_EventCodecStatus::totalDecoded

Total number of downstream events decoded since IAF was run.

◆ totalEncoded

AP_uint64 AP_EventCodecStatus::totalEncoded

Total number of encoded events since the IAF was run.

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