RTI Connext C API Version 7.3.0
DDS_ParticipantBuiltinTopicData Struct Reference

Entry created when a DomainParticipant object is discovered. More...

Data Fields

DDS_BuiltinTopicKey_t key
 DCPS key to distinguish entries. More...
 
struct DDS_UserDataQosPolicy user_data
 Policy of the corresponding DomainParticipant. More...
 
struct DDS_PropertyQosPolicy property
 <<extension>> Name value pair properties to be stored with DomainParticipant More...
 
DDS_ProtocolVersion_t rtps_protocol_version
 <<extension>> Version number of the RTPS wire protocol used. More...
 
struct DDS_VendorId_t rtps_vendor_id
 <<extension>> ID of vendor implementing the RTPS wire protocol. More...
 
DDS_UnsignedLong dds_builtin_endpoints
 <<extension>> Bitmap of builtin endpoints supported by the participant. More...
 
struct DDS_LocatorSeq default_unicast_locators
 <<extension>> Unicast locators used when individual entities do not specify unicast locators. More...
 
struct DDS_ProductVersion_t product_version
 <<extension>> This is a vendor specific parameter. It gives the current version for rti-dds. More...
 
struct DDS_EntityNameQosPolicy participant_name
 <<extension>> The participant name and role name. More...
 
DDS_DomainId_t domain_id
 <<extension>> Domain ID associated with the discovered participant. More...
 
struct DDS_TransportInfoSeq transport_info
 <<extension>> A sequence of DDS_TransportInfo_t containing information about each of the installed transports of the discovered participant. More...
 
struct DDS_Duration_t reachability_lease_duration
 <<extension>> Locator reachability lease duration. More...
 
struct DDS_PartitionQosPolicy partition
 <<extension>> PartitionQosPolicy of the participant. More...
 
DDS_ParticipantTrustProtectionInfo trust_protection_info
 <<extension>> Trust Plugins protection information associated with the discovered DomainParticipant. More...
 
DDS_ParticipantTrustAlgorithmInfo trust_algorithm_info
 <<extension>> Trust Plugins algorithms associated with the discovered DomainParticipant. More...
 
DDS_Boolean partial_configuration
 <<extension>> Indicates whether a DDS_ParticipantBuiltinTopicData only contains bootstrapping information. More...
 

Detailed Description

Entry created when a DomainParticipant object is discovered.

Data associated with the built-in topic DDS_PARTICIPANT_TOPIC_NAME. It contains QoS policies and additional information that apply to the remote DDS_DomainParticipant.

See also
DDS_PARTICIPANT_TOPIC_NAME
DDS_ParticipantBuiltinTopicDataDataReader

Field Documentation

◆ key

DDS_BuiltinTopicKey_t DDS_ParticipantBuiltinTopicData::key

DCPS key to distinguish entries.

◆ user_data

struct DDS_UserDataQosPolicy DDS_ParticipantBuiltinTopicData::user_data

Policy of the corresponding DomainParticipant.

◆ property

struct DDS_PropertyQosPolicy DDS_ParticipantBuiltinTopicData::property

<<extension>> Name value pair properties to be stored with DomainParticipant

◆ rtps_protocol_version

DDS_ProtocolVersion_t DDS_ParticipantBuiltinTopicData::rtps_protocol_version

<<extension>> Version number of the RTPS wire protocol used.

◆ rtps_vendor_id

struct DDS_VendorId_t DDS_ParticipantBuiltinTopicData::rtps_vendor_id

<<extension>> ID of vendor implementing the RTPS wire protocol.

◆ dds_builtin_endpoints

DDS_UnsignedLong DDS_ParticipantBuiltinTopicData::dds_builtin_endpoints

<<extension>> Bitmap of builtin endpoints supported by the participant.

Each bit indicates a builtin endpoint that may be available on the participant for use in discovery.

◆ default_unicast_locators

struct DDS_LocatorSeq DDS_ParticipantBuiltinTopicData::default_unicast_locators

<<extension>> Unicast locators used when individual entities do not specify unicast locators.

◆ product_version

struct DDS_ProductVersion_t DDS_ParticipantBuiltinTopicData::product_version

<<extension>> This is a vendor specific parameter. It gives the current version for rti-dds.

◆ participant_name

struct DDS_EntityNameQosPolicy DDS_ParticipantBuiltinTopicData::participant_name

<<extension>> The participant name and role name.

This parameter contains the name and the role name of the discovered participant.

◆ domain_id

DDS_DomainId_t DDS_ParticipantBuiltinTopicData::domain_id

<<extension>> Domain ID associated with the discovered participant.

◆ transport_info

struct DDS_TransportInfoSeq DDS_ParticipantBuiltinTopicData::transport_info

<<extension>> A sequence of DDS_TransportInfo_t containing information about each of the installed transports of the discovered participant.

This parameter contains a sequence of DDS_TransportInfo_t containing the class_id and message_size_max for all installed transports of the discovered participant. The maximum number of DDS_TransportInfo_t that will be stored in this sequence is controlled by the Domain Participant's resource limit DDS_DomainParticipantResourceLimitsQosPolicy::transport_info_list_max_length.

◆ reachability_lease_duration

struct DDS_Duration_t DDS_ParticipantBuiltinTopicData::reachability_lease_duration

<<extension>> Locator reachability lease duration.

This parameter contains the value of the participant properties: dds.domain_participant.locator_reachability_lease_duration.sec and dds.domain_participant.locator_reachability_lease_duration.nanosec used to configured the locator reachability lease duration.

◆ partition

struct DDS_PartitionQosPolicy DDS_ParticipantBuiltinTopicData::partition

<<extension>> PartitionQosPolicy of the participant.

◆ trust_protection_info

DDS_ParticipantTrustProtectionInfo DDS_ParticipantBuiltinTopicData::trust_protection_info

<<extension>> Trust Plugins protection information associated with the discovered DomainParticipant.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged DomainParticipant data and metadata.

trust_protection_info contains information about how RTPS wire serialization, discovery, and liveliness interact with the loaded Trust Plugins. Two DomainParticipants will not match if their trust_protection_info is incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the DomainParticipant is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ trust_algorithm_info

DDS_ParticipantTrustAlgorithmInfo DDS_ParticipantBuiltinTopicData::trust_algorithm_info

<<extension>> Trust Plugins algorithms associated with the discovered DomainParticipant.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged DomainParticipant data and metadata. trust_algorithm_info contains information about what algorithms the loaded Trust Plugins are running. Two DomainParticipants will not match if their trust_algorithm_info are incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the DomainParticipant is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ partial_configuration

DDS_Boolean DDS_ParticipantBuiltinTopicData::partial_configuration

<<extension>> Indicates whether a DDS_ParticipantBuiltinTopicData only contains bootstrapping information.

If this is DDS_BOOLEAN_TRUE, the DDS_ParticipantBuiltinTopicData only contains bootstrapping information. If it is DDS_BOOLEAN_FALSE, it contains both bootstrapping and configuration information. The following fields are valid when this is set to DDS_BOOLEAN_TRUE:

All other fields are invalid.

This field will only be set to DDS_BOOLEAN_TRUE if a participant using DDS_DISCOVERYCONFIG_BUILTIN_SPDP2 receives a bootstrap message and DDS_DiscoveryConfigQosPolicy::ignore_default_domain_announcements is set to DDS_BOOLEAN_FALSE (non-default).

If a participant is using DDS_DISCOVERYCONFIG_BUILTIN_SPDP, this field will always be set to DDS_BOOLEAN_FALSE.