|
RTI Connext C API Version 7.3.0
|
Configurable IPv4/UDP WAN Transport-Plugin properties. More...
Data Fields | |
| struct NDDS_Transport_Property_t | parent |
| Generic properties of all transport plugins. More... | |
| RTI_INT32 | send_socket_buffer_size |
| Size in bytes of the send buffer of a socket used for sending. More... | |
| RTI_INT32 | recv_socket_buffer_size |
| Size in bytes of the receive buffer of a socket used for receiving. More... | |
| RTI_INT32 | ignore_loopback_interface |
| Prevents the transport plugin from using the IP loopback interface. More... | |
| RTI_INT32 | ignore_nonup_interfaces |
| [DEPRECATED] Prevents the transport plugin from using a network interface that is not reported as UP by the operating system. More... | |
| RTI_INT32 | ignore_nonrunning_interfaces |
| Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. More... | |
| RTI_INT32 | no_zero_copy |
| [DEPRECATED] Prevents the transport plugin from doing a zero copy. More... | |
| RTI_INT32 | send_blocking |
| Control blocking behavior of send sockets. CHANGING THIS FROM THE DEFAULT CAN CAUSE SIGNIFICANT PERFORMANCE PROBLEMS. More... | |
| RTI_INT32 | use_checksum |
| Configures whether to send UDP checksum. More... | |
| RTI_UINT32 | transport_priority_mask |
| Set mask for use of transport priority field. More... | |
| RTI_INT32 | transport_priority_mapping_low |
| Set low value of output range to IPv4 TOS. More... | |
| RTI_INT32 | transport_priority_mapping_high |
| Set high value of output range to IPv4 TOS. More... | |
| RTI_INT32 | send_ping |
| Configures whether to send PING messages. More... | |
| RTI_INT32 | force_interface_poll_detection |
| Forces the interface tracker to use a polling mechanism to detect changes on the UDPv4 interfaces. More... | |
| RTI_UINT32 | interface_poll_period |
| Specifies the period in milliseconds to query for changes in the state of all the interfaces. More... | |
| RTI_INT32 | protocol_overhead_max |
| Maximum size in bytes of protocol overhead, including headers. More... | |
| RTI_INT32 | disable_interface_tracking |
| Disables detection of network interface changes. More... | |
| char * | public_address |
| Public IP address associated with the transport instantiation. More... | |
| struct NDDS_Transport_UDP_WAN_CommPortsMappingInfo * | comm_ports_list |
| Configures the public and private UDP ports that a transport instance uses to receive/send RTPS data. More... | |
| RTI_INT32 | comm_ports_list_length |
Number of elements in the NDDS_Transport_UDPv4_WAN_Property_t::comm_ports_list. More... | |
| RTI_INT32 | port_offset |
| Port offset to allow coexistence with built-in UDPv4 transport. More... | |
| RTI_UINT32 | binding_ping_period |
| Specifies the period in milliseconds at which BINDING PINGS messages are sent to keep NAT mappings open. More... | |
Configurable IPv4/UDP WAN Transport-Plugin properties.
You can modify the properties in this structure to configure the plugin. However, you must set the properties before the plugin is instantiated.
| struct NDDS_Transport_Property_t NDDS_Transport_UDPv4_WAN_Property_t::parent |
Generic properties of all transport plugins.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::send_socket_buffer_size |
Size in bytes of the send buffer of a socket used for sending.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::recv_socket_buffer_size |
Size in bytes of the receive buffer of a socket used for receiving.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::ignore_loopback_interface |
Prevents the transport plugin from using the IP loopback interface.
Currently three values are allowed:
The current "automatic" (-1) RTI Connext policy is as follows:
[default] -1 Automatic RTI Connext policy based on availability of the shared memory transport.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::ignore_nonup_interfaces |
[DEPRECATED] Prevents the transport plugin from using a network interface that is not reported as UP by the operating system.
DEPRECATED: this property has no effect. Non-UP interfaces are ignored until they change their status to UP, unless NDDS_Transport_UDPv4_WAN_Property_t::disable_interface_tracking is set to 1, in which case interfaces are ignored even if they change their status at a later point.
The transport checks the flags reported by the operating system for each network interface upon initialization. An interface that is not reported as UP will not be used. This property allows you to configure the transport to start using even the interfaces that were not reported as UP.
Two values are allowed:
[default] 1
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::ignore_nonrunning_interfaces |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system.
The transport checks the flags reported by the operating system for each network interface upon initialization. An interface that is not reported as UP will not be used. This property allows the same check to be extended to the IFF_RUNNING flag implemented by some operating systems. The RUNNING flag is defined to mean that "all resources are allocated," and may be off if there is no link detected, e.g., the network cable is unplugged.
Two values are allowed:
[default] 1 (i.e., check RUNNING flag)
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::no_zero_copy |
[DEPRECATED] Prevents the transport plugin from doing a zero copy.
DEPRECATED: This property has no effect. By default, this plugin will use the zero copy on OSes that offer it. While this is good for performance, it may sometimes tax the OS resources in a manner that cannot be overcome by the application.
The best example is if the hardware/device driver lends the buffer to the application itself. If the application does not return the loaned buffers soon enough, the node may err or malfunction. In case you cannot reconfigure the H/W, device driver, or the OS to allow the zero copy feature to work for your application, you may have no choice but to turn off zero copy use.
By default this is set to 0, so RTI Connext will use the zero-copy API if offered by the OS.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::send_blocking |
Control blocking behavior of send sockets. CHANGING THIS FROM THE DEFAULT CAN CAUSE SIGNIFICANT PERFORMANCE PROBLEMS.
Currently two values are defined:
[default] NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::use_checksum |
Configures whether to send UDP checksum.
This property specifies whether the UDP checksum will be computed. On Windows and Linux, the UDP protocol will not set the checksum when use_checksum is set to 0. This is useful when RTPS protocol statistics related to corrupted messages need to be collected through the API DDS_DomainParticipant_get_participant_protocol_status.
[default] 1 (enabled)
| RTI_UINT32 NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mask |
Set mask for use of transport priority field.
This is used in conjunction with NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_low and NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_high to define the mapping from the DDS transport priority (see TRANSPORT_PRIORITY) to the IPv4 TOS field. Defines a contiguous region of bits in the 32-bit transport priority value that is used to generate values for the IPv4 TOS field on an outgoing socket.
For example, the value 0x0000ff00 causes bits 9-16 (8 bits) to be used in the mapping. The value will be scaled from the mask range (0x0000 - 0xff00 in this case) to the range specified by low and high.
If the mask is set to zero, then the transport will not set IPv4 TOS for send sockets.
[default] 0.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_low |
Set low value of output range to IPv4 TOS.
This is used in conjunction with NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mask and NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_high to define the mapping from the DDS transport priority to the IPv4 TOS field. Defines the low value of the output range for scaling.
Note that IPv4 TOS is generally an 8-bit value.
[default] 0.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_high |
Set high value of output range to IPv4 TOS.
This is used in conjunction with NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mask and NDDS_Transport_UDPv4_WAN_Property_t::transport_priority_mapping_low to define the mapping from the DDS transport priority to the IPv4 TOS field. Defines the high value of the output range for scaling.
Note that IPv4 TOS is generally an 8-bit value.
[default] 0xff.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::send_ping |
Configures whether to send PING messages.
This property specifies whether to send a PING message before commencing the discovery process. On certain operating systems or with certain switches the initial UDP packet, while configuring the ARP table, can unfortunately be dropped. To avoid dropping the initial RTPS discovery sample, a PING message is sent to preconfigure the ARP table in those environments.
[default] 1 (enabled)
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::force_interface_poll_detection |
Forces the interface tracker to use a polling mechanism to detect changes on the UDPv4 interfaces.
When possible, the detection of an IP address change is done asynchronously using the APIs offered by the underlying OS. By setting this property on those OSes, the use of a polling mechanism to detect changes can be forced.
[default] 0 (disabled).
| RTI_UINT32 NDDS_Transport_UDPv4_WAN_Property_t::interface_poll_period |
Specifies the period in milliseconds to query for changes in the state of all the interfaces.
When possible, the detection of an IP address change is done asynchronously using the APIs offered by the underlying OS. If there is no mechanism to do that, the detection will use a polling strategy where the polling period can be configured by setting this property.
[default] 500 milliseconds.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::protocol_overhead_max |
Maximum size in bytes of protocol overhead, including headers.
This value is the maximum size, in bytes, of protocol-related overhead. Normally, the overhead accounts for UDP and IP headers. The default value is set to accommodate the most common UDP/IP header size.
Note that when NDDS_Transport_Property_t::message_size_max plus this overhead is larger than the UDPv4 maximum message size (65535 bytes), the middleware will automatically reduce the effective message_size_max, to 65535 minus this overhead.
[default] 28.
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::disable_interface_tracking |
Disables detection of network interface changes.
By default, network interface changes are propagated in the form of locators to other applications. This is done to support IP mobility scenarios.
For example, you could start a RTI Connext application with Wi-Fi and move to a wired connection. In order to continue communicating with other applications, this interface change has to be propagated.
In RTI Connext 5.2 (the initial release) and earlier versions of the product, IP mobility scenarios were not supported. 5.2 applications will report errors if they detect locator changes in a DataWriter or DataReader.
You can disable the notification and propagation of interface changes by setting this property to 1.
This way, an interface change in a newer application will not trigger errors in an application running 5.2 or earlier. Of course, this will prevent the new application from being able to detect network interface changes.
[default] 0
| char* NDDS_Transport_UDPv4_WAN_Property_t::public_address |
Public IP address associated with the transport instantiation.
Setting the public IP address is only necessary for the Real-Time WAN Transport associated with an external DDS_DomainParticipant (publicly reachable) in order to support the two communication scenarios shown in the Figure below.
For an external DDS_DomainParticipant behind a NAT-enabled router, this address is the public IP address of the router.
When this property is set, the DomainParticipant will announce PUBLIC+UUID locators to other DomainParticipants. These locators are reachable locators because they contain this public IP address.
For additional information on Real-Time WAN Transport locators, see the Core Libraries User's Manual.
with a Participant that has a Public Address"
[default] NULL (the transport will announce UUID locators)
| struct NDDS_Transport_UDP_WAN_CommPortsMappingInfo* NDDS_Transport_UDPv4_WAN_Property_t::comm_ports_list |
Configures the public and private UDP ports that a transport instance uses to receive/send RTPS data.
Array containing the mapping between "RTPS ports", "UDP receive host ports", and "UDP receive public ports".
When the transport is configured using properties, the port mapping array is provided using a JSON string.
For example:
It is also possible to configure the mapping with XML:
For additional information on how to set the value of this property, see the Core Libraries User's Manual.
[default] NULL (The UDP ports used for communications will be derived from the RTPS ports associated with the locators for the DomainParticipant and its Endpoints (DataWriters and DataReaders)).
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::comm_ports_list_length |
Number of elements in the NDDS_Transport_UDPv4_WAN_Property_t::comm_ports_list.
[default] 0
| RTI_INT32 NDDS_Transport_UDPv4_WAN_Property_t::port_offset |
Port offset to allow coexistence with built-in UDPv4 transport.
This property allows using the built-in UDPv4 transport and the Real-Time WAN Transport at the same time.
When the UDP ports used by Real-Time WAN Transport are not explicitly set, they are calculated as follows: RTPS port + port_offset.
[default] 125
| RTI_UINT32 NDDS_Transport_UDPv4_WAN_Property_t::binding_ping_period |
Specifies the period in milliseconds at which BINDING PINGS messages are sent to keep NAT mappings open.
Configures the period in milliseconds at which BINDING_PING messages are sent by a local transport instance to a remote transport instance. For example, 1000 means to send BINDING_PING messages every second.
BINDING_PING messages are used on the sending side to open NAT bindings from a local transport instance to a remote transport instance and they are sent periodically to keep the bindings open.
On the receiving side, BINDING_PINGS are used to calculate the public IP transport address of an UUID locator. This address will be used to send data to the locator.
For additional information on the role of BINDING_PING, see the Core Libraries User's Manual.
From a configuration point of view, and to avoid communication disruptions, the period at which a transport instance sends BINDING_PING messages should be smaller than the NAT binding session timeout. This timeout depends on the NAT router configuration.
[default] 1000 (1 sec)