pj_ice_strans_cfg Struct Reference
[ICE Stream Transport]

Detailed Description

This structure describes ICE stream transport configuration. Application should initialize the structure by calling pj_ice_strans_cfg_default() before changing the settings.


Data Fields
int	af
pj_stun_config	stun_cfg
pj_dns_resolver *	resolver
struct {
pj_stun_sock_cfg cfg
pj_bool_t no_host_cands
pj_bool_t loop_addr
pj_str_t server
pj_uint16_t port
}	stun
struct {
pj_str_t server
pj_uint16_t port
pj_turn_tp_type conn_type
pj_stun_auth_cred auth_cred
pj_turn_alloc_param alloc_param
}	turn

Field Documentation

int pj_ice_strans_cfg::af

Address family, IPv4 or IPv6. Currently only pj_AF_INET() (IPv4) is supported, and this is the default value.

pj_stun_config pj_ice_strans_cfg::stun_cfg

STUN configuration which contains the timer heap and ioqueue instance to be used, and STUN retransmission settings. This setting is mandatory.

The default value is all zero. Application must initialize this setting with pj_stun_config_init().

pj_dns_resolver* pj_ice_strans_cfg::resolver

DNS resolver to be used to resolve servers. If DNS SRV resolution is required, the resolver must be set.

The default value is NULL.

pj_stun_sock_cfg pj_ice_strans_cfg::cfg

Optional configuration for STUN transport. The default value will be initialized with pj_stun_sock_cfg_default().

pj_bool_t pj_ice_strans_cfg::no_host_cands

Disable host candidates. When this option is set, no host candidates will be added.

Default: PJ_FALSE

pj_bool_t pj_ice_strans_cfg::loop_addr

Include loopback addresses in the host candidates.

Default: PJ_FALSE

pj_str_t pj_ice_strans_cfg::server

Specify the STUN server domain or hostname or IP address. If DNS SRV resolution is required, application must fill in this setting with the domain name of the STUN server and set the resolver instance in the resolver field. Otherwise if the resolver setting is not set, this field will be resolved with hostname resolution and in this case the port field must be set.

The port field should also be set even when DNS SRV resolution is used, in case the DNS SRV resolution fails.

When this field is empty, STUN mapped address resolution will not be performed. In this case only ICE host candidates will be added to the ICE transport, unless if no_host_cands field is set. In this case, both host and srflx candidates are disabled.

The default value is empty.

Specify the TURN server domain or hostname or IP address. If DNS SRV resolution is required, application must fill in this setting with the domain name of the TURN server and set the resolver instance in the resolver field. Otherwise if the resolver setting is not set, this field will be resolved with hostname resolution and in this case the port field must be set.

The port field should also be set even when DNS SRV resolution is used, in case the DNS SRV resolution fails.

When this field is empty, relay candidate will not be created.

The default value is empty.

pj_uint16_t pj_ice_strans_cfg::port

The port number of the STUN server, when server field specifies a hostname rather than domain name. This field should also be set even when the server specifies a domain name, to allow DNS SRV resolution to fallback to DNS A/AAAA resolution when the DNS SRV resolution fails.

The default value is PJ_STUN_PORT.

The port number of the TURN server, when server field specifies a hostname rather than domain name. This field should also be set even when the server specifies a domain name, to allow DNS SRV resolution to fallback to DNS A/AAAA resolution when the DNS SRV resolution fails.

Default is zero.

struct { ... } pj_ice_strans_cfg::stun

STUN and local transport settings. This specifies the settings for local UDP socket, which will be resolved to get the STUN mapped address.

pj_turn_tp_type pj_ice_strans_cfg::conn_type

Type of connection to the TURN server.

Default is PJ_TURN_TP_UDP.

pj_stun_auth_cred pj_ice_strans_cfg::auth_cred

Credential to be used for the TURN session. This setting is mandatory.

Default is to have no credential.

pj_turn_alloc_param pj_ice_strans_cfg::alloc_param

Optional TURN Allocate parameter. The default value will be initialized by pj_turn_alloc_param_default().

struct { ... } pj_ice_strans_cfg::turn