|
RTI Connext Modern C++ API Version 7.7.0
|
<<extension>> Configures the usage of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data. More...
#include <rti/core/PolicySettings.hpp>
Public Member Functions | |
| MonitoringDedicatedParticipantSettings () | |
| Creates an instance with the default settings. More... | |
| MonitoringDedicatedParticipantSettings & | enable (bool the_enable) |
| <<basic>> <<extension>> Enables the use of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data. More... | |
| bool | enable () const |
| Getter (see setter with the same name). More... | |
| MonitoringDedicatedParticipantSettings & | domain_id (int32_t the_domain_id) |
| <<basic>> <<extension>> The domain ID used in the creation of RTI Monitoring Library 2.0 dds::domain::DomainParticipant. More... | |
| int32_t | domain_id () const |
| Getter (see setter with the same name). More... | |
| MonitoringDedicatedParticipantSettings & | participant_qos_profile_name (const rti::core::optional_value< std::string > &the_participant_qos_profile_name) |
| Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data. More... | |
| MonitoringDedicatedParticipantSettings & | participant_qos_profile_name (const char *the_participant_qos_profile_name) |
| Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data. More... | |
| rti::core::optional_value< std::string > | participant_qos_profile_name () const |
| Getter (see setter with the same name). More... | |
| MonitoringDedicatedParticipantSettings & | collector_initial_peers (const dds::core::StringSeq &the_collector_initial_peers) |
| Determines the initial list of peers that the discovery process will contact to send announcements about the presence of the rti::core::MonitoringDistributionSettings::dedicated_participant. More... | |
| dds::core::StringSeq | collector_initial_peers () const |
| Getter (see setter with the same name) More... | |
<<extension>> Configures the usage of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data.
|
inline |
Creates an instance with the default settings.
| MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::enable | ( | bool | the_enable | ) |
<<basic>> <<extension>> Enables the use of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data.
Setting this value to false is not currently supported.
[default] true
| bool rti::core::MonitoringDedicatedParticipantSettings::enable | ( | ) | const |
Getter (see setter with the same name).
| MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::domain_id | ( | int32_t | the_domain_id | ) |
<<basic>> <<extension>> The domain ID used in the creation of RTI Monitoring Library 2.0 dds::domain::DomainParticipant.
By default, the RTI Monitoring Library 2.0 DomainParticipant is created in domain 101 with the domain tag 'RTI_o11y'. The domain tag provides further isolation in case the application also uses domain 101.
The domain ID can be changed using this field. Changing the domain tag is not recommended. However, if you need to change it, you must do so by configuring the domain tag in the dds::domain::qos::DomainParticipantQos of the profile set in rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name.
[default] 101
| int32_t rti::core::MonitoringDedicatedParticipantSettings::domain_id | ( | ) | const |
Getter (see setter with the same name).
| MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name | ( | const rti::core::optional_value< std::string > & | the_participant_qos_profile_name | ) |
Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data.
| the_participant_qos_profile_name | An optional string. An unset value indicates that the RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2(). |
[default] Unset
If not set (the default value) then RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2().
| MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name | ( | const char * | the_participant_qos_profile_name | ) |
Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data.
| the_participant_qos_profile_name | The profile name. Cannot be NULL. |
If not set (the default value) then RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2().
| rti::core::optional_value< std::string > rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name | ( | ) | const |
Getter (see setter with the same name).
| MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::collector_initial_peers | ( | const dds::core::StringSeq & | the_collector_initial_peers | ) |
Determines the initial list of peers that the discovery process will contact to send announcements about the presence of the rti::core::MonitoringDistributionSettings::dedicated_participant.
| the_collector_initial_peers | The initial peers. |
These initial peers should correspond with the RTI Observability Collector Service with which RTI Monitoring Library 2.0 has to communicate. The collector_initial_peers works the same as initial_peers for other DomainParticipants, except that it allows you to easily specify the initial peer(s) for the RTI Monitoring Library 2.0 dds::domain::DomainParticipant, which may have different initial peer(s) than those used by your application.
If no collector_initial_peers are specified, or if it is explicitly set to an empty list, the rti::core::policy::Discovery::initial_peers(const dds::core::StringSeq & the_initial_peers) list of rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name will be used as the initial peers of rti::core::MonitoringDistributionSettings::dedicated_participant.
[default] An empty sequence.
| dds::core::StringSeq rti::core::MonitoringDedicatedParticipantSettings::collector_initial_peers | ( | ) | const |
Getter (see setter with the same name)