Home --> Documentations --> PJNATH Reference

Data Fields

int bandwidth
int lifetime
int ka_interval
int af
pj_turn_tp_type peer_conn_type

Detailed Description

Allocation parameter, which can be given when application calls pj_turn_session_alloc() to allocate relay address in the TURN server. Application should call pj_turn_alloc_param_default() to initialize this structure with the default values.

Field Documentation

◆ af

int pj_turn_alloc_param::af

The requested ADDRESS-FAMILY. Default is zero to request relay with address family matched to the one specified in TURN session creation. Valid values are zero, pj_AF_INET(), and pj_AF_INET6().

Default value is zero.

◆ bandwidth

int pj_turn_alloc_param::bandwidth

The requested BANDWIDTH. Default is zero to not request any specific bandwidth. Note that this attribute has been deprecated after TURN-08 draft, hence application should only use this attribute when talking to TURN-07 or older version.

◆ ka_interval

int pj_turn_alloc_param::ka_interval

If set to non-zero, the TURN session will periodically send blank Send Indication every PJ_TURN_KEEP_ALIVE_SEC to refresh local NAT bindings. Default is zero.

◆ lifetime

int pj_turn_alloc_param::lifetime

The requested LIFETIME. Default is zero to not request any explicit allocation lifetime.

◆ peer_conn_type

pj_turn_tp_type pj_turn_alloc_param::peer_conn_type

Type of connection to from TURN server to peer. Supported values are PJ_TURN_TP_UDP (RFC 5766) and PJ_TURN_TP_TCP (RFC 6062)

Default is PJ_TURN_TP_UDP.

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.