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

<<cert>> Specifies the wire-protocol-related attributes for the DDS_DomainParticipant. More...

#include <dds_c_infrastructure.h>

Data Fields

DDS_Long participant_id
 A value used to distinguish between different participants belonging to the same domain on the same host.
DDS_UnsignedLong rtps_host_id
 The RTPS Host ID of the domain participant.
DDS_UnsignedLong rtps_app_id
 The RTPS App ID of the domain participant.
DDS_UnsignedLong rtps_instance_id
 The RTPS Instance ID of the domain participant.
struct DDS_RtpsWellKnownPorts_t rtps_well_known_ports
 Configures the RTPS well-known port mappings.

Detailed Description

<<cert>> Specifies the wire-protocol-related attributes for the DDS_DomainParticipant.

Entity:
DDS_DomainParticipant
Properties:
RxO = N/A
Changeable = NO

Usage

The default Qos policies returned by RTI Connext DDS Micro contain the correctly initialized wire protocol attributes.

The defaults are not expected to be modified normally, but are available to the advanced user customizing the implementation behavior.

The default values should not be modified without an understanding of the underlying Real-Time Publish Subscribe (RTPS) wire protocol.


Field Documentation

DDS_Long DDS_WireProtocolQosPolicy::participant_id

A value used to distinguish between different participants belonging to the same domain on the same host.

Determines the unicast port on which meta-traffic is received. Also defines the default unicast port for receiving user-traffic for DataReaders and DataWriters .

For more information on port mapping, please refer to DDS_RtpsWellKnownPorts_t.

Each DDS_DomainParticipant in the same domain, running on the same host, must have a unique participant_id. The participants may be in the same address space or in distinct address spaces.

A negative number (-1) means that RTI Connext DDS Micro will automatically resolve the participant ID as follows.

  • RTI Connext DDS Micro will pick the smallest participant ID, based on the unicast ports available on the transports enabled for discovery.
  • RTI Connext DDS Micro will attempt to resolve an automatic port index either when a DomainPartcipant is enabled, or when a DataReader or a DataWriter is created. Therefore, all the transports enabled for discovery must have been registered by this time. Otherwise, the discovery transports registered after resolving the automatic port index may produce port conflicts when the DomainPartcipant is enabled.

[default] -1 [automatic], i.e. RTI Connext DDS Micro will automatically pick the participant_id, as described above.

[range] [>= 0], or -1, and does not violate guidelines stated in DDS_RtpsWellKnownPorts_t.

See also:
DDS_Entity_enable()
DDS_UnsignedLong DDS_WireProtocolQosPolicy::rtps_host_id

The RTPS Host ID of the domain participant.

Either all of DDS_WireProtocolQosPolicy::rtps_host_id, DDS_WireProtocolQosPolicy::rtps_app_id, and DDS_WireProtocolQosPolicy::rtps_instance_id for a DomainParticipant are set to DDS_RTPS_AUTO_ID, or none of them are set to DDS_RTPS_AUTO_ID.

[default] DDS_RTPS_AUTO_ID.

[range] [0,0xffffffff]

DDS_UnsignedLong DDS_WireProtocolQosPolicy::rtps_app_id

The RTPS App ID of the domain participant.

Either all of DDS_WireProtocolQosPolicy::rtps_host_id, DDS_WireProtocolQosPolicy::rtps_app_id, and DDS_WireProtocolQosPolicy::rtps_instance_id for a DomainParticipant are set to DDS_RTPS_AUTO_ID, or none of them are set to DDS_RTPS_AUTO_ID.

[default] DDS_RTPS_AUTO_ID.

[range] [0,0xffffffff]

DDS_UnsignedLong DDS_WireProtocolQosPolicy::rtps_instance_id

The RTPS Instance ID of the domain participant.

Either all of DDS_WireProtocolQosPolicy::rtps_host_id, DDS_WireProtocolQosPolicy::rtps_app_id, and DDS_WireProtocolQosPolicy::rtps_instance_id for a DomainParticipant are set to DDS_RTPS_AUTO_ID, or none of them are set to DDS_RTPS_AUTO_ID.

[default] DDS_RTPS_AUTO_ID.

[range] [0,0xffffffff]

struct DDS_RtpsWellKnownPorts_t DDS_WireProtocolQosPolicy::rtps_well_known_ports

Configures the RTPS well-known port mappings.

Determines the well-known multicast and unicast port mappings for discovery (meta) traffic and user traffic.

[default] DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS


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