RTI Connext Micro C API  Version 2.4.14.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DPSE_DiscoveryPluginProperty Struct Reference

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

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_Long max_participant_locators
 The maximum number of locators RTI Connext Micro can send to to discover other participants in the same domain.
DDS_Long max_locators_per_discovered_participant
 The maximum number of locators RTI Connext Micro can keep track of per discovered participant.

Detailed Description

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


Field Documentation

struct DDS_Duration_t DPSE_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 DPSE_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 DPSE_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 DPSE_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_Long DPSE_DiscoveryPluginProperty::max_participant_locators

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

The DPSE builtin participant topic DDS_DataWriter allocates max_participant_locators to send participant announcements to. The default value DDS_LENGTH_AUTO calculates max_participant_locators as remote_participant_allocation + (DPSE_MAX_ANON_PARTICIPANT * (peer_length + 1)) where the constant DPSE_MAX_ANON_PARTICIPANT = 6.

A participant locator is defined as a unique index@address to send to where index is an integer >= 0 and only applies to unicast addresses. For multicast address the index is 0. This index is the highest participant_id that will receive participant announcements at the address.

The maximum number of addresses to send to is defined by the peer list (either specified in DDS_DiscoveryQosPolicy::initial_peers or by calling DDS_DomainParticipant_add_peer. The maximum number of addresses needed is determined by adding all indices for all unicast addresses and adding one for each multicast address.

If memory is limited it is advised to set this value as low as possible.

[default] DDS_LENGTH_AUTO;

DDS_Long DPSE_DiscoveryPluginProperty::max_locators_per_discovered_participant

The maximum number of locators RTI Connext 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;


RTI Connext Micro C API Version 2.4.14.1 Copyright © Thu Nov 2 2023 Real-Time Innovations, Inc