Transport plug-in using UDP/IPv4. More...
Classes | |
| class | Property_t |
| Configurable IPv4/UDP Transport-Plugin properties. More... | |
Detailed Description
Transport plug-in using UDP/IPv4.
This transport plugin uses UDPv4 sockets to send and receive messages. It supports both unicast and multicast communications in a single instance of the plugin. By default, this plugin will use all interfaces that it finds enabled and "UP" at instantiation time to send and receive messages. This transport is installed as a built-in transport plugin with the alias com.rti.dds.infrastructure.TransportBuiltinKind.UDPv4_ALIAS.
You can configure an instance of this plugin to only use unicast or only use multicast, see com.rti.ndds.transport.UDPv4Transport.Property_t.unicast_enabled and com.rti.ndds.transport.UDPv4Transport.Property_t.multicast_enabled.
In addition, you can configure an instance of this plugin to selectively use the network interfaces of a node (and restrict a plugin from sending multicast messages on specific interfaces) by specifying the com.rti.ndds.transport.Transport.Property_t.max_interface_count and the "white" and "black" lists in the base property's fields (com.rti.ndds.transport.Transport.Property_t.allow_interfaces_list, com.rti.ndds.transport.Transport.Property_t.deny_interfaces_list, com.rti.ndds.transport.Transport.Property_t.allow_multicast_interfaces_list, com.rti.ndds.transport.Transport.Property_t.deny_multicast_interfaces_list).
RTI Connext can implicitly create this plugin and register with the com.rti.dds.domain.DomainParticipant if this transport is specified in com.rti.dds.infrastructure.TransportBuiltinQosPolicy.
To specify the properties of the builtin UDPv4 transport that is implicitly registered, you can either:
- call com.rti.ndds.transport.TransportSupport.set_builtin_transport_property or
- specify the predefined property names in com.rti.dds.infrastructure.PropertyQosPolicy associated with the com.rti.dds.domain.DomainParticipant. (see UDPv4 Transport Property Names in Property QoS Policy of Domain Participant). Builtin transport plugin properties specified in com.rti.dds.infrastructure.PropertyQosPolicy always overwrite the ones specified through com.rti.ndds.transport.TransportSupport.set_builtin_transport_property(). The default value is assumed on any unspecified property.
Note that all properties should be set before the transport is implicitly created and registered by RTI Connext. Any properties set after the builtin transport is registered will be ignored. See Built-in Transport Plugins for details on when a builtin transport is registered.
UDPv4 Transport Property Names in Property QoS Policy of Domain Participant
The following table lists the predefined property names that can be set in the com.rti.dds.domain.DomainParticipantQos.property to configure the builtin UDPv4 transport plugin.
| Property Name | Description |
|---|---|
| dds.transport.UDPv4.builtin.parent.classid | See com.rti.ndds.transport.Transport.Property_t.classid |
| dds.transport.UDPv4.builtin.parent.address_bit_count | See com.rti.ndds.transport.Transport.Property_t.address_bit_count |
| dds.transport.UDPv4.builtin.parent.properties_bitmap | See com.rti.ndds.transport.Transport.Property_t.properties_bitmap |
| dds.transport.UDPv4.builtin.parent.gather_send_buffer_count_max | See com.rti.ndds.transport.Transport.Property_t.gather_send_buffer_count_max |
| dds.transport.UDPv4.builtin.parent.message_size_max | See com.rti.ndds.transport.Transport.Property_t.message_size_max |
| dds.transport.UDPv4.builtin.parent.allow_interfaces | See com.rti.ndds.transport.Transport.Property_t.allow_interfaces_list and com.rti.ndds.transport.Transport.Property_t.allow_interfaces_list_length. Interfaces should be specified as comma-separated strings, with each comma delimiting an interface. For example, 127.0.0.1,eth0 |
| dds.transport.UDPv4.builtin.parent.deny_interfaces | See com.rti.ndds.transport.Transport.Property_t.deny_interfaces_list and com.rti.ndds.transport.Transport.Property_t.deny_interfaces_list_length. Interfaces should be specified as comma-separated strings, with each comma delimiting an interface. For example: 127.0.0.1,eth0 |
| dds.transport.UDPv4.builtin.parent.allow_multicast_interfaces | See com.rti.ndds.transport.Transport.Property_t.allow_multicast_interfaces_list and com.rti.ndds.transport.Transport.Property_t.allow_multicast_interfaces_list_length. Interfaces should be specified as comma-separated strings, with each comma delimiting an interface. For example: 127.0.0.1,eth0 |
| dds.transport.UDPv4.builtin.parent.deny_multicast_interfaces | See com.rti.ndds.transport.Transport.Property_t.deny_multicast_interfaces_list and com.rti.ndds.transport.Transport.Property_t.deny_multicast_interfaces_list_length. Interfaces should be specified as comma-separated strings, with each comma delimiting an interface. For example: 127.0.0.1,eth0 |
| dds.transport.UDPv4.builtin.parent.max_interface_count | See com.rti.ndds.transport.Transport.Property_t.max_interface_count |
| dds.transport.UDPv4.builtin.parent.thread_name_prefix | See com.rti.ndds.transport.Transport.Property_t.thread_name_prefix |
| dds.transport.UDPv4.builtin.send_socket_buffer_size | See com.rti.ndds.transport.UDPv4Transport.Property_t.send_socket_buffer_size |
| dds.transport.UDPv4.builtin.recv_socket_buffer_size | See com.rti.ndds.transport.UDPv4Transport.Property_t.recv_socket_buffer_size |
| dds.transport.UDPv4.builtin.unicast_enabled | See com.rti.ndds.transport.UDPv4Transport.Property_t.unicast_enabled |
| dds.transport.UDPv4.builtin.multicast_enabled | See com.rti.ndds.transport.UDPv4Transport.Property_t.multicast_enabled |
| dds.transport.UDPv4.builtin.multicast_ttl | See com.rti.ndds.transport.UDPv4Transport.Property_t.multicast_ttl |
| dds.transport.UDPv4.builtin.multicast_loopback_disabled | See com.rti.ndds.transport.UDPv4Transport.Property_t.multicast_loopback_disabled |
| dds.transport.UDPv4.builtin.ignore_loopback_interface | See com.rti.ndds.transport.UDPv4Transport.Property_t.ignore_loopback_interface |
| dds.transport.UDPv4.builtin.ignore_nonrunning_interfaces | See com.rti.ndds.transport.UDPv4Transport.Property_t.ignore_nonrunning_interfaces |
| dds.transport.UDPv4.builtin.ignore_nonup_interfaces | [DEPRECATED] See com.rti.ndds.transport.UDPv4Transport.Property_t.ignore_nonup_interfaces |
| dds.transport.UDPv4.builtin.no_zero_copy | [DEPRECATED] See com.rti.ndds.transport.UDPv4Transport.Property_t.no_zero_copy |
| dds.transport.UDPv4.builtin.send_blocking | See com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking |
| dds.transport.UDPv4.builtin.transport_priority_mask | See com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mask |
| dds.transport.UDPv4.builtin.transport_priority_mapping_low | See com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mapping_low |
| dds.transport.UDPv4.builtin.transport_priority_mapping_high | See com.rti.ndds.transport.UDPv4Transport.Property_t.transport_priority_mapping_high |
| dds.transport.UDPv4.builtin.send_ping | See com.rti.ndds.transport.UDPv4Transport.Property_t.send_ping |
| dds.transport.UDPv4.builtin.force_interface_poll_detection | See com.rti.ndds.transport.UDPv4Transport.Property_t.force_interface_poll_detection |
| dds.transport.UDPv4.builtin.interface_poll_period | See com.rti.ndds.transport.UDPv4Transport.Property_t.interface_poll_period |
| dds.transport.UDPv4.builtin.reuse_multicast_receive_resource | See com.rti.ndds.transport.UDPv4Transport.Property_t.reuse_multicast_receive_resource |
| dds.transport.UDPv4.builtin.protocol_overhead_max | See com.rti.ndds.transport.UDPv4Transport.Property_t.protocol_overhead_max |
| dds.transport.UDPv4.builtin.disable_interface_tracking | See com.rti.ndds.transport.UDPv4Transport.Property_t.disable_interface_tracking |
| dds.transport.UDPv4.builtin.public_address | See com.rti.ndds.transport.UDPv4Transport.Property_t.public_address |
| dds.transport.UDPv4.builtin.join_multicast_group_timeout | See com.rti.ndds.transport.UDPv4Transport.Property_t.join_multicast_group_timeout |
| dds.transport.UDPv4.builtin.port_offset | See com.rti.ndds.transport.UDPv4Transport.Property_t.port_offset |
Member Data Documentation
◆ CLASSID
|
static |
The UDPv4 Transport class id
Referenced by UDPv4Transport.Property_t.Property_t().
◆ BLOCKING_NEVER
|
static |
Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify non-blocking sockets.
◆ BLOCKING_ALWAYS
|
static |
[default] Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify blocking sockets.
Referenced by UDPv4Transport.Property_t.Property_t().
◆ UDPV4_PAYLOAD_SIZE_MAX
|
static |
Maximum value for com.rti.ndds.transport.Transport.Property_t.message_size_max for the UDPv4 transport.
◆ MESSAGE_SIZE_MAX_DEFAULT
|
static |
Default value for com.rti.ndds.transport.Transport.Property_t.message_size_max.
Referenced by UDPv4Transport.Property_t.Property_t().
◆ SOCKET_BUFFER_SIZE_OS_MAX
|
static |
OS maximum to be used to specify the socket buffer size.
This property, if set, uses the maximum allowable size set in your OS for send and receive socket buffer sizes. If you update the maximum allowable size in your OS setting, then RTI Connext will automatically pick up that change. This property is not supported on all platforms because not all platforms have maximum values for the size of the send and receive buffers for sockets. See the Platform Notes to determine if this property is supported on your platform.
◆ SOCKET_BUFFER_SIZE_OS_DEFAULT
|
static |
OS default to be used to specify the socket buffer size.
◆ SEND_SOCKET_BUFFER_SIZE_DEFAULT
|
static |
Default value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_socket_buffer_size and com.rti.ndds.transport.UDPv4WanTransport.Property_t.send_socket_buffer_size.
The default value is 2097152 bytes (1048576 bytes on AIX platforms).
Referenced by UDPv4Transport.Property_t.Property_t().
◆ RECV_SOCKET_BUFFER_SIZE_DEFAULT
|
static |
Default value for com.rti.ndds.transport.UDPv4Transport.Property_t.recv_socket_buffer_size and com.rti.ndds.transport.UDPv4WanTransport.Property_t.recv_socket_buffer_size.
The default value is 2097152 bytes (1048576 bytes on AIX platforms).
Referenced by UDPv4Transport.Property_t.Property_t().