RTI Connext C# API  6.1.2
DiscoveryConfigBuilder Class Reference

A modifiable type used to create an immutable DiscoveryConfig More...

Public Member Functions

 DiscoveryConfigBuilder (DiscoveryConfig data)
 Creates a builder with the values of an existing immutable instance More...
 
DiscoveryConfig Build ()
 Creates a new DiscoveryConfig immutable object from this one. More...
 

Properties

Duration ParticipantLivelinessLeaseDuration [get, set]
 The liveliness lease duration for the participant. More...
 
Duration ParticipantLivelinessAssertPeriod [get, set]
 The period to assert liveliness for the participant. More...
 
RemoteParticipantPurgeKind RemoteParticipantPurgeKind [get, set]
 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, set]
 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, set]
 The number of initial announcements sent when a participant is first enabled or when a remote participant is newly discovered. More...
 
Duration MinInitialParticipantAnnouncementPeriod [get, set]
 The minimum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
Duration MaxInitialParticipantAnnouncementPeriod [get, set]
 The maximum period between initial announcements when a participant is first enabled or when a remote participant is newly discovered. More...
 
BuiltinTopicReaderResourceLimitsBuilder ParticipantReaderResourceLimits [get, set]
 Resource limits. More...
 
RtpsReliableReaderProtocolBuilder PublicationReader [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in publication reader. More...
 
BuiltinTopicReaderResourceLimitsBuilder PublicationReaderResourceLimits [get, set]
 Resource limits. More...
 
RtpsReliableReaderProtocolBuilder SubscriptionReader [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a built-in subscription reader. More...
 
BuiltinTopicReaderResourceLimitsBuilder SubscriptionReaderResourceLimits [get, set]
 Resource limits. More...
 
RtpsReliableWriterProtocolBuilder PublicationWriter [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in publication writer. More...
 
WriterDataLifecycleBuilder PublicationWriterDataLifecycle [get, set]
 Writer data lifecycle settings for a built-in publication writer. More...
 
RtpsReliableWriterProtocolBuilder SubscriptionWriter [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with a built-in subscription writer. More...
 
WriterDataLifecycleBuilder SubscriptionWriterDataLifecycle [get, set]
 Writer data lifecycle settings for a built-in subscription writer. More...
 
BuiltinPluginKind BuiltinDiscoveryPlugins [get, set]
 The kind mask for built-in discovery plugins. More...
 
ReliabilityKind ParticipantMessageReaderReliabilityKind [get, set]
 Reliability policy for a built-in participant message reader. More...
 
RtpsReliableReaderProtocolBuilder ParticipantMessageReader [get, set]
 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...
 
RtpsReliableWriterProtocolBuilder ParticipantMessageWriter [get, set]
 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...
 
PublishModeBuilder PublicationWriterPublishMode [get, set]
 Publish mode policy for the built-in publication writer. More...
 
PublishModeBuilder SubscriptionWriterPublishMode [get, set]
 Publish mode policy for the built-in subscription writer. More...
 
AsynchronousPublisherBuilder AsynchronousPublisher [get, set]
 Asynchronous publishing settings for the discovery Publication.Publisher and all entities that are created by it. More...
 
Duration DefaultDomainAnnouncementPeriod [get, set]
 The period to announce a participant to the default domain 0. More...
 
bool IgnoreDefaultDomainAnnouncements [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. More...
 
RtpsReliableWriterProtocolBuilder ServiceRequestWriter [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in ServiceRequest writer. More...
 
WriterDataLifecycleBuilder ServiceRequestWriterDataLifecycle [get, set]
 Writer data lifecycle settings for a built-in ServiceRequest writer. More...
 
PublishModeBuilder ServiceRequestWriterPublishMode [get, set]
 Publish mode policy for the built-in service request writer. More...
 
RtpsReliableReaderProtocolBuilder ServiceRequestReader [get, set]
 RTPS reliable reader protocol-related configuration settings for a built-in ServiceRequest reader. More...
 
Duration LocatorReachabilityAssertPeriod [get, set]
 Period at which this DomainParticipant will assert the locators discovered from other DomainParticipants. More...
 
Duration LocatorReachabilityLeaseDuration [get, set]
 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, set]
 Period at which this DomainParticipant will check if its locators are reachable from other DomainParticipants. More...
 
RtpsReliableWriterProtocolBuilder SecureVolatileWriter [get, set]
 RTPS protocol-related configuration settings for the RTPS reliable writer associated with the built-in secure volatile writer. More...
 
PublishModeBuilder SecureVolatileWriterPublishMode [get, set]
 Publish mode policy for the built-in secure volatile writer. More...
 
RtpsReliableReaderProtocolBuilder SecureVolatileReader [get, set]
 RTPS reliable reader protocol-related configuration settings for the built-in secure volatile reader. More...
 
int EndpointTypeObjectLbSerializationThreshold [get, set]
 Option to reduce the size required to propagate a TypeObject in Simple Endpoint Discovery More...
 
Duration DnsTrackerPollingPeriod [get, set]
 Duration that specifies the period used by the DNS tracker to poll the DNS service and check for changes in the hostnames. More...
 

Detailed Description

A modifiable type used to create an immutable DiscoveryConfig

Constructor & Destructor Documentation

◆ DiscoveryConfigBuilder()

Creates a builder with the values of an existing immutable instance

Member Function Documentation

◆ Build()

DiscoveryConfig Build ( )

Creates a new DiscoveryConfig immutable object from this one.

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
getset

The kind mask for built-in discovery plugins.

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

◆ DefaultDomainAnnouncementPeriod

Duration DefaultDomainAnnouncementPeriod
getset

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
getset

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
getset

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

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

◆ InitialParticipantAnnouncements

int InitialParticipantAnnouncements
getset

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
getset

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
getset

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
getset

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
getset

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
getset

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
getset

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
getset

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
getset

The liveliness lease duration for the participant.

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

◆ ParticipantMessageReader

RtpsReliableReaderProtocolBuilder ParticipantMessageReader
getset

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
getset

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

RtpsReliableWriterProtocolBuilder ParticipantMessageWriter
getset

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

BuiltinTopicReaderResourceLimitsBuilder ParticipantReaderResourceLimits
getset

Resource limits.

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

◆ PublicationReader

RtpsReliableReaderProtocolBuilder PublicationReader
getset

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

BuiltinTopicReaderResourceLimitsBuilder PublicationReaderResourceLimits
getset

Resource limits.

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

◆ PublicationWriter

RtpsReliableWriterProtocolBuilder PublicationWriter
getset

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

WriterDataLifecycleBuilder PublicationWriterDataLifecycle
getset

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

PublishModeBuilder PublicationWriterPublishMode
getset

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

RtpsReliableReaderProtocolBuilder SecureVolatileReader
getset

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

RtpsReliableWriterProtocolBuilder SecureVolatileWriter
getset

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

PublishModeBuilder SecureVolatileWriterPublishMode
getset

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

RtpsReliableReaderProtocolBuilder ServiceRequestReader
getset

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

RtpsReliableWriterProtocolBuilder ServiceRequestWriter
getset

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

WriterDataLifecycleBuilder ServiceRequestWriterDataLifecycle
getset

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

PublishModeBuilder ServiceRequestWriterPublishMode
getset

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

RtpsReliableReaderProtocolBuilder SubscriptionReader
getset

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

BuiltinTopicReaderResourceLimitsBuilder SubscriptionReaderResourceLimits
getset

Resource limits.

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

◆ SubscriptionWriter

RtpsReliableWriterProtocolBuilder SubscriptionWriter
getset

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

WriterDataLifecycleBuilder SubscriptionWriterDataLifecycle
getset

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

PublishModeBuilder SubscriptionWriterPublishMode
getset

Publish mode policy for the built-in subscription writer.

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