RTI Connext Micro C API  2.4.14.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
WIRE_PROTOCOL

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

Data Structures

struct  DDS_RtpsWellKnownPorts_t
 RTPS well-known port mapping configuration. More...
struct  DDS_WireProtocolQosPolicy
 <<cert>> Specifies the wire-protocol-related attributes for the DDS_DomainParticipant. More...

Macros

#define DDS_CHECKSUM_NONE   (0)
 Bitmap indicating no checksum selection.
#define DDS_CHECKSUM_AUTO   (0xffffU)
 Bitmap indicating automatic checksum selection.
#define DDS_CHECKSUM_BUILTIN32   (0x1U)
 Bitmap for selecting the builtin 32bit checksum.
#define DDS_CHECKSUM_BUILTIN64   (0x2U)
 Bitmap for selecting the builtin 64bit checksum.
#define DDS_CHECKSUM_BUILTIN128   (0x4U)
 Bitmap for selecting the builtin 128bit checksum.

Typedefs

typedef DDS_UnsignedShort DDS_ChecksumKind_t
 Datatype for checksum kind.
typedef DDS_UnsignedShort DDS_ChecksumKindMask_t
 Datatype for an OR'ing for DDS_ChecksumKind_t .

Variables

struct DDS_RtpsWellKnownPorts_t DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
 Assign to use well-known port mappings which are compatible with previous versions of the RTI Connext Micro middleware.
struct DDS_RtpsWellKnownPorts_t DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
 Assign to use well-known port mappings which are compliant with OMG's DDS Interoperability Wire Protocol.
const char *const DDS_WIREPROTOCOL_QOS_POLICY_NAME
 Stringified human-readable name for DDS_WireProtocolQosPolicy.

Detailed Description

<<eXtension>> Specifies the wire protocol related attributes for the DDS_DomainParticipant.


Macro Definition Documentation

#define DDS_CHECKSUM_NONE   (0)

Bitmap indicating no checksum selection.

QoS:
DDS_WireProtocolQosPolicy
#define DDS_CHECKSUM_AUTO   (0xffffU)

Bitmap indicating automatic checksum selection.

QoS:
DDS_WireProtocolQosPolicy
#define DDS_CHECKSUM_BUILTIN32   (0x1U)

Bitmap for selecting the builtin 32bit checksum.

QoS:
DDS_WireProtocolQosPolicy
#define DDS_CHECKSUM_BUILTIN64   (0x2U)

Bitmap for selecting the builtin 64bit checksum.

QoS:
DDS_WireProtocolQosPolicy
#define DDS_CHECKSUM_BUILTIN128   (0x4U)

Bitmap for selecting the builtin 128bit checksum.

QoS:
DDS_WireProtocolQosPolicy

Typedef Documentation

Datatype for checksum kind.

QoS:
DDS_WireProtocolQosPolicy

Variable Documentation

struct DDS_RtpsWellKnownPorts_t DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS

Assign to use well-known port mappings which are compatible with previous versions of the RTI Connext Micro middleware.

Assign DDS_WireProtocolQosPolicy::rtps_well_known_ports to this value to remain compatible with previous versions of the RTI Connext Micro middleware that used fixed port mappings.

The following are the rtps_well_known_ports values for DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS:

port_base = 7400
domain_id_gain = 10
participant_id_gain = 1000
builtin_multicast_port_offset = 2
builtin_unicast_port_offset = 0
user_multicast_port_offset = 1
user_unicast_port_offset = 3

These settings are not compliant with OMG's DDS Interoperability Wire Protocol. To comply with the specification, please use DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS.

See also:
DDS_WireProtocolQosPolicy::rtps_well_known_ports
DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
struct DDS_RtpsWellKnownPorts_t DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS

Assign to use well-known port mappings which are compliant with OMG's DDS Interoperability Wire Protocol.

Assign DDS_WireProtocolQosPolicy::rtps_well_known_ports to this value to use well-known port mappings which are compliant with OMG's DDS Interoperability Wire Protocol.

The following are the rtps_well_known_ports values for DDS_INTEROPERABLE_RTPS_WELL_KNOWN_PORTS:

port_base = 7400
domain_id_gain = 250
participant_id_gain = 2
builtin_multicast_port_offset = 0
builtin_unicast_port_offset = 10
user_multicast_port_offset = 1
user_unicast_port_offset = 11

Assuming a maximum port number of 65535 (UDPv4), the above settings enable the use of about 230 domains with up to 120 Participants per node per domain.

These settings are not backwards compatible with previous versions of the RTI Connext Micro middleware that used fixed port mappings. For backwards compability, please use DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS.

See also:
DDS_WireProtocolQosPolicy::rtps_well_known_ports
DDS_RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
const char* const DDS_WIREPROTOCOL_QOS_POLICY_NAME

Stringified human-readable name for DDS_WireProtocolQosPolicy.


RTI Connext Micro C API 2.4.14.2 Copyright © Tue May 28 2024 Real-Time Innovations, Inc