UDP_InterfaceFactoryProperty Struct Reference

<<eXtension>> <<cert>> Properties for the UDP Transport. More...

#include <netio_udp.h>

Data Fields
struct REDA_StringSeq	allow_interface
	Sequence of allowed interface names.
struct REDA_StringSeq	deny_interface
	Sequence of denied interface names. This list is checked after the allow_interface list.
RTI_INT32	max_send_buffer_size
	The size of the send socket buffer.
RTI_INT32	max_receive_buffer_size
	The size of the receive socket buffer.
RTI_INT32	max_message_size
	The maximum size of the message which can be received.
RTI_INT32	max_send_message_size
	The maximum size of the message which can be sent. This is only a hint and not enforced.
RTI_INT32	multicast_ttl
	The maximum TTL.
struct UDP_NatEntrySeq	nat
	Configure network address translation (NAT).
struct UDP_InterfaceTableEntrySeq	if_table
	The interface table if interfaces are added manually.
REDA_String_T	multicast_interface
	The network interface to use to send to multicast.
RTI_BOOL	is_default_interface
	If this should be considered the default UDP interfaces if no other UDP interface is found to handle a route.
RTI_BOOL	disable_auto_interface_config
	Disable reading of available network interfaces using system information and instead rely on the manually configured interface table.
struct OSAPI_ThreadProperty	recv_thread
	Thread properties for each receive thread created by this NETIO interface.
RTI_BOOL	enable_interface_bind
	Bind receive sockets to specific interfaces.
struct UDP_TransformRuleSeq	source_rules
	Rules for how to transform received UDP payloads based on the source address.
struct UDP_TransformRuleSeq	destination_rules
	Rules for how to transform sent UDP payloads based on the destination address.
UDP_TransformUdpMode_T	transform_udp_mode
	Determines how regular UDP is supported when transformations are supported.
RTI_INT32	transform_locator_kind
	the locator to use for locators that have transformations.

---

Detailed Description

<<eXtension>> <<cert>> Properties for the UDP Transport.

Properties the UDP interface can be registered with.

---

Field Documentation

struct REDA_StringSeq UDP_InterfaceFactoryProperty::allow_interface

Sequence of allowed interface names.

struct REDA_StringSeq UDP_InterfaceFactoryProperty::deny_interface

Sequence of denied interface names. This list is checked after the allow_interface list.

RTI_INT32 UDP_InterfaceFactoryProperty::max_send_buffer_size

The size of the send socket buffer.

RTI_INT32 UDP_InterfaceFactoryProperty::max_receive_buffer_size

The size of the receive socket buffer.

RTI_INT32 UDP_InterfaceFactoryProperty::max_message_size

The maximum size of the message which can be received.

RTI_INT32 UDP_InterfaceFactoryProperty::max_send_message_size

The maximum size of the message which can be sent. This is only a hint and not enforced.

   This parameters is useful to UDP transformation functions which
   must allocate a buffer to put the result in.

RTI_INT32 UDP_InterfaceFactoryProperty::multicast_ttl

The maximum TTL.

struct UDP_NatEntrySeq UDP_InterfaceFactoryProperty::nat

Configure network address translation (NAT).

Supports translation between a private and public IP address only; UDP ports are not translated. Does not support any hole punching technique or WAN server, thus is only useful when the private and public address mapping is static.

struct UDP_InterfaceTableEntrySeq UDP_InterfaceFactoryProperty::if_table

The interface table if interfaces are added manually.

REDA_String_T UDP_InterfaceFactoryProperty::multicast_interface

The network interface to use to send to multicast.

RTI_BOOL UDP_InterfaceFactoryProperty::is_default_interface

If this should be considered the default UDP interfaces if no other UDP interface is found to handle a route.

RTI_BOOL UDP_InterfaceFactoryProperty::disable_auto_interface_config

Disable reading of available network interfaces using system information and instead rely on the manually configured interface table.

struct OSAPI_ThreadProperty UDP_InterfaceFactoryProperty::recv_thread

Thread properties for each receive thread created by this NETIO interface.

RTI_BOOL UDP_InterfaceFactoryProperty::enable_interface_bind

Bind receive sockets to specific interfaces.

     When this is set to TRUE the UDP transport binds each
     receive port to a specific interface when the
     allow_interface/deny_interface lists are non-empty. This allows
     multiple UDP transports to be used by a single DomainParticipant at
     the expense of an increased number of threads. This property is
     ignored when transformations are enabled and the
     allow_interface/deny_interface lists are non-empty.

struct UDP_TransformRuleSeq UDP_InterfaceFactoryProperty::source_rules

Rules for how to transform received UDP payloads based on the source address.

struct UDP_TransformRuleSeq UDP_InterfaceFactoryProperty::destination_rules

Rules for how to transform sent UDP payloads based on the destination address.

UDP_TransformUdpMode_T UDP_InterfaceFactoryProperty::transform_udp_mode

Determines how regular UDP is supported when transformations are supported.

RTI_INT32 UDP_InterfaceFactoryProperty::transform_locator_kind

the locator to use for locators that have transformations.

     When transformation rules have been enabled they are announced
     as a vendor specific locator. This property overrides this value.

     NOTE: Changing this value may prevent communication.

     NOTE : must be greater or equal than NETIO_ADDRESS_KIND_USER and not
     equal to NETIO_ADDRESS_KIND_SHMEM or NETIO_ADDRESS_KIND_INTRA.