com.toc.coredx.DDS.UdpTransportConfig Class Reference

Structure that holds UDP Transport configuration items. More...

Public Member Functions
	UdpTransportConfig ()
	Constructor. Initializes all configuration items with default values.
ReturnCode_t	get_default_config ()
ReturnCode_t	get_env_config ()

Public Attributes
short	participant_index
boolean	use_ipv4
boolean	use_ipv6
Vector< IpTransportInterface >	interfaces
Vector< String >	interface_names
boolean	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
boolean	tx_meta_multicast
boolean	tx_meta_unicast
boolean	rx_meta_multicast
boolean	rx_user_multicast
boolean	advertise_meta_multicast
boolean	advertise_user_multicast
boolean	try_to_keep_mcast_local
byte	broadcast_address []
boolean	do_meta_broadcast

Detailed Description

Structure that holds UDP Transport configuration items.

See also

DomainParticipant::add_transport(Transport) add_transport()

Member Function Documentation

get_default_config()

ReturnCode_t com.toc.coredx.DDS.UdpTransportConfig.get_default_config

(

)

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

get_env_config()

ReturnCode_t com.toc.coredx.DDS.UdpTransportConfig.get_env_config

(

)

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.

Member Data Documentation

advertise_meta_multicast

boolean com.toc.coredx.DDS.UdpTransportConfig.advertise_meta_multicast

advertise we can RX META MULTICAST

advertise_user_multicast

boolean com.toc.coredx.DDS.UdpTransportConfig.advertise_user_multicast

advertise we can RX USER MULTICAST

broadcast_address

byte com.toc.coredx.DDS.UdpTransportConfig.broadcast_address[]

4 byte IPv4 address. Default: 255.255.255.255

do_meta_broadcast

boolean com.toc.coredx.DDS.UdpTransportConfig.do_meta_broadcast

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

dynamic_interfaces

boolean com.toc.coredx.DDS.UdpTransportConfig.dynamic_interfaces

detect and handle changes to interface addresses

interface_names

Vector<String> com.toc.coredx.DDS.UdpTransportConfig.interface_names

A list of interface names to use. Consulted only if 'interfaces' is empty. default: empty, which means it will use all available interfaces

interfaces

Vector<IpTransportInterface> com.toc.coredx.DDS.UdpTransportConfig.interfaces

A list of IP addresses to use. default: empty, which means use any IP addr[s] from all available interfaces

meta_multicast_address_v4

byte com.toc.coredx.DDS.UdpTransportConfig.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 com.toc.coredx.DDS.UdpTransportConfig.meta_multicast_address_v6[]

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

multicast_ttl

byte com.toc.coredx.DDS.UdpTransportConfig.multicast_ttl

default: 1 (0: disable all MCAST TX)

participant_index

short com.toc.coredx.DDS.UdpTransportConfig.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 com.toc.coredx.DDS.UdpTransportConfig.rx_init_buffer_size

initial size of data buffer

rx_max_buffer_size

int com.toc.coredx.DDS.UdpTransportConfig.rx_max_buffer_size

maximum size of data buffer

rx_meta_multicast

boolean com.toc.coredx.DDS.UdpTransportConfig.rx_meta_multicast

enable META MULTICAST (discovery) RX

rx_user_multicast

boolean com.toc.coredx.DDS.UdpTransportConfig.rx_user_multicast

enable USER MULTICAST (data) RX

so_rcvbuf

int com.toc.coredx.DDS.UdpTransportConfig.so_rcvbuf

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

so_sndbuf

int com.toc.coredx.DDS.UdpTransportConfig.so_sndbuf

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

try_to_keep_mcast_local

boolean com.toc.coredx.DDS.UdpTransportConfig.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 com.toc.coredx.DDS.UdpTransportConfig.tx_max_packet_size

default: 64K (udp limit)

tx_meta_multicast

boolean com.toc.coredx.DDS.UdpTransportConfig.tx_meta_multicast

enable META MULTICAST (discovery) TX

tx_meta_unicast

boolean com.toc.coredx.DDS.UdpTransportConfig.tx_meta_unicast

enable META UNICAST (discovery) TX

use_ipv4

boolean com.toc.coredx.DDS.UdpTransportConfig.use_ipv4

Support IPv4 communications (default ON (1))

use_ipv6

boolean com.toc.coredx.DDS.UdpTransportConfig.use_ipv6

Support IPv4 communications (default OFF(0))

user_multicast_address_v4

byte com.toc.coredx.DDS.UdpTransportConfig.user_multicast_address_v4[]

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

user_multicast_address_v6

byte com.toc.coredx.DDS.UdpTransportConfig.user_multicast_address_v6[]

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