RTI Connext Modern C++ API  Version 6.1.0
rti::core::policy::DiscoveryConfig Class Reference

<<extension>> Configures the discovery mechanism More...

#include <rti/core/policy/CorePolicy.hpp>

Public Member Functions

 DiscoveryConfig ()
 Creates the default policy. More...
 
DiscoveryConfigparticipant_liveliness_lease_duration (const dds::core::Duration &the_participant_liveliness_lease_duration)
 The liveliness lease duration for the participant. More...
 
dds::core::Duration participant_liveliness_lease_duration () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigparticipant_liveliness_assert_period (const dds::core::Duration &the_participant_liveliness_assert_period)
 The period to assert liveliness for the participant. More...
 
dds::core::Duration participant_liveliness_assert_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigremote_participant_purge_kind (RemoteParticipantPurgeKind the_remote_participant_purge_kind)
 The participant's behavior for maintaining knowledge of remote participants (and their contained entities) with which discovery communication has been lost. More...
 
RemoteParticipantPurgeKind remote_participant_purge_kind () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigmax_liveliness_loss_detection_period (const dds::core::Duration &the_max_liveliness_loss_detection_period)
 The maximum amount of time between when a remote entity stops maintaining its liveliness and when the matched local entity realizes that fact. More...
 
dds::core::Duration max_liveliness_loss_detection_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfiginitial_participant_announcements (int32_t the_initial_participant_announcements)
 The number of initial announcements sent when a participant is first enabled or when a remote participant is newly discovered. More...
 
int32_t initial_participant_announcements () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigmin_initial_participant_announcement_period (const dds::core::Duration &the_min_initial_participant_announcement_period)
 The minimum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
dds::core::Duration min_initial_participant_announcement_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigmax_initial_participant_announcement_period (const dds::core::Duration &the_max_initial_participant_announcement_period)
 The maximum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
dds::core::Duration max_initial_participant_announcement_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigparticipant_reader_resource_limits (const BuiltinTopicReaderResourceLimits &the_participant_reader_resource_limits)
 Resource limits. More...
 
const BuiltinTopicReaderResourceLimitsparticipant_reader_resource_limits () const
 Getter (see setter with the same name) More...
 
BuiltinTopicReaderResourceLimitsparticipant_reader_resource_limits ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigpublication_reader (const RtpsReliableReaderProtocol &the_publication_reader)
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader. More...
 
const RtpsReliableReaderProtocolpublication_reader () const
 Getter (see setter with the same name) More...
 
RtpsReliableReaderProtocolpublication_reader ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigpublication_reader_resource_limits (const BuiltinTopicReaderResourceLimits &the_publication_reader_resource_limits)
 Resource limits. More...
 
const BuiltinTopicReaderResourceLimitspublication_reader_resource_limits () const
 Getter (see setter with the same name) More...
 
BuiltinTopicReaderResourceLimitspublication_reader_resource_limits ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsubscription_reader (const RtpsReliableReaderProtocol &the_subscription_reader)
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in subscription reader. More...
 
const RtpsReliableReaderProtocolsubscription_reader () const
 Getter (see setter with the same name) More...
 
RtpsReliableReaderProtocolsubscription_reader ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsubscription_reader_resource_limits (const BuiltinTopicReaderResourceLimits &the_subscription_reader_resource_limits)
 Resource limits. More...
 
const BuiltinTopicReaderResourceLimitssubscription_reader_resource_limits () const
 Getter (see setter with the same name) More...
 
BuiltinTopicReaderResourceLimitssubscription_reader_resource_limits ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigpublication_writer (const RtpsReliableWriterProtocol &the_publication_writer)
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in publication writer. More...
 
const RtpsReliableWriterProtocolpublication_writer () const
 Getter (see setter with the same name) More...
 
RtpsReliableWriterProtocolpublication_writer ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigpublication_writer_data_lifecycle (const dds::core::policy::WriterDataLifecycle &the_publication_writer_data_lifecycle)
 Writer data lifecycle settings for a built-in publication writer. More...
 
const dds::core::policy::WriterDataLifecyclepublication_writer_data_lifecycle () const
 Getter (see setter with the same name) More...
 
dds::core::policy::WriterDataLifecyclepublication_writer_data_lifecycle ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsubscription_writer (const RtpsReliableWriterProtocol &the_subscription_writer)
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in subscription writer. More...
 
const RtpsReliableWriterProtocolsubscription_writer () const
 Getter (see setter with the same name) More...
 
RtpsReliableWriterProtocolsubscription_writer ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsubscription_writer_data_lifecycle (const dds::core::policy::WriterDataLifecycle &the_subscription_writer_data_lifecycle)
 Writer data lifecycle settings for a built-in subscription writer. More...
 
const dds::core::policy::WriterDataLifecyclesubscription_writer_data_lifecycle () const
 Getter (see setter with the same name) More...
 
dds::core::policy::WriterDataLifecyclesubscription_writer_data_lifecycle ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigbuiltin_discovery_plugins (const DiscoveryConfigBuiltinPluginKindMask &the_builtin_discovery_plugins)
 The kind mask for built-in discovery plugins. More...
 
DiscoveryConfigBuiltinPluginKindMask builtin_discovery_plugins () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigparticipant_message_reader_reliability_kind (dds::core::policy::ReliabilityKind the_participant_message_reader_reliability_kind)
 Reliability policy for a built-in participant message reader. More...
 
dds::core::policy::ReliabilityKind participant_message_reader_reliability_kind () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigparticipant_message_reader (const RtpsReliableReaderProtocol &the_participant_message_reader)
 RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if rti::core::policy::DiscoveryConfig::participant_message_reader_reliability_kind is set to dds::core::policy::ReliabilityKind_def::RELIABLE. More...
 
const RtpsReliableReaderProtocolparticipant_message_reader () const
 Getter (see setter with the same name) More...
 
RtpsReliableReaderProtocolparticipant_message_reader ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigparticipant_message_writer (const RtpsReliableWriterProtocol &the_participant_message_writer)
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in participant message writer. This parameter only has effect if the matching participant message reader is configured with dds::core::policy::ReliabilityKind_def::RELIABLE dds::core::policy::ReliabilityKind_def. More...
 
const RtpsReliableWriterProtocolparticipant_message_writer () const
 Getter (see setter with the same name) More...
 
RtpsReliableWriterProtocolparticipant_message_writer ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigpublication_writer_publish_mode (const PublishMode &the_publication_writer_publish_mode)
 Publish mode policy for the built-in publication writer. More...
 
const PublishModepublication_writer_publish_mode () const
 Getter (see setter with the same name) More...
 
PublishModepublication_writer_publish_mode ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsubscription_writer_publish_mode (const PublishMode &the_subscription_writer_publish_mode)
 Publish mode policy for the built-in subscription writer. More...
 
const PublishModesubscription_writer_publish_mode () const
 Getter (see setter with the same name) More...
 
PublishModesubscription_writer_publish_mode ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigasynchronous_publisher (const AsynchronousPublisher &the_asynchronous_publisher)
 Asynchronous publishing settings for the discovery dds::pub::Publisher and all entities that are created by it. More...
 
const AsynchronousPublisherasynchronous_publisher () const
 Getter (see setter with the same name) More...
 
AsynchronousPublisherasynchronous_publisher ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigdefault_domain_announcement_period (const dds::core::Duration &the_default_domain_announcement_period)
 The period to announce a participant to the default domain 0. More...
 
dds::core::Duration default_domain_announcement_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigignore_default_domain_announcements (bool the_ignore_default_domain_announcements)
 Used to ignore the announcements received by a participant on the default domain 0 corresponding to participants running on domains IDs other than 0. More...
 
bool ignore_default_domain_announcements () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigservice_request_writer (const RtpsReliableWriterProtocol &the_service_request_writer)
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in rti::topic::ServiceRequest writer. More...
 
const RtpsReliableWriterProtocolservice_request_writer () const
 Getter (see setter with the same name) More...
 
RtpsReliableWriterProtocolservice_request_writer ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigservice_request_writer_data_lifecycle (const dds::core::policy::WriterDataLifecycle &lifecycle)
 Writer data lifecycle settings for a built-in rti::topic::ServiceRequest writer. More...
 
const dds::core::policy::WriterDataLifecycleservice_request_writer_data_lifecycle () const
 Getter (see setter with the same name) More...
 
dds::core::policy::WriterDataLifecycleservice_request_writer_data_lifecycle ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigservice_request_writer_publish_mode (const PublishMode &the_service_request_writer_publish_mode)
 Publish mode policy for the built-in service request writer. More...
 
const PublishModeservice_request_writer_publish_mode () const
 Getter (see setter with the same name) More...
 
PublishModeservice_request_writer_publish_mode ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigservice_request_reader (const RtpsReliableReaderProtocol &the_service_request_reader)
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader. More...
 
const RtpsReliableReaderProtocolservice_request_reader () const
 Getter (see setter with the same name) More...
 
RtpsReliableReaderProtocolservice_request_reader ()
 Getter (see setter with the same name) More...
 
DiscoveryConfiglocator_reachability_assert_period (const dds::core::Duration &the_locator_reachability_assert_period)
 Period at which this DomainParticipant will assert the locators discovered from other DomainParticipants. More...
 
dds::core::Duration locator_reachability_assert_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfiglocator_reachability_lease_duration (const dds::core::Duration &the_locator_reachability_lease_duration)
 The time period after which other DomainParticipants can consider one of their locators as "unreachable" if they do not receive a REACHABILITY PING from this DomainParticipant. More...
 
dds::core::Duration locator_reachability_lease_duration () const
 Getter (see setter with the same name) More...
 
DiscoveryConfiglocator_reachability_change_detection_period (const dds::core::Duration &the_locator_reachability_change_detection_period)
 Period at which this DomainParticipant will check if its locators are reachable from other DomainParticipants. More...
 
dds::core::Duration locator_reachability_change_detection_period () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigsecure_volatile_writer (const RtpsReliableWriterProtocol &the_secure_volatile_writer)
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in secure volatile writer. More...
 
const RtpsReliableWriterProtocolsecure_volatile_writer () const
 Getter (see setter with the same name) More...
 
RtpsReliableWriterProtocolsecure_volatile_writer ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsecure_volatile_writer_publish_mode (const PublishMode &the_secure_volatile_writer_publish_mode)
 Publish mode policy for the built-in secure volatile writer. More...
 
const PublishModesecure_volatile_writer_publish_mode () const
 Getter (see setter with the same name) More...
 
PublishModesecure_volatile_writer_publish_mode ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigsecure_volatile_reader (const RtpsReliableReaderProtocol &the_secure_volatile_reader)
 RTPS reliable reader protocol-related configuration settings for the built-in secure volatile reader. More...
 
const RtpsReliableReaderProtocolsecure_volatile_reader () const
 Getter (see setter with the same name) More...
 
RtpsReliableReaderProtocolsecure_volatile_reader ()
 Getter (see setter with the same name) More...
 
DiscoveryConfigendpoint_type_object_lb_serialization_threshold (int32_t the_endpoint_type_object_lb_serialization_threshold)
 Option to reduce the size required to propagate a TypeObject in Simple Endpoint Discovery. More...
 
int32_t endpoint_type_object_lb_serialization_threshold () const
 Getter (see setter with the same name) More...
 
DiscoveryConfigdns_tracker_polling_period (const dds::core::Duration &the_dns_tracker_polling_period)
 Duration that specifies the period used by the DNS tracker to poll the DNS service and check for changes in the hostnames. More...
 
dds::core::Duration dns_tracker_polling_period () const
 Getter (see setter with the same name) More...
 

Detailed Description

<<extension>> Configures the discovery mechanism

<<extension>> This QoS policy controls the amount of delay in discovering entities in the system and the amount of discovery traffic in the network.

The amount of network traffic required by the discovery process can vary widely, based on how your application has chosen to configure the middleware's network addressing (e.g., unicast vs. multicast, multicast TTL, etc.), the size of the system, whether all applications are started at the same time or whether start times are staggered, and other factors. Your application can use this policy to make tradeoffs between discovery completion time and network bandwidth utilization. In addition, you can introduce random back-off periods into the discovery process to decrease the probability of network contention when many applications start simultaneously.

Entity:
dds::domain::DomainParticipant
Properties:
RxO = N/A
Changeable = NO

Constructor & Destructor Documentation

◆ DiscoveryConfig()

rti::core::policy::DiscoveryConfig::DiscoveryConfig ( )
inline

Creates the default policy.

Member Function Documentation

◆ participant_liveliness_lease_duration() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_liveliness_lease_duration ( const dds::core::Duration the_participant_liveliness_lease_duration)

The liveliness lease duration for the participant.

This is the same as the expiration time of the DomainParticipant as defined in the RTPS protocol.

If the participant has not refreshed its own liveliness to other participants at least once within this period, it may be considered as stale by other participants in the network.

Should be strictly greater than rti::core::policy::DiscoveryConfig::participant_liveliness_assert_period.

[default] 100 seconds

[range] [1 nanosec,1 year], > participant_liveliness_assert_period

◆ participant_liveliness_lease_duration() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::participant_liveliness_lease_duration ( ) const

Getter (see setter with the same name)

◆ participant_liveliness_assert_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_liveliness_assert_period ( const dds::core::Duration the_participant_liveliness_assert_period)

The period to assert liveliness for the participant.

The period at which the participant will refresh its liveliness to all the peers.

Should be strictly less than rti::core::policy::DiscoveryConfig::participant_liveliness_lease_duration.

[default] 30 seconds

[range] [1 nanosec,1 year), < participant_liveliness_lease_duration

◆ participant_liveliness_assert_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::participant_liveliness_assert_period ( ) const

Getter (see setter with the same name)

◆ remote_participant_purge_kind() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::remote_participant_purge_kind ( RemoteParticipantPurgeKind  the_remote_participant_purge_kind)

The participant's behavior for maintaining knowledge of remote participants (and their contained entities) with which discovery communication has been lost.

Most users will not need to change this value from its default, RemoteParticipantPurgeKind::LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE. However, RemoteParticipantPurgeKind::NO_REMOTE_PARTICIPANT_PURGE may be a good choice if the following conditions apply:

  1. Discovery communication with a remote participant may be lost while data communication remains intact. Such will not typically be the case if discovery takes place over the Simple Discovery Protocol, but may be the case if the RTI Enterprise Discovery Service is used.
  2. Extensive and prolonged lack of discovery communication between participants is not expected to be common, either because participant loss itself is expected to be rare, or because participants may be lost sporadically but will typically return again.
  3. Maintaining inter-participant liveliness is problematic, perhaps because a participant has no writers with the appropriate dds::core::policy::LivelinessKind.

[default] RemoteParticipantPurgeKind::LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE

◆ remote_participant_purge_kind() [2/2]

RemoteParticipantPurgeKind rti::core::policy::DiscoveryConfig::remote_participant_purge_kind ( ) const

Getter (see setter with the same name)

◆ max_liveliness_loss_detection_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::max_liveliness_loss_detection_period ( const dds::core::Duration the_max_liveliness_loss_detection_period)

The maximum amount of time between when a remote entity stops maintaining its liveliness and when the matched local entity realizes that fact.

Notification of the loss of liveliness of a remote entity may come more quickly that this duration, depending on the liveliness contract between the local and remote entities and the capabilities of the discovery mechanism in use. For example, a dds::sub::DataReader will learn of the loss of liveliness of a matched dds::pub::DataWriter within the reader's offered liveliness lease duration.

Shortening this duration will increase the responsiveness of entities to communication failures. However, it will also increase the CPU usage of the application, as the liveliness of remote entities will be examined more frequently.

[default] 60 seconds

[range] [1 nanosec, 1 year]

◆ max_liveliness_loss_detection_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::max_liveliness_loss_detection_period ( ) const

Getter (see setter with the same name)

◆ initial_participant_announcements() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::initial_participant_announcements ( int32_t  the_initial_participant_announcements)

The number of initial announcements sent when a participant is first enabled or when a remote participant is newly discovered.

Also, when a new remote participant appears, the local participant can announce itself to the peers multiple times controlled by this parameter.

[default] 5

[range] [0,1 million]

◆ initial_participant_announcements() [2/2]

int32_t rti::core::policy::DiscoveryConfig::initial_participant_announcements ( ) const

Getter (see setter with the same name)

◆ min_initial_participant_announcement_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period ( const dds::core::Duration the_min_initial_participant_announcement_period)

The minimum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered.

A random delay between this and rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period is introduced in between initial announcements when a new remote participant is discovered.

The setting of rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period must be consistent with rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period. For these two values to be consistent, they must verify that:

rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period <= rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period.

[default] 1 second

[range] [1 nanosec,1 year]

◆ min_initial_participant_announcement_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period ( ) const

Getter (see setter with the same name)

◆ max_initial_participant_announcement_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period ( const dds::core::Duration the_max_initial_participant_announcement_period)

The maximum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered.

A random delay between rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period and this is introduced in between initial announcements when a new remote participant is discovered.

The setting of rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period must be consistent with rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period. For these two values to be consistent, they must verify that:

rti::core::policy::DiscoveryConfig::min_initial_participant_announcement_period <= rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period.

[default] 1 second

[range] [1 nanosec,1 year]

◆ max_initial_participant_announcement_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::max_initial_participant_announcement_period ( ) const

Getter (see setter with the same name)

◆ participant_reader_resource_limits() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_reader_resource_limits ( const BuiltinTopicReaderResourceLimits the_participant_reader_resource_limits)

Resource limits.

Resource limit of the built-in topic participant reader. For details, see BuiltinTopicReaderResourceLimits_t.

◆ participant_reader_resource_limits() [2/3]

const BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::participant_reader_resource_limits ( ) const

Getter (see setter with the same name)

◆ participant_reader_resource_limits() [3/3]

BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::participant_reader_resource_limits ( )

Getter (see setter with the same name)

◆ publication_reader() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::publication_reader ( const RtpsReliableReaderProtocol the_publication_reader)

RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader.

For details, refer to the rti::core::RtpsReliableReaderProtocol

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.0 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

◆ publication_reader() [2/3]

const RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::publication_reader ( ) const

Getter (see setter with the same name)

◆ publication_reader() [3/3]

RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::publication_reader ( )

Getter (see setter with the same name)

◆ publication_reader_resource_limits() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::publication_reader_resource_limits ( const BuiltinTopicReaderResourceLimits the_publication_reader_resource_limits)

Resource limits.

Resource limit of the built-in topic publication reader. For details, see BuiltinTopicReaderResourceLimits_t.

◆ publication_reader_resource_limits() [2/3]

const BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::publication_reader_resource_limits ( ) const

Getter (see setter with the same name)

◆ publication_reader_resource_limits() [3/3]

BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::publication_reader_resource_limits ( )

Getter (see setter with the same name)

◆ subscription_reader() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::subscription_reader ( const RtpsReliableReaderProtocol the_subscription_reader)

RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in subscription reader.

For details, refer to the rti::core::RtpsReliableReaderProtocol

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.0 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

◆ subscription_reader() [2/3]

const RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::subscription_reader ( ) const

Getter (see setter with the same name)

◆ subscription_reader() [3/3]

RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::subscription_reader ( )

Getter (see setter with the same name)

◆ subscription_reader_resource_limits() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::subscription_reader_resource_limits ( const BuiltinTopicReaderResourceLimits the_subscription_reader_resource_limits)

Resource limits.

Resource limit of the built-in topic subscription reader. For details, see BuiltinTopicReaderResourceLimits_t.

◆ subscription_reader_resource_limits() [2/3]

const BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::subscription_reader_resource_limits ( ) const

Getter (see setter with the same name)

◆ subscription_reader_resource_limits() [3/3]

BuiltinTopicReaderResourceLimits& rti::core::policy::DiscoveryConfig::subscription_reader_resource_limits ( )

Getter (see setter with the same name)

◆ publication_writer() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::publication_writer ( const RtpsReliableWriterProtocol the_publication_writer)

RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in publication writer.

For details, refer to the rti::core::RtpsReliableWriterProtocol

[default]
low_watermark 0;
high_watermark 1;
heartbeat_period 3.0 seconds;
fast_heartbeat_period 3.0 seconds;
late_joiner_heartbeat_period 3.0 seconds;
virtual_heartbeat_period dds::core::Duration::infinite();
samples_per_virtual_heartbeat dds::core::LENGTH_UNLIMITED;
max_heartbeat_retries 10;
inactivate_nonprogressing_readers false;
heartbeats_per_max_samples 8;
min_nack_response_delay 0.0 seconds;
max_nack_response_delay 0.0 seconds;
nack_suppression_duration 0.0 seconds;
max_bytes_per_nack_response 131072 bytes;
disable_positive_acks_min_sample_keep_duration 1.0 milliseconds;
disable_positive_acks_max_sample_keep_duration 1.0 seconds;
disable_positive_acks_enable_adaptive_sample_keep_duration true;
disable_positive_acks_decrease_sample_keep_duration_factor 95;
disable_positive_acks_increase_sample_keep_duration_factor 150;
min_send_window_size dds::core::LENGTH_UNLIMITED;
max_send_window_size dds::core::LENGTH_UNLIMITED;
send_window_update_period 3s;
send_window_increase_factor 105;
send_window_decrease_factor 50;
enable_multicast_periodic_heartbeat false;
multicast_resend_threshold 2 readers;
disable_repair_piggyback_heartbeat false;

◆ publication_writer() [2/3]

const RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::publication_writer ( ) const

Getter (see setter with the same name)

◆ publication_writer() [3/3]

RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::publication_writer ( )

Getter (see setter with the same name)

◆ publication_writer_data_lifecycle() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::publication_writer_data_lifecycle ( const dds::core::policy::WriterDataLifecycle the_publication_writer_data_lifecycle)

Writer data lifecycle settings for a built-in publication writer.

For details, refer to the dds::core::policy::WriterDataLifecycle. dds::core::policy::WriterDataLifecycle::autodispose_unregistered_instances will always be forced to true.

◆ publication_writer_data_lifecycle() [2/3]

const dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::publication_writer_data_lifecycle ( ) const

Getter (see setter with the same name)

◆ publication_writer_data_lifecycle() [3/3]

dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::publication_writer_data_lifecycle ( )

Getter (see setter with the same name)

◆ subscription_writer() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::subscription_writer ( const RtpsReliableWriterProtocol the_subscription_writer)

RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in subscription writer.

For details, refer to the rti::core::RtpsReliableWriterProtocol

[default]
low_watermark 0;
high_watermark 1;
heartbeat_period 3.0 seconds;
fast_heartbeat_period 3.0 seconds;
late_joiner_heartbeat_period 3.0 seconds;
virtual_heartbeat_period dds::core::Duration::infinite();
samples_per_virtual_heartbeat dds::core::LENGTH_UNLIMITED;
max_heartbeat_retries 10;
inactivate_nonprogressing_readers false;
heartbeats_per_max_samples 8;
min_nack_response_delay 0.0 seconds;
max_nack_response_delay 0.0 seconds;
nack_suppression_duration 0.0 seconds;
max_bytes_per_nack_response 131072 bytes;
disable_positive_acks_min_sample_keep_duration 1.0 milliseconds;
disable_positive_acks_max_sample_keep_duration 1.0 seconds;
disable_positive_acks_enable_adaptive_sample_keep_duration true;
disable_positive_acks_decrease_sample_keep_duration_factor 95;
disable_positive_acks_increase_sample_keep_duration_factor 150;
min_send_window_size dds::core::LENGTH_UNLIMITED;
max_send_window_size dds::core::LENGTH_UNLIMITED;
send_window_update_period 3s;
send_window_increase_factor 105;
send_window_decrease_factor 50;
enable_multicast_periodic_heartbeat false;
multicast_resend_threshold 2 readers;
disable_repair_piggyback_heartbeat false;

◆ subscription_writer() [2/3]

const RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::subscription_writer ( ) const

Getter (see setter with the same name)

◆ subscription_writer() [3/3]

RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::subscription_writer ( )

Getter (see setter with the same name)

◆ subscription_writer_data_lifecycle() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::subscription_writer_data_lifecycle ( const dds::core::policy::WriterDataLifecycle the_subscription_writer_data_lifecycle)

Writer data lifecycle settings for a built-in subscription writer.

For details, refer to the dds::core::policy::WriterDataLifecycle. dds::core::policy::WriterDataLifecycle::autodispose_unregistered_instances will always be forced to true.

◆ subscription_writer_data_lifecycle() [2/3]

const dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::subscription_writer_data_lifecycle ( ) const

Getter (see setter with the same name)

◆ subscription_writer_data_lifecycle() [3/3]

dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::subscription_writer_data_lifecycle ( )

Getter (see setter with the same name)

◆ builtin_discovery_plugins() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::builtin_discovery_plugins ( const DiscoveryConfigBuiltinPluginKindMask the_builtin_discovery_plugins)

The kind mask for built-in discovery plugins.

There are several built-in discovery plugin. This mask enables the different plugins. Any plugin not enabled will not be created.

[default] DiscoveryConfigBuiltinPluginKind::DISCOVERYCONFIG_BUILTIN_SDP

◆ builtin_discovery_plugins() [2/2]

DiscoveryConfigBuiltinPluginKindMask rti::core::policy::DiscoveryConfig::builtin_discovery_plugins ( ) const

Getter (see setter with the same name)

◆ participant_message_reader_reliability_kind() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_message_reader_reliability_kind ( dds::core::policy::ReliabilityKind  the_participant_message_reader_reliability_kind)

Reliability policy for a built-in participant message reader.

For details, refer to the dds::core::policy::ReliabilityKind_def.

[default] dds::core::policy::ReliabilityKind_def::BEST_EFFORT

◆ participant_message_reader_reliability_kind() [2/2]

dds::core::policy::ReliabilityKind rti::core::policy::DiscoveryConfig::participant_message_reader_reliability_kind ( ) const

Getter (see setter with the same name)

◆ participant_message_reader() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_message_reader ( const RtpsReliableReaderProtocol the_participant_message_reader)

RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if rti::core::policy::DiscoveryConfig::participant_message_reader_reliability_kind is set to dds::core::policy::ReliabilityKind_def::RELIABLE.

For details, refer to the rti::core::RtpsReliableReaderProtocol

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.0 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

◆ participant_message_reader() [2/3]

const RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::participant_message_reader ( ) const

Getter (see setter with the same name)

◆ participant_message_reader() [3/3]

RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::participant_message_reader ( )

Getter (see setter with the same name)

◆ participant_message_writer() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::participant_message_writer ( const RtpsReliableWriterProtocol the_participant_message_writer)

RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in participant message writer. This parameter only has effect if the matching participant message reader is configured with dds::core::policy::ReliabilityKind_def::RELIABLE dds::core::policy::ReliabilityKind_def.

For details, refer to the rti::core::RtpsReliableWriterProtocol

[default]
low_watermark 0;
high_watermark 1;
heartbeat_period 1.0 seconds;
fast_heartbeat_period 1.0 seconds;
late_joiner_heartbeat_period 1.0 seconds;
virtual_heartbeat_period dds::core::Duration::infinite();
samples_per_virtual_heartbeat dds::core::LENGTH_UNLIMITED;
max_heartbeat_retries 10;
inactivate_nonprogressing_readers false;
heartbeats_per_max_samples 1;
min_nack_response_delay 0.0 seconds;
max_nack_response_delay 0.0 seconds;
nack_suppression_duration 0.0 seconds;
max_bytes_per_nack_response 9216 bytes;
disable_positive_acks_min_sample_keep_duration 1.0 milliseconds;
disable_positive_acks_max_sample_keep_duration 1.0 seconds;
disable_positive_acks_enable_adaptive_sample_keep_duration true;
disable_positive_acks_decrease_sample_keep_duration_factor 95;
disable_positive_acks_increase_sample_keep_duration_factor 150;
min_send_window_size dds::core::LENGTH_UNLIMITED;
max_send_window_size dds::core::LENGTH_UNLIMITED;
send_window_update_period 1s;
send_window_increase_factor 105;
send_window_decrease_factor 50;
enable_multicast_periodic_heartbeat false;
multicast_resend_threshold 2 readers;
disable_repair_piggyback_heartbeat false;

◆ participant_message_writer() [2/3]

const RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::participant_message_writer ( ) const

Getter (see setter with the same name)

◆ participant_message_writer() [3/3]

RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::participant_message_writer ( )

Getter (see setter with the same name)

◆ publication_writer_publish_mode() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::publication_writer_publish_mode ( const PublishMode the_publication_writer_publish_mode)

Publish mode policy for the built-in publication writer.

Determines whether the Discovery built-in publication dds::pub::DataWriter publishes data synchronously or asynchronously and how.

◆ publication_writer_publish_mode() [2/3]

const PublishMode& rti::core::policy::DiscoveryConfig::publication_writer_publish_mode ( ) const

Getter (see setter with the same name)

◆ publication_writer_publish_mode() [3/3]

PublishMode& rti::core::policy::DiscoveryConfig::publication_writer_publish_mode ( )

Getter (see setter with the same name)

◆ subscription_writer_publish_mode() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::subscription_writer_publish_mode ( const PublishMode the_subscription_writer_publish_mode)

Publish mode policy for the built-in subscription writer.

Determines whether the Discovery built-in subscription dds::pub::DataWriter publishes data synchronously or asynchronously and how.

◆ subscription_writer_publish_mode() [2/3]

const PublishMode& rti::core::policy::DiscoveryConfig::subscription_writer_publish_mode ( ) const

Getter (see setter with the same name)

◆ subscription_writer_publish_mode() [3/3]

PublishMode& rti::core::policy::DiscoveryConfig::subscription_writer_publish_mode ( )

Getter (see setter with the same name)

◆ asynchronous_publisher() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::asynchronous_publisher ( const AsynchronousPublisher the_asynchronous_publisher)

Asynchronous publishing settings for the discovery dds::pub::Publisher and all entities that are created by it.

◆ asynchronous_publisher() [2/3]

const AsynchronousPublisher& rti::core::policy::DiscoveryConfig::asynchronous_publisher ( ) const

Getter (see setter with the same name)

◆ asynchronous_publisher() [3/3]

AsynchronousPublisher& rti::core::policy::DiscoveryConfig::asynchronous_publisher ( )

Getter (see setter with the same name)

◆ default_domain_announcement_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::default_domain_announcement_period ( const dds::core::Duration the_default_domain_announcement_period)

The period to announce a participant to the default domain 0.

The period at which a participant will announce itself to the default domain 0 using the default UDPv4 multicast group address for discovery traffic on that domain.

For domain 0, the default discovery multicast address is 239.255.0.1:7400.

To disable announcement to the default domain, set this period to dds::core::Duration::infinite().

When this period is set to a value other than dds::core::Duration::infinite() and rti::core::policy::DiscoveryConfig::ignore_default_domain_announcements is set to false, you can get information about participants running in different domains by creating a participant in domain 0 and implementing the on_data_available callback in the dds::topic::ParticipantBuiltinTopicData built-in DataReader's listener.

You can learn the domain ID associated with a participant by looking at the field dds::topic::ParticipantBuiltinTopicData::domain_id.

[default] 30 seconds

[range] [1 nanosec,1 year] or dds::core::Duration::infinite()

See also
dds::topic::ParticipantBuiltinTopicData::domain_id
rti::core::policy::DiscoveryConfig::ignore_default_domain_announcements

◆ default_domain_announcement_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::default_domain_announcement_period ( ) const

Getter (see setter with the same name)

◆ ignore_default_domain_announcements() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::ignore_default_domain_announcements ( bool  the_ignore_default_domain_announcements)

Used to ignore the announcements received by a participant on the default domain 0 corresponding to participants running on domains IDs other than 0.

This setting only applies to participants running on the default domain 0 and using the default port mapping.

When this setting is set to true, a participant running on the default domain 0 will ignore announcements from participants running on different domain IDs.

When this setting is set to false, a participant running on the default domain 0 will provide announcements from participants running on different domain IDs to the application via the dds::topic::ParticipantBuiltinTopicData built-in DataReader.

[default] true

See also
dds::topic::ParticipantBuiltinTopicData::domain_id
rti::core::policy::DiscoveryConfig::default_domain_announcement_period

◆ ignore_default_domain_announcements() [2/2]

bool rti::core::policy::DiscoveryConfig::ignore_default_domain_announcements ( ) const

Getter (see setter with the same name)

◆ service_request_writer() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::service_request_writer ( const RtpsReliableWriterProtocol the_service_request_writer)

RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in rti::topic::ServiceRequest writer.

For details, refer to the rti::core::RtpsReliableWriterProtocol

[default]
low_watermark 0;
high_watermark 1;
heartbeat_period 3.0 seconds;
fast_heartbeat_period 3.0 seconds;
late_joiner_heartbeat_period 3.0 seconds;
virtual_heartbeat_period dds::core::Duration::infinite();
samples_per_virtual_heartbeat dds::core::LENGTH_UNLIMITED;
max_heartbeat_retries 10;
inactivate_nonprogressing_readers false;
heartbeats_per_max_samples 8;
min_nack_response_delay 0.0 seconds;
max_nack_response_delay 0.0 seconds;
nack_suppression_duration 0.0 seconds;
max_bytes_per_nack_response 131072 bytes;
disable_positive_acks_min_sample_keep_duration 1.0 milliseconds;
disable_positive_acks_max_sample_keep_duration 1.0 seconds;
disable_positive_acks_enable_adaptive_sample_keep_duration true;
disable_positive_acks_decrease_sample_keep_duration_factor 95;
disable_positive_acks_increase_sample_keep_duration_factor 150;
min_send_window_size dds::core::LENGTH_UNLIMITED;
max_send_window_size dds::core::LENGTH_UNLIMITED;
send_window_update_period 3s;
send_window_increase_factor 105;
send_window_decrease_factor 50;
enable_multicast_periodic_heartbeat false;
multicast_resend_threshold 2 readers;
disable_repair_piggyback_heartbeat false;

◆ service_request_writer() [2/3]

const RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::service_request_writer ( ) const

Getter (see setter with the same name)

◆ service_request_writer() [3/3]

RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::service_request_writer ( )

Getter (see setter with the same name)

◆ service_request_writer_data_lifecycle() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::service_request_writer_data_lifecycle ( const dds::core::policy::WriterDataLifecycle lifecycle)

Writer data lifecycle settings for a built-in rti::topic::ServiceRequest writer.

For details, refer to the dds::core::policy::WriterDataLifecycle.

◆ service_request_writer_data_lifecycle() [2/3]

const dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::service_request_writer_data_lifecycle ( ) const

Getter (see setter with the same name)

◆ service_request_writer_data_lifecycle() [3/3]

dds::core::policy::WriterDataLifecycle& rti::core::policy::DiscoveryConfig::service_request_writer_data_lifecycle ( )

Getter (see setter with the same name)

◆ service_request_writer_publish_mode() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::service_request_writer_publish_mode ( const PublishMode the_service_request_writer_publish_mode)

Publish mode policy for the built-in service request writer.

Determines whether the Discovery built-in service request dds::pub::DataWriter publishes data synchronously or asynchronously and how.

◆ service_request_writer_publish_mode() [2/3]

const PublishMode& rti::core::policy::DiscoveryConfig::service_request_writer_publish_mode ( ) const

Getter (see setter with the same name)

◆ service_request_writer_publish_mode() [3/3]

PublishMode& rti::core::policy::DiscoveryConfig::service_request_writer_publish_mode ( )

Getter (see setter with the same name)

◆ service_request_reader() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::service_request_reader ( const RtpsReliableReaderProtocol the_service_request_reader)

RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader.

For details, refer to the rti::core::RtpsReliableReaderProtocol

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.0 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

◆ service_request_reader() [2/3]

const RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::service_request_reader ( ) const

Getter (see setter with the same name)

◆ service_request_reader() [3/3]

RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::service_request_reader ( )

Getter (see setter with the same name)

◆ locator_reachability_assert_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::locator_reachability_assert_period ( const dds::core::Duration the_locator_reachability_assert_period)

Period at which this DomainParticipant will assert the locators discovered from other DomainParticipants.

This setting configures the period at which this dds::domain::DomainParticipant will ping all the locators that it has discovered from other DomainParticipants. This period should be strictly less than rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration.

If rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration is dds::core::Duration::infinite() this parameter is ignored. The DomainParticipant will not assert remote locators.

[default] 20 seconds

[range] [1 nanosec,1 year]

See also
rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration

◆ locator_reachability_assert_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::locator_reachability_assert_period ( ) const

Getter (see setter with the same name)

◆ locator_reachability_lease_duration() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration ( const dds::core::Duration the_locator_reachability_lease_duration)

The time period after which other DomainParticipants can consider one of their locators as "unreachable" if they do not receive a REACHABILITY PING from this DomainParticipant.

For the purpose of this explanation, we will use 'local' to refer to the DomainParticipant in which we configure locator_reachability_lease_duration and 'remote' to refer to the other DomainParticipants communicating with the local DomainParticipant.

This setting configures a timeout announced to the remote DomainParticipants. This timeout is used by the remote DomainParticipants as the maximum period by which a remote locator must be asserted by the local DomainParticipant (through a REACHABILITY PING message) before considering this locator as "unreachable" from the local DomainParticipant.

When a remote DomainParticipant detects that one of its locators is not reachable from the local DomainParticipant, it will notify the local DomainParticipant of this event. From that moment on, and until notified otherwise, the local DomainParticipant will not send RTPS messages to remote DomainParticipants using this locator.

If this value is set to dds::core::Duration::infinite(), the local DomainParticipant will send RTPS messages to a remote DomainParticipant on the locators announced by the remote DomainParticipant, regardless of whether or not the remote DomainParticipant can be reached using these locators.

[default] dds::core::Duration::infinite()

[range] [1 nanosec,1 year] or dds::core::Duration::infinite()

◆ locator_reachability_lease_duration() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration ( ) const

Getter (see setter with the same name)

◆ locator_reachability_change_detection_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::locator_reachability_change_detection_period ( const dds::core::Duration the_locator_reachability_change_detection_period)

Period at which this DomainParticipant will check if its locators are reachable from other DomainParticipants.

This setting determines the maximum period at which this DomainParticipant will check to see if its locators are reachable from other DomainParticipants according to the other DomainParticipants' rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration value.

If rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration is dds::core::Duration::infinite() this parameter is ignored. The DomainParticipant will not schedule an event to see if its locators are reachable from other DomainParticipants.

[default] 60 seconds

[range] [1 nanosec,1 year]

See also
rti::core::policy::DiscoveryConfig::locator_reachability_lease_duration

◆ locator_reachability_change_detection_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::locator_reachability_change_detection_period ( ) const

Getter (see setter with the same name)

◆ secure_volatile_writer() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::secure_volatile_writer ( const RtpsReliableWriterProtocol the_secure_volatile_writer)

RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in secure volatile writer.

For details, refer to the rti::core::RtpsReliableWriterProtocol

[default]
low_watermark 0;
high_watermark 1;
heartbeat_period 1.0 second;
fast_heartbeat_period 250.0 milliseconds;
late_joiner_heartbeat_period 1.0 second;
virtual_heartbeat_period dds::core::Duration::infinite();
samples_per_virtual_heartbeat dds::core::LENGTH_UNLIMITED;
max_heartbeat_retries dds::core::LENGTH_UNLIMITED;
inactivate_nonprogressing_readers false;
heartbeats_per_max_samples 1;
min_nack_response_delay 0.0 seconds;
max_nack_response_delay 0.0 seconds;
nack_suppression_duration 0.0 seconds;
max_bytes_per_nack_response 9216 bytes;
disable_positive_acks_min_sample_keep_duration 1.0 millisecond;
disable_positive_acks_max_sample_keep_duration 1.0 second;
disable_positive_acks_enable_adaptive_sample_keep_duration true;
disable_positive_acks_decrease_sample_keep_duration_factor 95;
disable_positive_acks_increase_sample_keep_duration_factor 150;
min_send_window_size dds::core::LENGTH_UNLIMITED;
max_send_window_size dds::core::LENGTH_UNLIMITED;
send_window_update_period 1.0 second;
send_window_increase_factor 105;
send_window_decrease_factor 50;
enable_multicast_periodic_heartbeat false;
multicast_resend_threshold 2 readers;
disable_repair_piggyback_heartbeat false;

◆ secure_volatile_writer() [2/3]

const RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::secure_volatile_writer ( ) const

Getter (see setter with the same name)

◆ secure_volatile_writer() [3/3]

RtpsReliableWriterProtocol& rti::core::policy::DiscoveryConfig::secure_volatile_writer ( )

Getter (see setter with the same name)

◆ secure_volatile_writer_publish_mode() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::secure_volatile_writer_publish_mode ( const PublishMode the_secure_volatile_writer_publish_mode)

Publish mode policy for the built-in secure volatile writer.

Determines whether the built-in secure volatile dds::pub::DataWriter publishes data synchronously or asynchronously and how.

◆ secure_volatile_writer_publish_mode() [2/3]

const PublishMode& rti::core::policy::DiscoveryConfig::secure_volatile_writer_publish_mode ( ) const

Getter (see setter with the same name)

◆ secure_volatile_writer_publish_mode() [3/3]

PublishMode& rti::core::policy::DiscoveryConfig::secure_volatile_writer_publish_mode ( )

Getter (see setter with the same name)

◆ secure_volatile_reader() [1/3]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::secure_volatile_reader ( const RtpsReliableReaderProtocol the_secure_volatile_reader)

RTPS reliable reader protocol-related configuration settings for the built-in secure volatile reader.

For details, refer to the rti::core::RtpsReliableReaderProtocol

[default]
min_heartbeat_response_delay 0.0 seconds;
max_heartbeat_response_delay 0.0 seconds;
heartbeat_suppression_duration 0.0625 seconds;
nack_period 5.0 seconds;
receive_window_size 256;
round_trip_time 0.0 seconds;
app_ack_period 5.0 seconds;
samples_per_app_ack 1;

◆ secure_volatile_reader() [2/3]

const RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::secure_volatile_reader ( ) const

Getter (see setter with the same name)

◆ secure_volatile_reader() [3/3]

RtpsReliableReaderProtocol& rti::core::policy::DiscoveryConfig::secure_volatile_reader ( )

Getter (see setter with the same name)

◆ endpoint_type_object_lb_serialization_threshold() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::endpoint_type_object_lb_serialization_threshold ( int32_t  the_endpoint_type_object_lb_serialization_threshold)

Option to reduce the size required to propagate a TypeObject in Simple Endpoint Discovery.

Minimum size (in bytes) of the serialized TypeObject that will trigger the serialization of a TypeObjectLb instead of the regular TypeObject.

For example, setting this property to 1000 will trigger the serialization of the TypeObjectLb for TypeObjects whose serialized size is greater than 1000 Bytes.

The sentinel value -1 disables TypeObject compression.

[default] 0. The default value 0 enables TypeObject compression by always sending TypeObjectLb.

[range] [-1, 2147483647]

◆ endpoint_type_object_lb_serialization_threshold() [2/2]

int32_t rti::core::policy::DiscoveryConfig::endpoint_type_object_lb_serialization_threshold ( ) const

Getter (see setter with the same name)

◆ dns_tracker_polling_period() [1/2]

DiscoveryConfig& rti::core::policy::DiscoveryConfig::dns_tracker_polling_period ( const dds::core::Duration the_dns_tracker_polling_period)

Duration that specifies the period used by the DNS tracker to poll the DNS service and check for changes in the hostnames.

RTI Connext allows the use of hostnames instead of IP addresses when configuring initial peers for specific transports (e.g.: UDPv4 and UDPv6). The DNS tracker keeps the IP addresses of these hostnames updated. The DNS tracker builds a list of hostnames from the initial peers of a DomainParticipant, queries the DNS for those hostnames, and updates the resolved IP addresses when the IP addresses change. The frequency of these queries is defined by the DNS tracker polling period. When the period is set to dds::core::Duration::infinite(), the tracker is disabled.

RTI Connext keeps information regarding the hostnames of peers if they are part of the rti::core::policy::Discovery::initial_peers(const dds::core::StringSeq & the_initial_peers). The information regarding peers added through the dds::domain::DomainParticipant::add_peer(const std::string & peer_descr_string) operation is kept only if the DNS tracker has been enabled before adding a peer.

[default] dds::core::Duration::infinite()

[range] [1 second,1 year], dds::core::Duration::infinite()

◆ dns_tracker_polling_period() [2/2]

dds::core::Duration rti::core::policy::DiscoveryConfig::dns_tracker_polling_period ( ) const

Getter (see setter with the same name)