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 |
| bool | use_ipv4 |
| bool | use_ipv6 |
| List< IpTransportInterface > | interfaces |
| 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[] | multicast_address_v4 |
| byte[] | 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 |
| byte[] | broadcast_address |
| bool | do_meta_broadcast |
| uint | debug_flags |
Structure that holds UDP Transport configuration items.
| ReturnCode_t get_default_config | ( | ) | [inline] |
Initialize the UdpTransportConfig object with default values. Currently assigned values may be overwritten by defaults.
| 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.
advertise we can RX META MULTICAST
advertise we can RX USER MULTICAST
| byte [] broadcast_address |
4 byte IPv4 address. Default: 255.255.255.255
| uint debug_flags |
adjust the debug output from the transport
| bool do_meta_broadcast |
enable broadcast of META (DPD discovery) data default: 0 (off)
| bool dynamic_interfaces |
detect and handle changes to interface addresses
default: empty -> use all available interfaces
| byte [] multicast_address_v4 |
4 byte IPv4 address. Default: [ 239 255 0 1 ] per the standard
| byte [] multicast_address_v6 |
16 byte IPv6 address. 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)
initial size of data buffer
maximum size of data buffer
| bool rx_meta_multicast |
enable META MULTICAST (discovery) RX
| bool 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)
default: 64K (udp limit)
| bool tx_meta_multicast |
enable META MULTICAST (discovery) TX
| bool tx_meta_unicast |
enable META UNICAST (discovery) TX
| bool use_ipv4 |
Support IPv4 communications (default ON (1))
| bool use_ipv6 |
Support IPv4 communications (default OFF(0))
