webrtc_config_t Struct Reference

ICE, signaling, DataChannel, and callback settings for a WebRTC peer. More...

#include <include/ascii-chat/network/webrtc/webrtc.h>

Data Fields
const char *	bind_address
	Optional local interface address for ICE sockets.
stun_server_t *	stun_servers
	Array of STUN servers.
size_t	stun_count
	Number of STUN servers.
turn_server_t *	turn_servers
	Array of TURN servers.
size_t	turn_count
	Number of TURN servers.
bool	relay_only
	Restrict ICE to TURN relay candidates.
const char *	turn_username
	Optional credential override, including full ACDS usernames.
const char *	turn_credential
	Optional credential override.
webrtc_state_callback_t	on_state_change
webrtc_gathering_state_callback_t	on_gathering_state_change
webrtc_local_description_callback_t	on_local_description
webrtc_local_candidate_callback_t	on_local_candidate
webrtc_datachannel_open_callback_t	on_datachannel_open
webrtc_datachannel_message_callback_t	on_datachannel_message
webrtc_datachannel_error_callback_t	on_datachannel_error
void *	user_data
	Passed to all callbacks.
bool	port_forwarding
	Opt-in UDP mapping before ICE gathering (native peers only).

Detailed Description

ICE, signaling, DataChannel, and callback settings for a WebRTC peer.

The configuration supplies optional STUN/TURN servers and credentials, relay-only and port-forwarding policy, and callbacks for ICE, SDP, state, and DataChannel events. Server lists and user_data are borrowed by the peer while it is alive.

Definition at line 136 of file include/ascii-chat/network/webrtc/webrtc.h.

Field Documentation

bind_address

const char* webrtc_config_t::bind_address

Optional local interface address for ICE sockets.

Definition at line 137 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

on_datachannel_error

webrtc_datachannel_error_callback_t webrtc_config_t::on_datachannel_error

Definition at line 153 of file include/ascii-chat/network/webrtc/webrtc.h.

on_datachannel_message

webrtc_datachannel_message_callback_t webrtc_config_t::on_datachannel_message

Definition at line 152 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_datachannel().

on_datachannel_open

webrtc_datachannel_open_callback_t webrtc_config_t::on_datachannel_open

Definition at line 151 of file include/ascii-chat/network/webrtc/webrtc.h.

on_gathering_state_change

webrtc_gathering_state_callback_t webrtc_config_t::on_gathering_state_change

Definition at line 148 of file include/ascii-chat/network/webrtc/webrtc.h.

on_local_candidate

webrtc_local_candidate_callback_t webrtc_config_t::on_local_candidate

Definition at line 150 of file include/ascii-chat/network/webrtc/webrtc.h.

on_local_description

webrtc_local_description_callback_t webrtc_config_t::on_local_description

Definition at line 149 of file include/ascii-chat/network/webrtc/webrtc.h.

on_state_change

webrtc_state_callback_t webrtc_config_t::on_state_change

Definition at line 147 of file include/ascii-chat/network/webrtc/webrtc.h.

port_forwarding

bool webrtc_config_t::port_forwarding

Opt-in UDP mapping before ICE gathering (native peers only).

Definition at line 156 of file include/ascii-chat/network/webrtc/webrtc.h.

relay_only

bool webrtc_config_t::relay_only

Restrict ICE to TURN relay candidates.

Definition at line 142 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

stun_count

size_t webrtc_config_t::stun_count

Number of STUN servers.

Definition at line 139 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

stun_servers

stun_server_t* webrtc_config_t::stun_servers

Array of STUN servers.

Definition at line 138 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

turn_count

size_t webrtc_config_t::turn_count

Number of TURN servers.

Definition at line 141 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

turn_credential

const char* webrtc_config_t::turn_credential

Optional credential override.

Definition at line 144 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

turn_servers

turn_server_t* webrtc_config_t::turn_servers

Array of TURN servers.

Definition at line 140 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

turn_username

const char* webrtc_config_t::turn_username

Optional credential override, including full ACDS usernames.

Definition at line 143 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_create_peer_connection().

user_data

void* webrtc_config_t::user_data

Passed to all callbacks.

Definition at line 155 of file include/ascii-chat/network/webrtc/webrtc.h.

Referenced by webrtc_get_user_data().

---

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

• include/ascii-chat/network/webrtc/webrtc.h