RTI Connext Traditional C++ API Version 7.3.0
DDS_MonitoringQosPolicy Struct Reference

Configures the use of RTI Monitoring Library 2.0 to collect and distribute RTI Connext telemetry data. More...

Public Attributes

DDS_Boolean enable
 Enables the collection and distribution of telemetry data for an RTI Connext application using RTI Monitoring Library 2.0. More...
 
char * application_name
 The name of the resource that represents this RTI Connext application. More...
 
struct DDS_MonitoringDistributionSettings distribution_settings
 Configures the distribution of telemetry data. More...
 
struct DDS_MonitoringTelemetryData telemetry_data
 Configures the telemetry data that will be distributed. More...
 

Detailed Description

Configures the use of RTI Monitoring Library 2.0 to collect and distribute RTI Connext telemetry data.

Member Data Documentation

◆ enable

DDS_Boolean DDS_MonitoringQosPolicy::enable

Enables the collection and distribution of telemetry data for an RTI Connext application using RTI Monitoring Library 2.0.

Note: Enabling and disabling RTI Monitoring Library 2.0 while DDS Entities are being created or deleted is not a safe operation. The entities created while RTI Monitoring Library 2.0 is being enabled may not be monitored. In that case, children entities from that entity (invisible to the library) will not be monitored either.

[default] DDS_BOOLEAN_FALSE

◆ application_name

char* DDS_MonitoringQosPolicy::application_name

The name of the resource that represents this RTI Connext application.

When this member is set to a value other than NULL , the resource identifier representing this application will be:

/applications/<application_name>

This is the resource identifier that will be used to send commands to this application from the RTI Observability Dashboards.

The application_name should be unique across the RTI Connext system; however, RTI Monitoring Library 2.0 does not currently enforce uniqueness.

When this member is set to NULL , RTI Monitoring Library 2.0 will automatically assign a resource identifier with this format:

/applications/<host_name:process_id:uuid>

[default] NULL

◆ distribution_settings

struct DDS_MonitoringDistributionSettings DDS_MonitoringQosPolicy::distribution_settings

Configures the distribution of telemetry data.

◆ telemetry_data

struct DDS_MonitoringTelemetryData DDS_MonitoringQosPolicy::telemetry_data

Configures the telemetry data that will be distributed.