DDS_MonitoringPeriodicDistributionSettings Struct Reference

Configures the distribution of periodic metrics. More...

Public Attributes
char *	datawriter_qos_profile_name
	The fully qualified name of the profile used to configure the DDSDataWriter that distributes periodic metrics. More...
struct DDS_ThreadSettings_t	thread
	The settings of the periodic metric thread. More...
struct DDS_Duration_t	polling_period
	Period at which the periodic metric thread polls and publishes the periodic metrics. More...

Detailed Description

Configures the distribution of periodic metrics.

Periodic metrics change often, and they are polled and published periodically by a thread created by the RTI Observability Library.

The RTI Observability Library obtains periodic metrics by polling the current value of periodic statuses such as DDS_DataWriterProtocolStatus.

Member Data Documentation

datawriter_qos_profile_name

char* DDS_MonitoringPeriodicDistributionSettings::datawriter_qos_profile_name

The fully qualified name of the profile used to configure the DDSDataWriter that distributes periodic metrics.

The DDSDataWriter Topic is RTI_MONITORING_PERIODIC_TOPIC_NAME.

If NULL (the default value), then the RTI Observability Library uses DDS_PROFILE_GENERIC_OBSERVABILITY.

[default] NULL

thread

struct DDS_ThreadSettings_t DDS_MonitoringPeriodicDistributionSettings::thread

The settings of the periodic metric thread.

The periodic metric thread periodically polls and publishes periodic event metrics.

The thread runs at the period configured using DDS_MonitoringPeriodicDistributionSettings::polling_period.

[default] DDS_THREAD_SETTINGS_DEFAULT

polling_period

struct DDS_Duration_t DDS_MonitoringPeriodicDistributionSettings::polling_period

Period at which the periodic metric thread polls and publishes the periodic metrics.

[default] 5 seconds

[range] > 0 seconds