RTI Connext C API Version 7.4.0
All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
DDS_MonitoringPeriodicDistributionSettings Struct Reference

<<extension>> Configures the distribution of periodic metrics. More...

Data Fields

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

Detailed Description

<<extension>> Configures the distribution of periodic metrics.

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

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

The periodic metrics that will be distributed for an observable resource can be configured with DDS_MonitoringTelemetryData::metrics.

Field Documentation

◆ datawriter_qos_profile_name

char* DDS_MonitoringPeriodicDistributionSettings::datawriter_qos_profile_name

<<extension>> The fully qualified name of the profile used to configure the DDS_DataWriter that distributes periodic metrics.

The DDS_DataWriter Topic is RTI_MONITORING_PERIODIC_TOPIC_NAME.

If NULL (the default value), then RTI Monitoring Library 2.0 uses DDS_PROFILE_GENERIC_MONITORING2.

[default] NULL

Categories
Mutable, Debuggability, QoS Profile Management

◆ thread

struct DDS_ThreadSettings_t DDS_MonitoringPeriodicDistributionSettings::thread

<<extension>> 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

Categories
Mutable, Debuggability, Concurrency

◆ polling_period

struct DDS_Duration_t DDS_MonitoringPeriodicDistributionSettings::polling_period

<<basic>> <<extension>> Period at which the periodic metric thread polls and publishes the periodic metrics.

[default] 5 seconds

[range] > 0 seconds

Categories
Mutable, Debuggability, Data Availability