UDPv4 Transport

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

Classes
struct	NDDS_Transport_UDPv4_Property_t
	Configurable IPv4/UDP Transport-Plugin properties. More...

Macros
#define	NDDS_TRANSPORT_UDPV4_ADDRESS_BIT_COUNT   (32)
	Default value of NDDS_Transport_Property_t::address_bit_count.
#define	NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT   NDDS_TRANSPORT_UDP_PROPERTIES_BITMAP_DEFAULT
	Default value of NDDS_Transport_Property_t::properties_bitmap.
#define	NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT   NDDS_TRANSPORT_UDP_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT
	Default value of NDDS_Transport_Property_t::gather_send_buffer_count_max.
#define	NDDS_TRANSPORT_UDPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT   NDDS_TRANSPORT_UDP_SOCKET_BUFFER_SIZE_OS_DEFAULT
	Used to specify that os default be used to specify socket buffer size.
#define	NDDS_TRANSPORT_UDPV4_SEND_SOCKET_BUFFER_SIZE_DEFAULT   NDDS_TRANSPORT_UDP_SEND_SOCKET_BUFFER_SIZE_DEFAULT
	Default value of NDDS_Transport_UDPv4_Property_t::send_socket_buffer_size.
#define	NDDS_TRANSPORT_UDPV4_RECV_SOCKET_BUFFER_SIZE_DEFAULT   NDDS_TRANSPORT_UDP_RECV_SOCKET_BUFFER_SIZE_DEFAULT
	Default value of NDDS_Transport_UDPv4_Property_t::recv_socket_buffer_size.
#define	NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX   (65507)
	Maximum value of NDDS_Transport_Property_t::message_size_max.
#define	NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT   NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX
	Maximum value of NDDS_Transport_Property_t::message_size_max.
#define	NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT   NDDS_TRANSPORT_UDP_MULTICAST_TTL_DEFAULT
	Default value of NDDS_Transport_UDPv4_Property_t::multicast_ttl.
#define	NDDS_TRANSPORT_UDPV4_BLOCKING_NEVER
	Value for UDPv4Transport_Property_t::send_blocking to specify non-blocking sockets.
#define	NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS
	[default] Value for UDPv4Transport_Property_t::send_blocking to specify blocking sockets.
#define	NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT   NDDS_TRANSPORT_UDP_BLOCKING_DEFAULT
	Default value for UDPv4Transport_Property_t::send_blocking to specify blocking sockets.
#define	NDDS_TRANSPORT_UDPV4_PROPERTY_DEFAULT
	Use this to initialize a NDDS_Transport_UDPv4_Property_t structure.
#define	NDDS_Transport_UDPv4_string_to_address_cEA   NDDS_Transport_UDP_string_to_address_cEA
	Realization of NDDS_Transport_String_To_Address_Fcn_cEA for IP transports.

Functions
NDDS_Transport_Plugin *	NDDS_Transport_UDPv4_new (const struct NDDS_Transport_UDPv4_Property_t *property_in)
	Create an instance of a UDPv4 Transport Plugin.

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 UDPv4Transport_Property_t::unicast_enabled and 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 (Transport_Property_t::allow_interfaces_list, Transport_Property_t::deny_interfaces_list, Transport_Property_t::allow_multicast_interfaces_list, Transport_Property_t::deny_multicast_interfaces_list).

RTI Connext can implicitly create this plugin and register with the dds::domain::DomainParticipant if this transport is specified in rti::core::policy::TransportBuiltin.

To specify the properties of the builtin UDPv4 transport that is implicitly registered, you can either:

• call Transport_Support::set_builtin_transport_property or
• specify the predefined property names in rti::core::policy::Property associated with the dds::domain::DomainParticipant. (see UDPv4 Transport Property Names in Property QoS Policy of Domain Participant). Builtin transport plugin properties specified in rti::core::policy::Property always overwrite the ones specified through Transport_Support::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 rti::core::policy::Property of a 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 Transport_Property_t::address_bit_count
dds.transport.UDPv4.builtin.parent.properties_bitmap	See Transport_Property_t::properties_bitmap
dds.transport.UDPv4.builtin.parent.gather_send_buffer_count_max	See Transport_Property_t::gather_send_buffer_count_max
dds.transport.UDPv4.builtin.parent.message_size_max	See Transport_Property_t::message_size_max
dds.transport.UDPv4.builtin.parent.allow_interfaces	See Transport_Property_t::allow_interfaces_list and 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 Transport_Property_t::deny_interfaces_list and 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 Transport_Property_t::allow_multicast_interfaces_list and 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 Transport_Property_t::deny_multicast_interfaces_list and 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 UDPv4Transport_Property_t::send_socket_buffer_size
dds.transport.UDPv4.builtin.recv_socket_buffer_size	See UDPv4Transport_Property_t::recv_socket_buffer_size
dds.transport.UDPv4.builtin.unicast_enabled	See UDPv4Transport_Property_t::unicast_enabled
dds.transport.UDPv4.builtin.multicast_enabled	See UDPv4Transport_Property_t::multicast_enabled
dds.transport.UDPv4.builtin.multicast_ttl	See UDPv4Transport_Property_t::multicast_ttl
dds.transport.UDPv4.builtin.multicast_loopback_disabled	See UDPv4Transport_Property_t::multicast_loopback_disabled
dds.transport.UDPv4.builtin.ignore_loopback_interface	See UDPv4Transport_Property_t::ignore_loopback_interface
dds.transport.UDPv4.builtin.ignore_nonrunning_interfaces	See UDPv4Transport_Property_t::ignore_nonrunning_interfaces
dds.transport.UDPv4.builtin.ignore_nonup_interfaces	[DEPRECATED] See UDPv4Transport_Property_t::ignore_nonup_interfaces
dds.transport.UDPv4.builtin.no_zero_copy	[DEPRECATED] See UDPv4Transport_Property_t::no_zero_copy
dds.transport.UDPv4.builtin.send_blocking	See UDPv4Transport_Property_t::send_blocking
dds.transport.UDPv4.builtin.transport_priority_mask	See UDPv4Transport_Property_t::transport_priority_mask
dds.transport.UDPv4.builtin.transport_priority_mapping_low	See UDPv4Transport_Property_t::transport_priority_mapping_low
dds.transport.UDPv4.builtin.transport_priority_mapping_high	See UDPv4Transport_Property_t::transport_priority_mapping_high
dds.transport.UDPv4.builtin.send_ping	See UDPv4Transport_Property_t::send_ping
dds.transport.UDPv4.builtin.force_interface_poll_detection	See UDPv4Transport_Property_t::force_interface_poll_detection
dds.transport.UDPv4.builtin.interface_poll_period	See UDPv4Transport_Property_t::interface_poll_period
dds.transport.UDPv4.builtin.reuse_multicast_receive_resource	See UDPv4Transport_Property_t::reuse_multicast_receive_resource
dds.transport.UDPv4.builtin.protocol_overhead_max	See UDPv4Transport_Property_t::protocol_overhead_max
dds.transport.UDPv4.builtin.disable_interface_tracking	See UDPv4Transport_Property_t::disable_interface_tracking
dds.transport.UDPv4.builtin.public_address	See UDPv4Transport_Property_t::public_address
dds.transport.UDPv4.builtin.join_multicast_group_timeout	See UDPv4Transport_Property_t::join_multicast_group_timeout

See Also

Transport_Support::set_builtin_transport_property()

Macro Definition Documentation

#define NDDS_TRANSPORT_UDPV4_ADDRESS_BIT_COUNT   (32)

Default value of NDDS_Transport_Property_t::address_bit_count.

#define NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT   NDDS_TRANSPORT_UDP_PROPERTIES_BITMAP_DEFAULT

Default value of NDDS_Transport_Property_t::properties_bitmap.

#define NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT   NDDS_TRANSPORT_UDP_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT

Default value of NDDS_Transport_Property_t::gather_send_buffer_count_max.

This is also the maximum value that can be used when instantiating the udp transport.

16 is sufficient for RTI Connext, but more may improve discovery and reliable performance. Porting note: find out what the maximum gather buffer count is on your OS!

#define NDDS_TRANSPORT_UDPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT   NDDS_TRANSPORT_UDP_SOCKET_BUFFER_SIZE_OS_DEFAULT

Used to specify that os default be used to specify socket buffer size.

#define NDDS_TRANSPORT_UDPV4_SEND_SOCKET_BUFFER_SIZE_DEFAULT   NDDS_TRANSPORT_UDP_SEND_SOCKET_BUFFER_SIZE_DEFAULT

Default value of NDDS_Transport_UDPv4_Property_t::send_socket_buffer_size.

#define NDDS_TRANSPORT_UDPV4_RECV_SOCKET_BUFFER_SIZE_DEFAULT   NDDS_TRANSPORT_UDP_RECV_SOCKET_BUFFER_SIZE_DEFAULT

Default value of NDDS_Transport_UDPv4_Property_t::recv_socket_buffer_size.

#define NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX   (65507)

Maximum value of NDDS_Transport_Property_t::message_size_max.

#define NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT   NDDS_TRANSPORT_UDPV4_PAYLOAD_SIZE_MAX

Maximum value of NDDS_Transport_Property_t::message_size_max.

#define NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT   NDDS_TRANSPORT_UDP_MULTICAST_TTL_DEFAULT

Default value of NDDS_Transport_UDPv4_Property_t::multicast_ttl.

#define NDDS_TRANSPORT_UDPV4_BLOCKING_NEVER

Value for UDPv4Transport_Property_t::send_blocking to specify non-blocking sockets.

#define NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS

[default] Value for UDPv4Transport_Property_t::send_blocking to specify blocking sockets.

#define NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT   NDDS_TRANSPORT_UDP_BLOCKING_DEFAULT

Default value for UDPv4Transport_Property_t::send_blocking to specify blocking sockets.

#define NDDS_TRANSPORT_UDPV4_PROPERTY_DEFAULT

Use this to initialize a NDDS_Transport_UDPv4_Property_t structure.

#define NDDS_Transport_UDPv4_string_to_address_cEA   NDDS_Transport_UDP_string_to_address_cEA

Realization of NDDS_Transport_String_To_Address_Fcn_cEA for IP transports.

Converts a host name string to a IPv4 address.

Parameters

self	NOT USED. May be NULL.
address_out	<<out>> The corresponding numerical value in IPv4 format.
address_in	<<in>> The name of the IPv4 address. It can be a dot notation name or a host name. If NULL, then the IP address of the localhost will be returned.

See Also

NDDS_Transport_String_To_Address_Fcn_cEA for complete documentation.

Function Documentation

NDDS_Transport_Plugin* NDDS_Transport_UDPv4_new

(

const struct NDDS_Transport_UDPv4_Property_t *

property_in

)

Create an instance of a UDPv4 Transport Plugin.

An application may create and register multiple instances of this Transport Plugin with RTI Connext. This may be to partition the network interfaces across multiple RTI Connext domains. However, note that the underlying transport, the operating system's IP layer, is still a "singleton". For example, if a unicast transport has already bound to a port, and another unicast transport tries to bind to the same port, the second attempt will fail.

The transport plugin honors the interface/multicast "white" and "black" lists specified in the NDDS_Transport_UDP_Property_t::parent:

• NDDS_Transport_Property_t::allow_interfaces_list,
• NDDS_Transport_Property_t::deny_interfaces_list,
• NDDS_Transport_Property_t::allow_multicast_interfaces_list,
• NDDS_Transport_Property_t::deny_multicast_interfaces_list

The format of a string in these lists is assumed to be in standard IPv4 dot notation, possibly containing wildcards. For example:

• 10.10.30.232
• 10.10.*.*
• 192.168.1.*
• etc. Strings not in the correct format will be ignored.

Parameters

property_in

<<in>> Desired behavior of this transport. May be NULL for default property.

Returns

A UDPv4 Transport Plugin instance on success; or NULL on failure.