UDPv4Transport Interface Reference

Built-in transport plug-in using UDP/IPv4. More...

Inheritance diagram for UDPv4Transport:

Classes
class	Property_t
	Configurable IPv4/UDP Transport-Plugin properties. More...

Static Public Attributes
static final int	BLOCKING_NEVER
	Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify non-blocking sockets.
static final int	BLOCKING_ALWAYS
	[default] Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify blocking sockets.

Detailed Description

Built-in 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.

The user 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, the user 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 "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 com.rti.dds.infrastructure.PropertyQosPolicy of a com.rti.dds.domain.DomainParticipant to configure the builtin UDPv4 transport plugin.

Property Names for UDPv4 Transport Plugin

Property Name	Description
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.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.no_zero_copy	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.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

See Also

com.rti.ndds.transport.TransportSupport.set_builtin_transport_property()

Member Data Documentation

final int BLOCKING_NEVER

static

Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify non-blocking sockets.

final int BLOCKING_ALWAYS

static

[default] Value for com.rti.ndds.transport.UDPv4Transport.Property_t.send_blocking to specify blocking sockets.