Classes | |
| struct | NDDS_Transport_UDPv4_Property_t |
| Configurable IPv4/UDP Transport-Plugin properties. More... | |
Defines | |
| #define | NDDS_TRANSPORT_CLASSID_UDPv4 (1) |
| Builtin IPv4 UDP/IP Transport-Plugin class ID. | |
| #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 (0) |
| Default value of NDDS_Transport_Property_t::properties_bitmap. | |
| #define | NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT (16) |
| Default value of NDDS_Transport_Property_t::gather_send_buffer_count_max. | |
| #define | NDDS_TRANSPORT_UDPV4_SOCKET_BUFFER_SIZE_OS_DEFAULT (-1) |
| Used to specify that os default be used to specify socket buffer size. | |
| #define | NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT (9216) |
| Default value of NDDS_Transport_Property_t::message_size_max. | |
| #define | NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT (1) |
| Default value of NDDS_Transport_UDPv4_Property_t::multicast_ttl. | |
| #define | NDDS_TRANSPORT_UDPV4_BLOCKING_NEVER |
| Value for NDDS_Transport_UDPv4_Property_t::send_blocking to specify non-blocking sockets. | |
| #define | NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS |
| [default] Value for NDDS_Transport_UDPv4_Property_t::send_blocking to specify blocking sockets. | |
| #define | NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS |
| Default value for NDDS_Transport_UDPv4_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. | |
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. | |
| RTI_INT32 | NDDS_Transport_UDPv4_string_to_address_cEA (NDDS_Transport_Plugin *self, NDDS_Transport_Address_t *address_out, const char *address_in) |
| Realization of NDDS_Transport_String_To_Address_Fcn_cEA for IP transports. | |
| RTI_INT32 | NDDS_Transport_UDPv4_get_receive_interfaces_cEA (NDDS_Transport_Plugin *self, RTI_INT32 *found_more_than_provided_for_out, RTI_INT32 *interface_reported_count_out, NDDS_Transport_Interface_t interface_array_inout[], RTI_INT32 interface_array_size_in) |
| Realization of NDDS_Transport_Get_Receive_Interfaces_Fcn_cEA for IP transports. | |
| NDDS_Transport_Plugin * | NDDS_Transport_UDPv4_create (NDDS_Transport_Address_t *default_network_address_out, const struct DDS_PropertyQosPolicy *property_in) |
| Create an instance of a UDPv4 Transport Plugin, using PropertyQosPolicy. | |
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 NDDS_Transport_UDPv4_Property_t::unicast_enabled and NDDS_Transport_UDPv4_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 (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).
RTI Data Distribution Service can implicitly create this plugin and register with the DDSDomainParticipant if this transport is specified in DDS_TransportBuiltinQosPolicy.
To specify the properties of the builtin UDPv4 transport that is implicitly registered, you can either:
Note that all properties should be set before the transport is implicitly created and registered by RTI Data Distribution Service. 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.
To explicitly create an instance of this plugin, NDDS_Transport_UDPv4_new() should be called. The instance should be registered with RTI Data Distribution Service, see NDDSTransportSupport::register_transport. In some configurations one may have to disable the builtin UDPv4 transport plugin instance (DDS_TransportBuiltinQosPolicy, DDS_TRANSPORTBUILTIN_UDPv4), to avoid port conflicts with the newly created plugin instance.
| Property Name | Description
|
|---|---|
| dds.transport.UDPv4.builtin.parent.address_bit_count | See NDDS_Transport_Property_t::address_bit_count |
| dds.transport.UDPv4.builtin.parent.properties_bitmap | See NDDS_Transport_Property_t::properties_bitmap |
| dds.transport.UDPv4.builtin.parent.gather_send_buffer_count_max | See NDDS_Transport_Property_t::gather_send_buffer_count_max |
| dds.transport.UDPv4.builtin.parent.message_size_max | See NDDS_Transport_Property_t::message_size_max |
| dds.transport.UDPv4.builtin.parent.allow_interfaces | See NDDS_Transport_Property_t::allow_interfaces_list and NDDS_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 NDDS_Transport_Property_t::deny_interfaces_list and NDDS_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 NDDS_Transport_Property_t::allow_multicast_interfaces_list and NDDS_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 NDDS_Transport_Property_t::deny_multicast_interfaces_list and NDDS_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 NDDS_Transport_UDPv4_Property_t::send_socket_buffer_size |
| dds.transport.UDPv4.builtin.recv_socket_buffer_size | See NDDS_Transport_UDPv4_Property_t::recv_socket_buffer_size |
| dds.transport.UDPv4.builtin.unicast_enabled | See NDDS_Transport_UDPv4_Property_t::unicast_enabled |
| dds.transport.UDPv4.builtin.multicast_enabled | See NDDS_Transport_UDPv4_Property_t::multicast_enabled |
| dds.transport.UDPv4.builtin.multicast_ttl | See NDDS_Transport_UDPv4_Property_t::multicast_ttl |
| dds.transport.UDPv4.builtin.multicast_loopback_disabled | See NDDS_Transport_UDPv4_Property_t::multicast_loopback_disabled |
| dds.transport.UDPv4.builtin.ignore_loopback_interface | See NDDS_Transport_UDPv4_Property_t::ignore_loopback_interface |
| dds.transport.UDPv4.builtin.ignore_nonrunning_interfaces | See NDDS_Transport_UDPv4_Property_t::ignore_nonrunning_interfaces |
| dds.transport.UDPv4.builtin.no_zero_copy | See NDDS_Transport_UDPv4_Property_t::no_zero_copy |
| dds.transport.UDPv4.builtin.send_blocking | See NDDS_Transport_UDPv4_Property_t::send_blocking |
| dds.transport.UDPv4.builtin.transport_priority_mask | See NDDS_Transport_UDPv4_Property_t::transport_priority_mask |
| dds.transport.UDPv4.builtin.transport_priority_mapping_low | See NDDS_Transport_UDPv4_Property_t::transport_priority_mapping_low |
| dds.transport.UDPv4.builtin.transport_priority_mapping_high | See NDDS_Transport_UDPv4_Property_t::transport_priority_mapping_high
|
| #define NDDS_TRANSPORT_CLASSID_UDPv4 (1) |
Builtin IPv4 UDP/IP Transport-Plugin class ID.
| #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 (0) |
Default value of NDDS_Transport_Property_t::properties_bitmap.
| #define NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT (16) |
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 Data Distribution Service, 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 (-1) |
Used to specify that os default be used to specify socket buffer size.
| #define NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT (9216) |
Default value of NDDS_Transport_Property_t::message_size_max.
| #define NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT (1) |
Default value of NDDS_Transport_UDPv4_Property_t::multicast_ttl.
| #define NDDS_TRANSPORT_UDPV4_BLOCKING_NEVER |
Value for NDDS_Transport_UDPv4_Property_t::send_blocking to specify non-blocking sockets.
| #define NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS |
[default] Value for NDDS_Transport_UDPv4_Property_t::send_blocking to specify blocking sockets.
| #define NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT NDDS_TRANSPORT_UDPV4_BLOCKING_ALWAYS |
Default value for NDDS_Transport_UDPv4_Property_t::send_blocking to specify blocking sockets.
| #define NDDS_TRANSPORT_UDPV4_PROPERTY_DEFAULT |
Value:
{ \
{ NDDS_TRANSPORT_CLASSID_UDPv4, \
NDDS_TRANSPORT_UDPV4_ADDRESS_BIT_COUNT, \
NDDS_TRANSPORT_UDPV4_PROPERTIES_BITMAP_DEFAULT, \
NDDS_TRANSPORT_UDPV4_GATHER_SEND_BUFFER_COUNT_MAX_DEFAULT, \
NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT, \
NULL, 0, /* allow_interfaces_list */ \
NULL, 0, /* deny_interfaces_list */ \
NULL, 0, /* allow_multicast_interfaces_list */ \
NULL, 0, /* deny_multicast_interfaces_list */ \
}, \
NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT, \
NDDS_TRANSPORT_UDPV4_MESSAGE_SIZE_MAX_DEFAULT, \
1, /* use unicast */ \
NDDS_TRANSPORT_UDPV4_USE_MULTICAST_DEFAULT, /* use multicast */ \
NDDS_TRANSPORT_UDPV4_MULTICAST_TTL_DEFAULT, \
0, /* multicast loopback enabled */ \
-1, /* (auto-)ignore loopback */ \
1, /* ignore_nonup_interfaces */ \
0, /* do not ignore non-RUNNING */ \
0, /* no_zero_copy */ \
NDDS_TRANSPORT_UDPV4_BLOCKING_DEFAULT, \
0, 0, 0xff /* no mapping to IP_TOS by default */, \
1, /* send_ping */ \
500 /* 500 millisecs is the default polling period*/, \
0 /* reuse multicast receive resource */ }
| 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 Data Distribution Service. This may be to partition the network interfaces across multiple RTI Data Distribution Service 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_UDPv4_Property_t::parent:
The format of a string in these lists is assumed to be in standard IPv4 dot notation, possibly containing wildcards. For example:
| property_in | <<in>> Desired behavior of this transport. May be NULL for default property. |
| RTI_INT32 NDDS_Transport_UDPv4_string_to_address_cEA | ( | NDDS_Transport_Plugin * | self, | |
| NDDS_Transport_Address_t * | address_out, | |||
| const char * | address_in | |||
| ) |
Realization of NDDS_Transport_String_To_Address_Fcn_cEA for IP transports.
Converts a host name string to a IPv4 address.
| self | NOT USED. May be NULL. | |
| address_out | <<out>> The corresponding numerical value in IPv6 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. |
| RTI_INT32 NDDS_Transport_UDPv4_get_receive_interfaces_cEA | ( | NDDS_Transport_Plugin * | self, | |
| RTI_INT32 * | found_more_than_provided_for_out, | |||
| RTI_INT32 * | interface_reported_count_out, | |||
| NDDS_Transport_Interface_t | interface_array_inout[], | |||
| RTI_INT32 | interface_array_size_in | |||
| ) |
Realization of NDDS_Transport_Get_Receive_Interfaces_Fcn_cEA for IP transports.
Retrieves a list of available IPv4 network interfaces. The addresses returned from IPv4 plugin will be of the pattern 0.0.0.0.0.0.0.0.0.0.0.0.x.x.x.x.
| NDDS_Transport_Plugin* NDDS_Transport_UDPv4_create | ( | NDDS_Transport_Address_t * | default_network_address_out, | |
| const struct DDS_PropertyQosPolicy * | property_in | |||
| ) |
Create an instance of a UDPv4 Transport Plugin, using PropertyQosPolicy.
An application may create and register multiple instances of this Transport Plugin with RTI Data Distribution Service. This may be to partition the network interfaces across multiple RTI Data Distribution Service 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_UDPv4_Property_t::parent:
The format of a string in these lists is assumed to be in standard IPv4 dot notation, possibly containing wildcards. For example:
| default_network_address_out | <<out>> Network address to be used when registering the transport. | |
| property_in | <<in>> Desired behavior of this transport, through the property field in DDS_DomainParticipantQos. |
RTI Data Distribution Service C++ API Version 4.5e
Copyright © 23 Oct 2011
Real-Time Innovations, Inc