UdpTransportConfig Class Reference

Public Member Functions
	UdpTransportConfig ()
ReturnCode_t	get_default_config ()
ReturnCode_t	get_env_config ()

Data Fields
short	participant_index
bool	use_ipv4
bool	use_ipv6
List< IpTransportInterface >	interfaces
List< string >	interface_names
bool	dynamic_interfaces
int	rx_init_buffer_size
int	rx_max_buffer_size
int	tx_max_packet_size
int	so_rcvbuf
int	so_sndbuf
byte []	meta_multicast_address_v4
byte []	user_multicast_address_v4
byte []	meta_multicast_address_v6
byte []	user_multicast_address_v6
byte	multicast_ttl
bool	tx_meta_multicast
bool	tx_meta_unicast
bool	rx_meta_multicast
bool	rx_user_multicast
bool	advertise_meta_multicast
bool	advertise_user_multicast
bool	try_to_keep_mcast_local
byte []	broadcast_address
bool	do_meta_broadcast
uint	debug_flags

Detailed Description

Structure that holds UDP Transport configuration items.

See also

DomainParticipant::add_transport(Transport) add_transport()

Constructor & Destructor Documentation

UdpTransportConfig()

UdpTransportConfig ( )

inline

Constructor. Initializes all configuration items with default values.

Member Function Documentation

get_default_config()

ReturnCode_t get_default_config ( )

inline

Initialize the UdpTransportConfig object with default values. Currently assigned values may be overwritten by defaults.

get_env_config()

ReturnCode_t get_env_config ( )

inline

Query for environment variables that impact udp transport configuration. Load the values (if any) into the UdpTransportConfig object. Currently assigned values may be overwritten by values derived from environment variables.

Field Documentation

advertise_meta_multicast

bool advertise_meta_multicast

advertise we can RX META MULTICAST

advertise_user_multicast

bool advertise_user_multicast

advertise we can RX USER MULTICAST

broadcast_address

byte [] broadcast_address

4 byte IPv4 address. Default: 255.255.255.255

debug_flags

uint debug_flags

adjust the debug output from the transport

do_meta_broadcast

bool do_meta_broadcast

enable broadcast of META (DPD discovery) data default: 0 (off)

dynamic_interfaces

bool dynamic_interfaces

detect and handle changes to interface addresses

interface_names

List<string> interface_names

List of interface names to use. Get IP address[es] from these interfaces. Consulted only if 'interfaces' (above) is empty. default: empty

interfaces

List<IpTransportInterface> interfaces

List of IP addresses to use. default: empty -> use addresses from all available interfaces, filtered by interface_name[s]

meta_multicast_address_v4

byte [] meta_multicast_address_v4

4 byte IPv4 address for meta (discovery) traffic. Default: [ 239 255 0 1 ] per the standard

meta_multicast_address_v6

byte [] meta_multicast_address_v6

16 byte IPv6 address for meta (discovery) traffic. Default: [ ff03:0000:0000:0000:0000:efff:0001 ]

multicast_ttl

byte multicast_ttl

default: 1 (0: disable all MCAST TX)

participant_index

short participant_index

-1: auto detect; else force (may fail if another participant is using the ports (can't exceed 120)

rx_init_buffer_size

int rx_init_buffer_size

initial size of data buffer

rx_max_buffer_size

int rx_max_buffer_size

maximum size of data buffer

rx_meta_multicast

bool rx_meta_multicast

enable META MULTICAST (discovery) RX

rx_user_multicast

bool rx_user_multicast

enable USER MULTICAST (data) RX

so_rcvbuf

int so_rcvbuf

socket RCVBUF size (set to -1 to use OS default)

so_sndbuf

int so_sndbuf

socket SNDBUF size (set to -1 to use OS default)

try_to_keep_mcast_local

bool try_to_keep_mcast_local

when possible (inferred by discovered peers), send multicast transmissions to only the localhost interface [enabled by default]

tx_max_packet_size

int tx_max_packet_size

default: 64K (udp limit)

tx_meta_multicast

bool tx_meta_multicast

enable META MULTICAST (discovery) TX

tx_meta_unicast

bool tx_meta_unicast

enable META UNICAST (discovery) TX

use_ipv4

bool use_ipv4

Support IPv4 communications (default ON (1))

use_ipv6

bool use_ipv6

Support IPv4 communications (default OFF(0))

user_multicast_address_v4

byte [] user_multicast_address_v4

4 byte IPv4 address for user traffic. Default: [ 239 255 0 1 ] per the standard

user_multicast_address_v6

byte [] user_multicast_address_v6

16 byte IPv6 address for user traffic. Default: [ ff03:0000:0000:0000:0000:efff:0001 ]