RTI Connext DDS Micro C API  Version 3.0.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DPDE_DiscoveryPluginProperty Struct Reference

<<eXtension>> Properties for the Dynamic Participant/Dynamic Endpoint (DPDE) discovery plugin. This includes all discovery timing properties for participant discovery. More...

#include <disc_dpde_discovery_plugin.h>

Data Fields

struct DDS_Duration_t participant_liveliness_assert_period
 The period to assert liveliness for the participant.
struct DDS_Duration_t participant_liveliness_lease_duration
 The liveliness lease duration for the participant.
DDS_Long initial_participant_announcements
 The number of initial announcements sent when a participant is first enabled or when a remote participant is newly discovered.
struct DDS_Duration_t initial_participant_announcement_period
 The period between initial announcements when a participant is first enabled or when a remote participant is newly discovered.
DDS_Boolean cache_serialized_samples
 Cache serialized discovery samples for locally created data readers and data writers.
DDS_Long max_participant_locators
 The maximum number of locators the RTI Connext DDS Micro can send to to discover other participants in the same domain.
DDS_Long max_locators_per_discovered_participant
 The maximum number of locators the RTI Connext DDS Micro can keep track of per discovered participant.
DDS_Long max_samples_per_builtin_endpoint_reader
 The maximum number of samples allocated per builtin endpoint datareader.
DDS_Long max_samples_per_remote_builtin_endpoint_writer
 The maximum number of samples allocated per remote builtin writer.
DDS_Long builtin_writer_max_heartbeat_retries
 Maximum number of heartbeat retries for built-in endpoints.
struct DDS_Duration_t builtin_writer_heartbeat_period
 Heartbeat period for built-in endpoints.
DDS_Long builtin_writer_heartbeats_per_max_samples
 Number of heartbeats per max_samples built-in endpoints.
struct DDS_Duration_t builtin_endpoint_reader_nack_period
 The period at which NACKs are sent for the builtin endpoint readers.
DDS_ReliabilityQosPolicyKind participant_message_reader_reliability_kind
 Reliability policy for a built-in participant message reader.

Detailed Description

<<eXtension>> Properties for the Dynamic Participant/Dynamic Endpoint (DPDE) discovery plugin. This includes all discovery timing properties for participant discovery.


Field Documentation

struct DDS_Duration_t DPDE_DiscoveryPluginProperty::participant_liveliness_assert_period

The period to assert liveliness for the participant.

Specifies how often the DomainParticipant's discovery DataWriter will assert the liveliness of the DomainParticipant to its peers.

Should be strictly less than participant_liveliness_lease_duration.

[default] 30 seconds

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

struct DDS_Duration_t DPDE_DiscoveryPluginProperty::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 participant_liveliness_assert_period.

[default] 100 seconds

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

DDS_Long DPDE_DiscoveryPluginProperty::initial_participant_announcements

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

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 will announce itself to the peers a number of times controlled by this parameter.

[default] 5

struct DDS_Duration_t DPDE_DiscoveryPluginProperty::initial_participant_announcement_period

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

[default] 1 second

DDS_Boolean DPDE_DiscoveryPluginProperty::cache_serialized_samples

Cache serialized discovery samples for locally created data readers and data writers.

When a data reader or data writer is enabled locally, the discovery plugin announces this to other participants in its domain. When this value is set to DDS_BOOLEAN_TRUE the serialized sample is stored in case a new particpant is discovered and the information must be sent again. This may improve discovery performance, but increases memory usage. The default value is DDS_BOOLEAN_FALSE which uses less memory.

[default] DDS_BOOLEAN_FALSE

DDS_Long DPDE_DiscoveryPluginProperty::max_participant_locators

The maximum number of locators the RTI Connext DDS Micro can send to to discover other participants in the same domain.

The discovery plugin sends participant annoucements to a number of locators as specified in the initial peer list. The maximum number of locators to send too is specified here.

The value DDS_LENGTH_AUTO calculates the maximum number of locators as DomainParticipantQos.resource_limits.remote_participant_allocation + (DPDE_MAX_ANON_PARTICIPANT * (initial_peers length + 1))

[default] DDS_LENGTH_AUTO

DDS_Long DPDE_DiscoveryPluginProperty::max_locators_per_discovered_participant

The maximum number of locators the RTI Connext DDS Micro can keep track of per discovered participant.

When a participant discover another participant, it must keep track of which addresses to respond to for each participant. NOTE: If two participants respond with the same addresses, for example multicast, only one address is saved.

[default] 4

DDS_Long DPDE_DiscoveryPluginProperty::max_samples_per_builtin_endpoint_reader

The maximum number of samples allocated per builtin endpoint datareader.

The builtin endpoint datareaders are realiable and may cache samples received out-of-order to improve discovery performance. This resource-limit determines the maximum number of outstanding samples at any given time.

[default] 8

[range] [1, 100000000]

DDS_Long DPDE_DiscoveryPluginProperty::max_samples_per_remote_builtin_endpoint_writer

The maximum number of samples allocated per remote builtin writer.

The builtin endpoint datareaders are reliable and may cache samples received out-of-order to improve discovery performance. This resource-limit determines the maximum number of outstanding samples at any given time per remote builtin endpoint datawriter. Note that this limit is per builtin endpoint datareader.

The default value DDS_MAX_UNLIMITED allows a remote builtin endpoint datawriter to potentially use all samples while missing samples are being resent. This may cause samples received by other remote builtin endpoint datawriters to be rejected until the remote builtin endpoint datawriter using all the samples frees up resources.

The following values are supported for this member:

Note that the value of DPDE_DiscoveryPluginProperty::max_samples_per_builtin_endpoint_reader is still limited to [1, 100000000] and a run-time error will occur if the value is exceeded.

[default] DDS_MAX_UNLIMITED

[range] DDS_MAX_UNLIMITED, [1, 256]

DDS_Long DPDE_DiscoveryPluginProperty::builtin_writer_max_heartbeat_retries

Maximum number of heartbeat retries for built-in endpoints.

[default] DDS_LENGTH_UNLIMITED

[range] [1, 100000000] or DDS_LENGTH_UNLIMITED.

struct DDS_Duration_t DPDE_DiscoveryPluginProperty::builtin_writer_heartbeat_period

Heartbeat period for built-in endpoints.

[default] 100 ms.

[range] [1 nanosec,1 year]

DDS_Long DPDE_DiscoveryPluginProperty::builtin_writer_heartbeats_per_max_samples

Number of heartbeats per max_samples built-in endpoints.

[default] DDS_LENGTH_UNLIMITED

[range] [1, local_writer_allocation] or DDS_LENGTH_UNLIMITED.

struct DDS_Duration_t DPDE_DiscoveryPluginProperty::builtin_endpoint_reader_nack_period

The period at which NACKs are sent for the builtin endpoint readers.

Please refer to DDS_RtpsReliableReaderProtocol_t::nack_period for a detailed description.

DDS_ReliabilityQosPolicyKind DPDE_DiscoveryPluginProperty::participant_message_reader_reliability_kind

Reliability policy for a built-in participant message reader.

For details, refer to the DDS_ReliabilityQosPolicyKind.

[default] DDS_BEST_EFFORT_RELIABILITY_QOS


RTI Connext DDS Micro C API Version 3.0.2 Copyright © Thu Dec 12 2019 Real-Time Innovations, Inc