RTI Connext Java API Version 7.1.0
|
Configurable IPv4/UDP Transport-Plugin properties. More...
Public Member Functions | |
Property_t () | |
Public Attributes | |
int | send_socket_buffer_size |
Size in bytes of the send buffer of a socket used for sending. More... | |
int | recv_socket_buffer_size |
Size in bytes of the receive buffer of a socket used for receiving. More... | |
int | unicast_enabled |
Allows the transport plugin to use unicast for sending and receiving. More... | |
int | multicast_enabled |
Allows the transport plugin to use multicast for sending and receiving. More... | |
int | multicast_ttl |
Value for the time-to-live parameter for all multicast sends using this plugin. More... | |
int | multicast_loopback_disabled |
Prevents the transport plugin from putting multicast packets onto the loopback interface. More... | |
int | ignore_loopback_interface |
Prevents the transport plugin from using the IP loopback interface. More... | |
int | ignore_nonup_interfaces |
[DEPRECATED] Prevents the transport plugin from using a network interface that is not reported as UP by the operating system. More... | |
int | ignore_nonrunning_interfaces |
Prevents the transport plugin from using a network interface that is not reported as RUNNING by the operating system. More... | |
int | no_zero_copy |
[DEPRECATED] Prevents the transport plugin from doing a zero copy. More... | |
int | send_blocking |
Control blocking behavior of send sockets. CHANGING THIS FROM THE DEFAULT CAN CAUSE SIGNIFICANT PERFORMANCE PROBLEMS. More... | |
int | use_checksum |
Configures whether to send UDP checksum. More... | |
long | transport_priority_mask |
Set mask for use of transport priority field. More... | |
int | transport_priority_mapping_low |
Set low value of output range to IPv4 TOS. More... | |
int | transport_priority_mapping_high |
Set high value of output range to IPv4 TOS. More... | |
int | send_ping |
Configures whether to send PING messages. More... | |
int | force_interface_poll_detection |
Forces the interface tracker to use a polling mechanism to detect changes on the UDPv4 interfaces. More... | |
long | interface_poll_period |
Specifies the period in milliseconds to query for changes in the state of all the interfaces. More... | |
int | reuse_multicast_receive_resource |
Controls whether or not to reuse multicast receive resources. More... | |
int | protocol_overhead_max |
Maximum size in bytes of protocol overhead, including headers. More... | |
int | disable_interface_tracking |
Disables detection of network interface changes. More... | |
long | join_multicast_group_timeout |
[Windows only] Defines how much time (milliseconds) to wait to join a multicast group address when a new interface is detected. More... | |
String | public_address |
Public IP address associated with the transport instantiation. More... | |
![]() | |
final int | classid |
The Transport-Plugin Class ID. More... | |
final int | address_bit_count |
Number of bits in a 16-byte address that are used by the transport. Should be between 0 and 128. More... | |
final int | properties_bitmap |
A bitmap that defines various properties of the transport to the RTI Connext core. More... | |
int | gather_send_buffer_count_max |
Specifies the maximum number of buffers that RTI Connext can pass to the send() method of a transport plugin. More... | |
int | message_size_max |
The maximum size of an RTPS message in bytes that can be sent or received by the transport plugin. More... | |
final StringSeq | allow_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_interfaces_list_length > 0), allow the use of only these interfaces. If the list is empty, allow the use of all interfaces. More... | |
final StringSeq | deny_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_interfaces_list_length > 0), deny the use of these interfaces. More... | |
final StringSeq | allow_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_multicast_interfaces_list_length > 0), allow the use of multicast only on these interfaces; otherwise allow the use of all the allowed interfaces. More... | |
final StringSeq | deny_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_multicast_interfaces_list_length > 0), deny the use of those interfaces for multicast. More... | |
byte[] | transport_uuid = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} |
Univocally identifies a transport plugin. More... | |
int | max_interface_count |
Maximum number of addresses from the allow_interfaces_list that will be announced. More... | |
Additional Inherited Members | |
![]() | |
static final int | NDDS_TRANSPORT_CLASSID_INVALID = -1 |
Invalid Transport Class ID. More... | |
static final int | NDDS_TRANSPORT_CLASSID_RESERVED_RANGE = 1000 |
Transport-Plugin class IDs below this are reserved by RTI. More... | |
static final int | NDDS_TRANSPORT_PROPERTY_BIT_BUFFER_ALWAYS_LOANED = 0x2 |
Specified zero-copy behavior of transport. More... | |
static final int | NDDS_TRANSPORT_PROPERTY_GATHER_SEND_BUFFER_COUNT_MIN = 3 |
Minimum number of gather-send buffers that must be supported by a Transport Plugin implementation. More... | |
Configurable IPv4/UDP 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.
Property_t | ( | ) |
Create an empty UDPv4Transport property with default values
References UDPv4Transport.BLOCKING_ALWAYS, UDPv4Transport.CLASSID, UDPv4Transport.Property_t.disable_interface_tracking, UDPv4Transport.Property_t.force_interface_poll_detection, UDPv4Transport.Property_t.ignore_loopback_interface, UDPv4Transport.Property_t.ignore_nonrunning_interfaces, UDPv4Transport.Property_t.ignore_nonup_interfaces, UDPv4Transport.Property_t.interface_poll_period, UDPv4Transport.Property_t.join_multicast_group_timeout, UDPv4Transport.MESSAGE_SIZE_MAX_DEFAULT, UDPv4Transport.Property_t.multicast_enabled, UDPv4Transport.Property_t.multicast_loopback_disabled, UDPv4Transport.Property_t.multicast_ttl, UDPv4Transport.Property_t.no_zero_copy, UDPv4Transport.Property_t.protocol_overhead_max, UDPv4Transport.Property_t.public_address, UDPv4Transport.Property_t.recv_socket_buffer_size, UDPv4Transport.RECV_SOCKET_BUFFER_SIZE_DEFAULT, UDPv4Transport.Property_t.reuse_multicast_receive_resource, UDPv4Transport.Property_t.send_blocking, UDPv4Transport.Property_t.send_ping, UDPv4Transport.Property_t.send_socket_buffer_size, UDPv4Transport.SEND_SOCKET_BUFFER_SIZE_DEFAULT, UDPv4Transport.Property_t.transport_priority_mapping_high, UDPv4Transport.Property_t.transport_priority_mapping_low, UDPv4Transport.Property_t.transport_priority_mask, UDPv4Transport.Property_t.unicast_enabled, and UDPv4Transport.Property_t.use_checksum.
int send_socket_buffer_size |
Size in bytes of the send buffer of a socket used for sending.
On most operating systems, setsockopt()
will be called to set the SENDBUF to the value of this parameter.
This value must be greater than or equal to com.rti.ndds.transport.Transport.Property_t.message_size_max. The maximum value is operating system-dependent.
By default, it will be set to com.rti.ndds.transport.UDPv4Transport_SEND_SOCKET_BUFFER_SIZE_DEFAULT.
If you configure this parameter to be com.rti.ndds.transport.UDPv4Transport_SOCKET_BUFFER_SIZE_OS_DEFAULT, then setsockopt() (or equivalent) will not be called to size the send buffer of the socket. The transport will use the OS default.
Referenced by UDPv4Transport.Property_t.Property_t().
int recv_socket_buffer_size |
Size in bytes of the receive buffer of a socket used for receiving.
On most operating systems, setsockopt()
will be called to set the RECVBUF to the value of this parameter.
This value must be greater than or equal to com.rti.ndds.transport.Transport.Property_t.message_size_max. The maximum value is operating system-dependent.
By default, it will be set to com.rti.ndds.transport.UDPv4Transport_RECV_SOCKET_BUFFER_SIZE_DEFAULT.
If you configure this parameter to be com.rti.ndds.transport.UDPv4Transport_SOCKET_BUFFER_SIZE_OS_DEFAULT, then setsockopt() (or equivalent) will not be called to size the receive buffer of the socket. The transport will use the OS default.
Referenced by UDPv4Transport.Property_t.Property_t().
int unicast_enabled |
Allows the transport plugin to use unicast for sending and receiving.
This value turns unicast UDP on (if set to 1) or off (if set to 0) for this plugin. By default, it will be turned on (1). Also by default, the plugin will use all the allowed network interfaces that it finds up and running when the plugin is instantiated.
Referenced by UDPv4Transport.Property_t.Property_t().
int multicast_enabled |
Allows the transport plugin to use multicast for sending and receiving.
This value turns multicast UDP on (if set to 1) or off (if set to 0) for this plugin. By default, it will be turned on (1) for those platforms that support multicast. Also by default, the plugin will use all the network interfaces allowed for multicast that it finds up and running when the plugin is instantiated.
Referenced by UDPv4Transport.Property_t.Property_t().
int multicast_ttl |
Value for the time-to-live parameter for all multicast sends using this plugin.
This value is used to set the TTL of multicast packets sent by this transport plugin.
[default] 1
Referenced by UDPv4Transport.Property_t.Property_t().
int multicast_loopback_disabled |
Prevents the transport plugin from putting multicast packets onto the loopback interface.
If multicast loopback is disabled (this value is set to 1), then when sending multicast packets, RTI Connext will not put a copy of the packets on the loopback interface. This prevents applications on the same node (including itself) from receiving those packets.
This value is set to 0 by default, meaning multicast loopback is enabled.
Disabling multicast loopback (setting this value to 1) may result in minor performance gains when using multicast.
[NOTE: Windows CE systems do not support multicast loopback. This field is ignored for Windows CE targets.]
Referenced by UDPv4Transport.Property_t.Property_t().
int 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.
Referenced by UDPv4Transport.Property_t.Property_t().
int 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 com.rti.ndds.transport.UDPv4Transport.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
Referenced by UDPv4Transport.Property_t.Property_t().
int 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)
Referenced by UDPv4Transport.Property_t.Property_t().
int 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.
Referenced by UDPv4Transport.Property_t.Property_t().
int 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
Referenced by UDPv4Transport.Property_t.Property_t().
int 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 com.rti.dds.domain.DomainParticipant.get_participant_protocol_status.
[default] 1 (enabled)
Referenced by UDPv4Transport.Property_t.Property_t().
long transport_priority_mask |
Set mask for use of transport priority field.
This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mapping_low and com.rti.ndds.transport.UDPv4Transport.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.
Referenced by UDPv4Transport.Property_t.Property_t().
int transport_priority_mapping_low |
Set low value of output range to IPv4 TOS.
This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mask and com.rti.ndds.transport.UDPv4Transport.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.
Referenced by UDPv4Transport.Property_t.Property_t().
int transport_priority_mapping_high |
Set high value of output range to IPv4 TOS.
This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mask and com.rti.ndds.transport.UDPv4Transport.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.
Referenced by UDPv4Transport.Property_t.Property_t().
int 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)
Referenced by UDPv4Transport.Property_t.Property_t().
int 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).
Referenced by UDPv4Transport.Property_t.Property_t().
long 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.
Referenced by UDPv4Transport.Property_t.Property_t().
int reuse_multicast_receive_resource |
Controls whether or not to reuse multicast receive resources.
Setting this to 0 (FALSE) prevents multicast crosstalk by uniquely configuring a port and creating a receive thread for each multicast group address.
[default] 1.
Referenced by UDPv4Transport.Property_t.Property_t().
int 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 com.rti.ndds.transport.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.
Referenced by UDPv4Transport.Property_t.Property_t().
int 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
Referenced by UDPv4Transport.Property_t.Property_t().
long join_multicast_group_timeout |
[Windows only] Defines how much time (milliseconds) to wait to join a multicast group address when a new interface is detected.
On Windows, a network interface may be detected before it is allowed to join a multicast group address. This property adjusts how much time (milliseconds) to wait for the ADD_MEMBERSHIP multicast operation to succeed before withdrawing.
[default] 5000
Referenced by UDPv4Transport.Property_t.Property_t().
String public_address |
Public IP address associated with the transport instantiation.
Setting the public IP address is only necessary to support communication over WAN that involves Network Address Translation (NAT).
Typically, the address is the public address of the IP NAT router that provides access to the WAN.
By default, the com.rti.dds.domain.DomainParticipant creating the transport will announce the IP addresses obtained from the NICs to other DomainParticipants in the system.
When this property is set, the DomainParticipant will announce the IP address corresponding to the property value instead of the LAN IP addresses associated with the NICs.
Note 1: Setting this property is necessary, but is not a sufficient condition for sending and receiving data over the WAN. You must also configure the IP NAT router to allow UDP traffic and to map the public IP address specified by this property to the DomainParticipant's private LAN IP address. This is typically done with one of the following mechanisms:
Port Forwarding: You must map the private ports used to receive discovery and user data traffic to the corresponding public ports (see com.rti.dds.infrastructure.RtpsWellKnownPorts_t). Public and private ports must be the same since the transport does not allow you to change the mapping.
Note 2: By setting this property, the com.rti.dds.domain.DomainParticipant only announces its public IP address to other DomainParticipants. Therefore, communication with DomainParticipants within the LAN that are running on different nodes will not work unless the NAT router is configured to enable NAT reflection (hairpin NAT).
There is another way to achieve simultaneous communication with DomainParticipants running in the LAN and WAN, that does not require hairpin NAT. This way uses a gateway application such as RTI Routing Service to provide access to the WAN.
[default] null (the transport uses the IP addresses obtained from the NICs)
Referenced by UDPv4Transport.Property_t.Property_t().