Home --> Documentations --> PJNATH Reference

Data Fields

int af
pj_turn_sock_cfg cfg
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

Detailed Description

TURN transport settings for ICE stream transport.

Field Documentation

◆ af

int pj_ice_strans_turn_cfg::af

Address family, IPv4 or IPv6.

Default value is pj_AF_INET() (IPv4)

◆ alloc_param

pj_turn_alloc_param pj_ice_strans_turn_cfg::alloc_param

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

◆ auth_cred

pj_stun_auth_cred pj_ice_strans_turn_cfg::auth_cred

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

Default is to have no credential.

◆ cfg

pj_turn_sock_cfg pj_ice_strans_turn_cfg::cfg

Optional TURN socket settings. The default values will be initialized by pj_turn_sock_cfg_default(). This contains settings such as QoS.

◆ conn_type

pj_turn_tp_type pj_ice_strans_turn_cfg::conn_type

Type of connection to the TURN server.

Default is PJ_TURN_TP_UDP.

◆ port

pj_uint16_t pj_ice_strans_turn_cfg::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.

◆ server

pj_str_t pj_ice_strans_turn_cfg::server

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.

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


PJNATH - Open Source NAT traversal helper library supporting STUN, TURN, and ICE
Copyright (C) 2006-2009 Teluu Inc.