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 |
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 |
byte | broadcast_address [] |
boolean | do_meta_broadcast |
Structure that holds UDP Transport configuration items.
ReturnCode_t get_default_config | ( | ) |
Initialize the UdpTransportConfig object with default values. Currently assigned values may be overwritten by defaults.
ReturnCode_t 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.
boolean advertise_meta_multicast |
advertise we can RX META MULTICAST
boolean advertise_user_multicast |
advertise we can RX USER MULTICAST
byte broadcast_address[] |
4 byte IPv4 address. Default: 255.255.255.255
boolean do_meta_broadcast |
enable broadcast of META (DPD discovery) data default: 0 (off)
boolean dynamic_interfaces |
detect and handle changes to interface addresses
Vector<IpTransportInterface> interfaces |
default: empty -> use all available interfaces
byte meta_multicast_address_v4[] |
4 byte IPv4 address for meta (discovery) traffic. Default: [ 239 255 0 1 ] per the standard
byte meta_multicast_address_v6[] |
16 byte IPv6 address for meta (discovery) traffic. Default: [ ff03:0000:0000:0000:0000:efff:0001 ]
byte multicast_ttl |
default: 1 (0: disable all MCAST TX)
short participant_index |
-1: auto detect; else force (may fail if another participant is using the ports (can't exceed 120)
int rx_init_buffer_size |
initial size of data buffer
int rx_max_buffer_size |
maximum size of data buffer
boolean rx_meta_multicast |
enable META MULTICAST (discovery) RX
boolean rx_user_multicast |
enable USER MULTICAST (data) RX
int so_rcvbuf |
socket RCVBUF size (set to -1 to use OS default)
int so_sndbuf |
socket SNDBUF size (set to -1 to use OS default)
int tx_max_packet_size |
default: 64K (udp limit)
boolean tx_meta_multicast |
enable META MULTICAST (discovery) TX
boolean tx_meta_unicast |
enable META UNICAST (discovery) TX
boolean use_ipv4 |
Support IPv4 communications (default ON (1))
boolean use_ipv6 |
Support IPv4 communications (default OFF(0))
byte user_multicast_address_v4[] |
4 byte IPv4 address for user traffic. Default: [ 239 255 0 1 ] per the standard
byte user_multicast_address_v6[] |
16 byte IPv6 address for user traffic. Default: [ ff03:0000:0000:0000:0000:efff:0001 ]