ice_candidate_t Struct Reference

Single ICE candidate for connectivity. More...

#include <lib/network/webrtc/ice.h>

Data Fields
char	foundation [32]
	Unique identifier for candidate (for pairing)
uint32_t	component_id
	Component (1=RTP, 2=RTCP; usually 1)
ice_protocol_t	protocol
	UDP or TCP.
uint32_t	priority
	Candidate priority (used for preference)
char	ip_address [64]
	IP address (IPv4 or IPv6)
uint16_t	port
	Port number.
ice_candidate_type_t	type
	host, srflx, prflx, or relay
char	raddr [64]
	Related address (for srflx/prflx)
uint16_t	rport
	Related port.
ice_tcp_type_t	tcp_type
	active, passive, so
char	extensions [256]
	Additional extensions (e.g., "tcptype passive")

Detailed Description

Single ICE candidate for connectivity.

Represents one possible address/port combination for connection. The WebRTC agent will test all candidate pairs to find working path.

String Format (attribute line)

a=candidate:foundation 1 udp priority 192.168.1.100 12345 typ host
a=candidate:foundation 2 udp priority 203.0.113.45 54321 typ srflx raddr 192.168.1.100 rport 12345
a=candidate:foundation 3 udp priority 198.51.100.7 3478 typ relay raddr 203.0.113.45 rport 54321

Definition at line 111 of file ice.h.

Field Documentation

component_id

uint32_t ice_candidate_t::component_id

Component (1=RTP, 2=RTCP; usually 1)

Definition at line 114 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

extensions

char ice_candidate_t::extensions[256]

Additional extensions (e.g., "tcptype passive")

Definition at line 133 of file ice.h.

Referenced by ice_format_candidate().

foundation

char ice_candidate_t::foundation[32]

Unique identifier for candidate (for pairing)

Definition at line 113 of file ice.h.

Referenced by ice_add_remote_candidate(), ice_format_candidate(), and ice_parse_candidate().

ip_address

char ice_candidate_t::ip_address[64]

IP address (IPv4 or IPv6)

Definition at line 119 of file ice.h.

Referenced by ice_add_remote_candidate(), ice_format_candidate(), and ice_parse_candidate().

port

uint16_t ice_candidate_t::port

Port number.

Definition at line 120 of file ice.h.

Referenced by ice_add_remote_candidate(), ice_format_candidate(), and ice_parse_candidate().

priority

uint32_t ice_candidate_t::priority

Candidate priority (used for preference)

Definition at line 116 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

protocol

ice_protocol_t ice_candidate_t::protocol

UDP or TCP.

Definition at line 115 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

raddr

char ice_candidate_t::raddr[64]

Related address (for srflx/prflx)

Definition at line 126 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

rport

uint16_t ice_candidate_t::rport

Related port.

Definition at line 127 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

tcp_type

ice_tcp_type_t ice_candidate_t::tcp_type

active, passive, so

Definition at line 130 of file ice.h.

Referenced by ice_format_candidate(), and ice_parse_candidate().

type

ice_candidate_type_t ice_candidate_t::type

host, srflx, prflx, or relay

Definition at line 123 of file ice.h.

Referenced by ice_add_remote_candidate(), ice_format_candidate(), and ice_parse_candidate().

---

The documentation for this struct was generated from the following file:

• ice.h