RTI Connext Java API  Version 5.0.0
WIRE_PROTOCOL

<<eXtension>> Specifies the wire protocol related attributes for the com.rti.dds.domain.DomainParticipant. More...

Classes

class  RtpsReservedPortKind
 RTPS reserved port kind, used to identify the types of ports that can be reserved on domain participant enable. More...
 
class  RtpsWellKnownPorts_t
 RTPS well-known port mapping configuration. More...
 
class  WireProtocolQosPolicy
 Specifies the wire-protocol-related attributes for the com.rti.dds.domain.DomainParticipant. More...
 
class  WireProtocolQosPolicyAutoKind
 Kind of auto mechanism used to calculate the GUID prefix. More...
 

Variables

static final QosPolicyId_t WIREPROTOCOL_QOS_POLICY_ID
 <<eXtension>> Identifier for com.rti.dds.infrastructure.WireProtocolQosPolicy
 
static final int MASK_DEFAULT = BUILTIN_UNICAST | BUILTIN_MULTICAST | USER_UNICAST
 The default value of com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_reserved_port_mask.
 
static final int MASK_NONE
 No bits are set.
 
static final int MASK_ALL
 All bits are set.
 
static final RtpsWellKnownPorts_t RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
 Assign to use well-known port mappings which are compatible with previous versions of the RTI Connext middleware.
 
static final RtpsWellKnownPorts_t INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
 Assign to use well-known port mappings which are compliant with OMG's DDS Interoperability Wire Protocol.
 
static final
WireProtocolQosPolicyAutoKind 
RTPS_AUTO_ID_FROM_IP = new WireProtocolQosPolicyAutoKind("RTPS_AUTO_ID_FROM_IP", 0)
 Kind of auto mechanism used to calculate the GUID prefix.
 
static final
WireProtocolQosPolicyAutoKind 
RTPS_AUTO_ID_FROM_MAC = new WireProtocolQosPolicyAutoKind("RTPS_AUTO_ID_FROM_MAC", 1)
 Kind of auto mechanism used to calculate the GUID prefix.
 

Detailed Description

<<eXtension>> Specifies the wire protocol related attributes for the com.rti.dds.domain.DomainParticipant.

Variable Documentation

final QosPolicyId_t WIREPROTOCOL_QOS_POLICY_ID
static
final int MASK_DEFAULT = BUILTIN_UNICAST | BUILTIN_MULTICAST | USER_UNICAST
static

The default value of com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_reserved_port_mask.

Most of the ports that may be needed by DDS will be reserved by the transport when the participant is enabled. With this value set, failure to allocate a port that is computed based on the com.rti.dds.infrastructure.RtpsWellKnownPorts_t will be detected at this time and the enable operation will fail.

This setting will avoid reserving the usertraffic multicast port, which is not actually used unless there are DataReaders that enable multicast but fail to specify a port.

Automatic participant ID selection will be based on finding a participant index with both the discovery (metatraffic) unicast port and usertraffic unicast port available.

See Also
com.rti.dds.infrastructure.RtpsReservedPortKindMask
final int MASK_NONE
static

No bits are set.

None of the ports that are needed by DDS will be allocated until they are specifically required. With this value set, automatic participant Id selection will be based on selecting a port for discovery (metatraffic) unicast traffic on a single transport.

See Also
com.rti.dds.infrastructure.RtpsReservedPortKindMask
final int MASK_ALL
static

All bits are set.

All of the ports that may be needed by DDS will be reserved when the participant is enabled. With this value set, failure to allocate a port that is computed based on the com.rti.dds.infrastructure.RtpsWellKnownPorts_t will be detected at this time, and the enable operation will fail.

Note that this will also reserve the usertraffic multicast port which is not actually used unless there are DataReaders that enable multicast but fail to specify a port. To avoid unnecesary resource usage for these ports, use RTPS_RESERVED_PORT_MASK_DEFAULT.

Automatic participant ID selection will be based on finding a participant index with both the discovery (metatraffic) unicast port and usertraffic unicast port available.

See Also
com.rti.dds.infrastructure.RtpsReservedPortKindMask
final RtpsWellKnownPorts_t RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
static

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

Assign com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_well_known_ports to this value to remain compatible with previous versions of the RTI Connext middleware that used fixed port mappings.

The following are the rtps_well_known_ports values for com.rti.dds.infrastructure.RtpsWellKnownPorts_t.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 com.rti.dds.infrastructure.RtpsWellKnownPorts_t.INTEROPERABLE_RTPS_WELL_KNOWN_PORTS.

See Also
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_well_known_ports
com.rti.dds.infrastructure.RtpsWellKnownPorts_t.INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
final RtpsWellKnownPorts_t INTEROPERABLE_RTPS_WELL_KNOWN_PORTS
static

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

Assign com.rti.dds.infrastructure.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 com.rti.dds.infrastructure.RtpsWellKnownPorts_t.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 middleware that used fixed port mappings. For backwards compability, please use com.rti.dds.infrastructure.RtpsWellKnownPorts_t.RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS.

See Also
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_well_known_ports
com.rti.dds.infrastructure.RtpsWellKnownPorts_t.RTI_BACKWARDS_COMPATIBLE_RTPS_WELL_KNOWN_PORTS
final WireProtocolQosPolicyAutoKind RTPS_AUTO_ID_FROM_IP = new WireProtocolQosPolicyAutoKind("RTPS_AUTO_ID_FROM_IP", 0)
static

Kind of auto mechanism used to calculate the GUID prefix.

See Also
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_auto_id_kind.RTPS_AUTO_ID_FROM_IP
final WireProtocolQosPolicyAutoKind RTPS_AUTO_ID_FROM_MAC = new WireProtocolQosPolicyAutoKind("RTPS_AUTO_ID_FROM_MAC", 1)
static

Kind of auto mechanism used to calculate the GUID prefix.

See Also
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps_auto_id_kind.RTPS_AUTO_ID_FROM_MAC

RTI Connext Java API Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc