#include <IAF_TimestampConfig.h>

Public Attributes
AP_bool	recordUpstream
	If true, the plug-in should record timestamps for all upstream events it processes, and pass these along to the upstream component, if any. More...

AP_bool	recordDownstream
	If true, the plug-in should record timestamps for all downstream events it processes, and pass these along to the downstream component, if any. More...

AP_bool	logUpstream
	If true, the plug-in should log the latency for all upstream events it it processes, at the logging level given by the logLevel member. More...

AP_bool	logDownstream
	If true, the plug-in should log the latency for all downstream events it processes, at the logging level given by the logLevel member. More...

AP_bool	logRoundtrip
	If true, the plug-in should log the "round trip" latency for all events it processes in either direction, if possible. More...

Detailed Description

IAF_TimestampConfig.

Structure to hold per-plugin (transport, codec and Semantic Mapper) timestamp-handling settings passed in from the configuration file.

Member Data Documentation

◆ logDownstream

AP_bool IAF_TimestampConfig::logDownstream

If true, the plug-in should log the latency for all downstream events it processes, at the logging level given by the logLevel member.

A plug-in may implicitly enable downstream timestamp recording if downstream logging is enabled.

◆ logRoundtrip

AP_bool IAF_TimestampConfig::logRoundtrip

If true, the plug-in should log the "round trip" latency for all events it processes in either direction, if possible.

At its simplest, the round trip latency can just be the difference between the largest and smallest timestamps passed to the plug-in, or an individual plug-in may choose to present some more plug-in-specific latency number. As with the other logging options, the logging level given by the logLevel member should be used.

◆ logUpstream

AP_bool IAF_TimestampConfig::logUpstream

If true, the plug-in should log the latency for all upstream events it it processes, at the logging level given by the logLevel member.

A plug-in may enable upstream timestamp recording if upstream logging is enabled

◆ recordDownstream

AP_bool IAF_TimestampConfig::recordDownstream

If true, the plug-in should record timestamps for all downstream events it processes, and pass these along to the downstream component, if any.

◆ recordUpstream

AP_bool IAF_TimestampConfig::recordUpstream

If true, the plug-in should record timestamps for all upstream events it processes, and pass these along to the upstream component, if any.

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

IAF_TimestampConfig.h