BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJNATH Reference

#include <ice_session.h>

Data Fields

pj_bool_t aggressive
 
unsigned nominated_check_delay
 
int controlled_agent_want_nom_timeout
 
pj_ice_sess_trickle trickle
 

Detailed Description

This structure describes various ICE session options. Application configure the ICE session with these options by calling pj_ice_sess_set_options().

Field Documentation

◆ aggressive

pj_bool_t pj_ice_sess_options::aggressive

Specify whether to use aggressive nomination. This setting can only be enabled when trickle ICE is disabled.

◆ controlled_agent_want_nom_timeout

int pj_ice_sess_options::controlled_agent_want_nom_timeout

For a controlled agent, specify how long it wants to wait (in milliseconds) for the controlling agent to complete sending connectivity check with nominated flag set to true for all components after the controlled agent has found that all connectivity checks in its checklist have been completed and there is at least one successful (but not nominated) check for every component.

Default value for this option is ICE_CONTROLLED_AGENT_WAIT_NOMINATION_TIMEOUT. Specify -1 to disable this timer.

◆ nominated_check_delay

unsigned pj_ice_sess_options::nominated_check_delay

For controlling agent if it uses regular nomination, specify the delay to perform nominated check (connectivity check with USE-CANDIDATE attribute) after all components have a valid pair.

Default value is PJ_ICE_NOMINATED_CHECK_DELAY.

◆ trickle

pj_ice_sess_trickle pj_ice_sess_options::trickle

Trickle ICE mode. Note that, when enabled, aggressive nomination will be automatically disabled.

Default value is PJ_ICE_SESS_TRICKLE_DISABLED.


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.