RTI Connext C# API  6.1.2
DiscoveryConfig Class Reference

Controls how often to send discovery packets, how to determine when participants are alive or dead, and resources used by the discovery mechanism. More...

Inherits IEquatable< DiscoveryConfig >.

Public Member Functions

DiscoveryConfig With (Action< DiscoveryConfigBuilder > build)
 Creates a new DiscoveryConfig with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (DiscoveryConfig other)
 Compares for equality More...
 

Properties

Duration ParticipantLivelinessLeaseDuration [get]
 The liveliness lease duration for the participant. More...
 
Duration ParticipantLivelinessAssertPeriod [get]
 The period to assert liveliness for the participant. More...
 
RemoteParticipantPurgeKind RemoteParticipantPurgeKind [get]
 The participant's behavior for maintaining knowledge of remote participants (and their contained entities) with which discovery communication has been lost. More...
 
Duration MaxLivelinessLossDetectionPeriod [get]
 The maximum amount of time between when a remote entity stops maintaining its liveliness and when the matched local entity realizes that fact. More...
 
int InitialParticipantAnnouncements [get]
 The number of initial announcements sent when a participant is first enabled or when a remote participant is newly discovered. More...
 
Duration MinInitialParticipantAnnouncementPeriod [get]
 The minimum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
Duration MaxInitialParticipantAnnouncementPeriod [get]
 The maximum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
BuiltinTopicReaderResourceLimits ParticipantReaderResourceLimits [get]
 Resource limits. More...
 
RtpsReliableReaderProtocol PublicationReader [get]
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader. More...
 
BuiltinTopicReaderResourceLimits PublicationReaderResourceLimits [get]
 Resource limits. More...
 
RtpsReliableReaderProtocol SubscriptionReader [get]
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in subscription reader. More...
 
BuiltinTopicReaderResourceLimits SubscriptionReaderResourceLimits [get]
 Resource limits. More...
 
RtpsReliableWriterProtocol PublicationWriter [get]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in publication writer. More...
 
WriterDataLifecycle PublicationWriterDataLifecycle [get]
 Writer data lifecycle settings for a built-in publication writer. More...
 
RtpsReliableWriterProtocol SubscriptionWriter [get]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in subscription writer. More...
 
WriterDataLifecycle SubscriptionWriterDataLifecycle [get]
 Writer data lifecycle settings for a built-in subscription writer. More...
 
BuiltinPluginKind BuiltinDiscoveryPlugins [get]
 The mask kind for built-in discovery plugins. More...
 
ReliabilityKind ParticipantMessageReaderReliabilityKind [get]
 Reliability policy for a built-in participant message reader. More...
 
RtpsReliableReaderProtocol ParticipantMessageReader [get]
 RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if ParticipantMessageReaderReliabilityKind is set to ReliabilityKind.ReliabilityKind. More...
 
RtpsReliableWriterProtocol ParticipantMessageWriter [get]
 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 ReliabilityKind.ReliabilityKind. More...
 
PublishMode PublicationWriterPublishMode [get]
 Publish mode policy for the built-in publication writer. More...
 
PublishMode SubscriptionWriterPublishMode [get]
 Publish mode policy for the built-in subscription writer. More...
 
AsynchronousPublisher AsynchronousPublisher [get]
 Asynchronous publishing settings for the discovery Publication.Publisher and all entities that are created by it. More...
 
Duration DefaultDomainAnnouncementPeriod [get]
 The period to announce a participant to the default domain 0. More...
 
bool IgnoreDefaultDomainAnnouncements [get]
 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...
 
RtpsReliableWriterProtocol ServiceRequestWriter [get]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in ServiceRequest writer. More...
 
WriterDataLifecycle ServiceRequestWriterDataLifecycle [get]
 Writer data lifecycle settings for a built-in ServiceRequest writer. More...
 
PublishMode ServiceRequestWriterPublishMode [get]
 Publish mode policy for the built-in service request writer. More...
 
RtpsReliableReaderProtocol ServiceRequestReader [get]
 RTPS reliable reader protocol-related configuration settings for a built-in ServiceRequest reader. More...
 
Duration LocatorReachabilityAssertPeriod [get]
 Period at which this DomainParticipant will assert the locators discovered from other DomainParticipants. More...
 
Duration LocatorReachabilityLeaseDuration [get]
 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...
 
Duration LocatorReachabilityChangeDetectionPeriod [get]
 Period at which this DomainParticipant will check if its locators are reachable from other DomainParticipants. More...
 
RtpsReliableWriterProtocol SecureVolatileWriter [get]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in secure volatile writer. More...
 
PublishMode SecureVolatileWriterPublishMode [get]
 Publish mode policy for the built-in secure volatile writer. More...
 
RtpsReliableReaderProtocol SecureVolatileReader [get]
 RTPS reliable reader protocol-related configuration settings for the built-in secure volatile reader. More...
 
int EndpointTypeObjectLbSerializationThreshold [get]
 Option to reduce the size required to propagate a TypeObject in Simple Endpoint Discovery More...
 
Duration DnsTrackerPollingPeriod [get]
 Duration that specifies the period used by the DNS tracker to poll the DNS service and check for changes in the hostnames. More...
 
static DiscoveryConfig Default [get]
 Singleton containing the default value of a DiscoveryConfig More...
 

Detailed Description

Controls how often to send discovery packets, how to determine when participants are alive or dead, and resources used by the discovery mechanism.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( DiscoveryConfig  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

DiscoveryConfig With ( Action< DiscoveryConfigBuilder build)

Creates a new DiscoveryConfig with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this DiscoveryConfig.
Returns
A new DiscoveryConfig with the changes applied by the Action

Property Documentation

◆ AsynchronousPublisher

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::asynchronous_publisher

◆ BuiltinDiscoveryPlugins

BuiltinPluginKind BuiltinDiscoveryPlugins
get

The mask kind for built-in discovery plugins.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::builtin_discovery_plugins

◆ Default

DiscoveryConfig Default
staticget

Singleton containing the default value of a DiscoveryConfig

◆ DefaultDomainAnnouncementPeriod

Duration DefaultDomainAnnouncementPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::default_domain_announcement_period

◆ DnsTrackerPollingPeriod

Duration DnsTrackerPollingPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::dns_tracker_polling_period

◆ EndpointTypeObjectLbSerializationThreshold

int EndpointTypeObjectLbSerializationThreshold
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::endpoint_type_object_lb_serialization_threshold

◆ IgnoreDefaultDomainAnnouncements

bool IgnoreDefaultDomainAnnouncements
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::ignore_default_domain_announcements

◆ InitialParticipantAnnouncements

int InitialParticipantAnnouncements
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::initial_participant_announcements

◆ LocatorReachabilityAssertPeriod

Duration LocatorReachabilityAssertPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::locator_reachability_assert_period

◆ LocatorReachabilityChangeDetectionPeriod

Duration LocatorReachabilityChangeDetectionPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::locator_reachability_change_detection_period

◆ LocatorReachabilityLeaseDuration

Duration LocatorReachabilityLeaseDuration
get

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.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::locator_reachability_lease_duration

◆ MaxInitialParticipantAnnouncementPeriod

Duration MaxInitialParticipantAnnouncementPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::max_initial_participant_announcement_period

◆ MaxLivelinessLossDetectionPeriod

Duration MaxLivelinessLossDetectionPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::max_liveliness_loss_detection_period

◆ MinInitialParticipantAnnouncementPeriod

Duration MinInitialParticipantAnnouncementPeriod
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::min_initial_participant_announcement_period

◆ ParticipantLivelinessAssertPeriod

Duration ParticipantLivelinessAssertPeriod
get

The period to assert liveliness for the participant.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_liveliness_assert_period

◆ ParticipantLivelinessLeaseDuration

Duration ParticipantLivelinessLeaseDuration
get

The liveliness lease duration for the participant.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_liveliness_lease_duration

◆ ParticipantMessageReader

RtpsReliableReaderProtocol ParticipantMessageReader
get

RTPS reliable reader protocol-related configuration settings for a built-in participant message reader. This parameter only has effect if ParticipantMessageReaderReliabilityKind is set to ReliabilityKind.ReliabilityKind.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_message_reader

◆ ParticipantMessageReaderReliabilityKind

ReliabilityKind ParticipantMessageReaderReliabilityKind
get

Reliability policy for a built-in participant message reader.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_message_reader_reliability_kind

◆ ParticipantMessageWriter

RtpsReliableWriterProtocol ParticipantMessageWriter
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_message_writer

◆ ParticipantReaderResourceLimits

BuiltinTopicReaderResourceLimits ParticipantReaderResourceLimits
get

Resource limits.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::participant_reader_resource_limits

◆ PublicationReader

RtpsReliableReaderProtocol PublicationReader
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::publication_reader

◆ PublicationReaderResourceLimits

BuiltinTopicReaderResourceLimits PublicationReaderResourceLimits
get

Resource limits.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::publication_reader_resource_limits

◆ PublicationWriter

RtpsReliableWriterProtocol PublicationWriter
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::publication_writer

◆ PublicationWriterDataLifecycle

WriterDataLifecycle PublicationWriterDataLifecycle
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::publication_writer_data_lifecycle

◆ PublicationWriterPublishMode

PublishMode PublicationWriterPublishMode
get

Publish mode policy for the built-in publication writer.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::publication_writer_publish_mode

◆ RemoteParticipantPurgeKind

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::remote_participant_purge_kind

◆ SecureVolatileReader

RtpsReliableReaderProtocol SecureVolatileReader
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::secure_volatile_reader

◆ SecureVolatileWriter

RtpsReliableWriterProtocol SecureVolatileWriter
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::secure_volatile_writer

◆ SecureVolatileWriterPublishMode

PublishMode SecureVolatileWriterPublishMode
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::secure_volatile_writer_publish_mode

◆ ServiceRequestReader

RtpsReliableReaderProtocol ServiceRequestReader
get

RTPS reliable reader protocol-related configuration settings for a built-in ServiceRequest reader.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::service_request_reader

◆ ServiceRequestWriter

RtpsReliableWriterProtocol ServiceRequestWriter
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::service_request_writer

◆ ServiceRequestWriterDataLifecycle

WriterDataLifecycle ServiceRequestWriterDataLifecycle
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::service_request_writer_data_lifecycle

◆ ServiceRequestWriterPublishMode

PublishMode ServiceRequestWriterPublishMode
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::service_request_writer_publish_mode

◆ SubscriptionReader

RtpsReliableReaderProtocol SubscriptionReader
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::subscription_reader

◆ SubscriptionReaderResourceLimits

BuiltinTopicReaderResourceLimits SubscriptionReaderResourceLimits
get

Resource limits.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::subscription_reader_resource_limits

◆ SubscriptionWriter

RtpsReliableWriterProtocol SubscriptionWriter
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::subscription_writer

◆ SubscriptionWriterDataLifecycle

WriterDataLifecycle SubscriptionWriterDataLifecycle
get

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

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::subscription_writer_data_lifecycle

◆ SubscriptionWriterPublishMode

PublishMode SubscriptionWriterPublishMode
get

Publish mode policy for the built-in subscription writer.

The full documentation is available in the C API: DDS_DiscoveryConfigQosPolicy::subscription_writer_publish_mode