Settings for discovery configuration. More...

#include <managed_infrastructure.h>

Static Public Member Functions
static System::String^	get_discoveryconfig_qos_policy_name ()
	Stringified human-readable name for DDS::DiscoveryConfigQosPolicy.

Public Attributes
Duration_t	participant_liveliness_lease_duration
	The liveliness lease duration for the participant.

Duration_t	participant_liveliness_assert_period
	The period to assert liveliness for the participant.

RemoteParticipantPurgeKind	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.

Duration_t	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.

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

Duration_t	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.

Duration_t	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.

BuiltinTopicReaderResourceLimits_t	participant_reader_resource_limits
	Resource limits.

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

BuiltinTopicReaderResourceLimits_t	publication_reader_resource_limits
	Resource limits.

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

BuiltinTopicReaderResourceLimits_t	subscription_reader_resource_limits
	Resource limits.

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

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

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

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

System::Int32	builtin_discovery_plugins
	The kind mask for built-in discovery plugins.

ReliabilityQosPolicyKind	participant_message_reader_reliability_kind
	Reliability policy for a built-in participant message reader.

RtpsReliableReaderProtocol_t	participant_message_reader
	RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if DDS::DiscoveryConfigQosPolicy::participant_message_reader_reliability_kind is set to ::DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS.

RtpsReliableWriterProtocol_t	participant_message_writer
	RTPS protocol-related configuration settings for the RTPS reliable writer associated to the built-in participant message writer. This parameter only has effect if the matching participant message reader is configured with ::DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS ::DDS::ReliabilityQosPolicyKind.

PublishModeQosPolicy^	publication_writer_publish_mode
	Publish mode policy for the built-in publication writer.

PublishModeQosPolicy^	subscription_writer_publish_mode
	Publish mode policy for the built-in subscription writer.

AsynchronousPublisherQosPolicy^	asynchronous_publisher
	Asynchronous publishing settings for the discovery DDS::Publisher and all entities that are created by it.

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

Properties
System::Boolean	ignore_default_domain_announcements `[get, set]`
	Used to ignore the announcements received by a participant on the default domain 0 corresponding to participants running on domains IDs other than 0.

Detailed Description

Settings for discovery configuration.

<<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::DomainParticipant

Properties:: RxO = N/A
Changeable = NO

Member Data Documentation

Duration_t DDS::DiscoveryConfigQosPolicy::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 DDS::DiscoveryConfigQosPolicy::participant_liveliness_assert_period.

[default] 100 seconds

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

Duration_t DDS::DiscoveryConfigQosPolicy::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 DDS::DiscoveryConfigQosPolicy::participant_liveliness_lease_duration.

[default] 30 seconds

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

RemoteParticipantPurgeKind DDS::DiscoveryConfigQosPolicy::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, ::DDS::RemoteParticipantPurgeKind::LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE. However, ::DDS::RemoteParticipantPurgeKind::NO_REMOTE_PARTICIPANT_PURGE may be a good choice if the following conditions apply:

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.
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.
Maintaining inter-participant liveliness is problematic, perhaps because a participant has no writers with the appropriate ::DDS::LivelinessQosPolicyKind.

[default] ::DDS::RemoteParticipantPurgeKind::LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE

Duration_t DDS::DiscoveryConfigQosPolicy::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::DataReader will learn of the loss of liveliness of a matched DDS::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] [0, 1 year]

System::Int32 DDS::DiscoveryConfigQosPolicy::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]

Duration_t DDS::DiscoveryConfigQosPolicy::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 DDS::DiscoveryConfigQosPolicy::max_initial_participant_announcement_period is introduced in between initial announcements when a new remote participant is discovered.

The setting of DDS::DiscoveryConfigQosPolicy::min_initial_participant_announcement_period must be consistent with DDS::DiscoveryConfigQosPolicy::max_initial_participant_announcement_period. For these two values to be consistent, they must verify that:

DDS::DiscoveryConfigQosPolicy::min_initial_participant_announcement_period <= DDS::DiscoveryConfigQosPolicy::max_initial_participant_announcement_period.

[default] 1 second

[range] [1 nanosec,1 year]

Duration_t DDS::DiscoveryConfigQosPolicy::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 DDS::DiscoveryConfigQosPolicy::min_initial_participant_announcement_period and this is introduced in between initial announcements when a new remote participant is discovered.

The setting of DDS::DiscoveryConfigQosPolicy::max_initial_participant_announcement_period must be consistent with DDS::DiscoveryConfigQosPolicy::min_initial_participant_announcement_period. For these two values to be consistent, they must verify that:

DDS::DiscoveryConfigQosPolicy::min_initial_participant_announcement_period <= DDS::DiscoveryConfigQosPolicy::max_initial_participant_announcement_period.

[default] 1 second

[range] [1 nanosec,1 year]

BuiltinTopicReaderResourceLimits_t DDS::DiscoveryConfigQosPolicy::participant_reader_resource_limits

Resource limits.

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

RtpsReliableReaderProtocol_t DDS::DiscoveryConfigQosPolicy::publication_reader

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

For details, refer to the DDS::RtpsReliableReaderProtocol_t

[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;

BuiltinTopicReaderResourceLimits_t DDS::DiscoveryConfigQosPolicy::publication_reader_resource_limits

Resource limits.

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

RtpsReliableReaderProtocol_t DDS::DiscoveryConfigQosPolicy::subscription_reader

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

For details, refer to the DDS::RtpsReliableReaderProtocol_t

[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;

BuiltinTopicReaderResourceLimits_t DDS::DiscoveryConfigQosPolicy::subscription_reader_resource_limits

Resource limits.

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

RtpsReliableWriterProtocol_t DDS::DiscoveryConfigQosPolicy::publication_writer

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

For details, refer to the DDS::RtpsReliableWriterProtocol_t

[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::Duration_t::DURATION_INFINITE;
samples_per_virtual_heartbeat DDS::ResourceLimitsQosPolicy::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::ResourceLimitsQosPolicy::LENGTH_UNLIMITED;
max_send_window_size DDS::ResourceLimitsQosPolicy::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;

WriterDataLifecycleQosPolicy DDS::DiscoveryConfigQosPolicy::publication_writer_data_lifecycle

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

For details, refer to the DDS::WriterDataLifecycleQosPolicy. DDS::WriterDataLifecycleQosPolicy::autodispose_unregistered_instances will always be forced to true.

RtpsReliableWriterProtocol_t DDS::DiscoveryConfigQosPolicy::subscription_writer

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

For details, refer to the DDS::RtpsReliableWriterProtocol_t

[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::Duration_t::DURATION_INFINITE;
samples_per_virtual_heartbeat DDS::ResourceLimitsQosPolicy::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::ResourceLimitsQosPolicy::LENGTH_UNLIMITED;
max_send_window_size DDS::ResourceLimitsQosPolicy::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;

WriterDataLifecycleQosPolicy DDS::DiscoveryConfigQosPolicy::subscription_writer_data_lifecycle

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

For details, refer to the DDS::WriterDataLifecycleQosPolicy. DDS::WriterDataLifecycleQosPolicy::autodispose_unregistered_instances will always be forced to true.

System::Int32 DDS::DiscoveryConfigQosPolicy::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] ::DDS::DiscoveryConfigBuiltinPluginKind::DISCOVERYCONFIG_BUILTIN_SDP

ReliabilityQosPolicyKind DDS::DiscoveryConfigQosPolicy::participant_message_reader_reliability_kind

Reliability policy for a built-in participant message reader.

For details, refer to the ::DDS::ReliabilityQosPolicyKind.

[default] ::DDS::ReliabilityQosPolicyKind::BEST_EFFORT_RELIABILITY_QOS

RtpsReliableReaderProtocol_t DDS::DiscoveryConfigQosPolicy::participant_message_reader

RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if DDS::DiscoveryConfigQosPolicy::participant_message_reader_reliability_kind is set to ::DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS.

For details, refer to the DDS::RtpsReliableReaderProtocol_t

[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;

RtpsReliableWriterProtocol_t DDS::DiscoveryConfigQosPolicy::participant_message_writer

RTPS protocol-related configuration settings for the RTPS reliable writer associated to the built-in participant message writer. This parameter only has effect if the matching participant message reader is configured with ::DDS::ReliabilityQosPolicyKind::RELIABLE_RELIABILITY_QOS ::DDS::ReliabilityQosPolicyKind.

For details, refer to the DDS::RtpsReliableWriterProtocol_t

[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::Duration_t::DURATION_INFINITE;
samples_per_virtual_heartbeat DDS::ResourceLimitsQosPolicy::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::ResourceLimitsQosPolicy::LENGTH_UNLIMITED;
max_send_window_size DDS::ResourceLimitsQosPolicy::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;

PublishModeQosPolicy ^ DDS::DiscoveryConfigQosPolicy::publication_writer_publish_mode

Publish mode policy for the built-in publication writer.

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

PublishModeQosPolicy ^ DDS::DiscoveryConfigQosPolicy::subscription_writer_publish_mode

Publish mode policy for the built-in subscription writer.

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

AsynchronousPublisherQosPolicy ^ DDS::DiscoveryConfigQosPolicy::asynchronous_publisher

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

Duration_t DDS::DiscoveryConfigQosPolicy::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::Duration_t::DURATION_INFINITE.

When this period is set to a value other than DDS::Duration_t::DURATION_INFINITE and DDS::DiscoveryConfigQosPolicy::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::ParticipantBuiltinTopicData built-in DataReader's listener.

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

[default] 30 seconds

[range] [1 nanosec,1 year] or DDS::Duration_t::DURATION_INFINITE

See Also: DDS::ParticipantBuiltinTopicData::domain_id; DDS::DiscoveryConfigQosPolicy::ignore_default_domain_announcements

Property Documentation

System:: Boolean DDS::DiscoveryConfigQosPolicy::ignore_default_domain_announcements

getset

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::ParticipantBuiltinTopicData built-in DataReader.

[default] true

See Also: DDS::ParticipantBuiltinTopicData::domain_id; DDS::DiscoveryConfigQosPolicy::default_domain_announcement_period

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Member Data Documentation

Property Documentation