BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJNATH Reference

pj_ice_sess Struct Reference
[ICE Session]

Data Fields

char obj_name [PJ_MAX_OBJ_NAME]
pj_pool_tpool
void * user_data
pj_mutex_tmutex
pj_ice_sess_role role
pj_ice_sess_options opt
pj_timestamp tie_breaker
pj_uint8_tprefs
pj_bool_t is_nominating
pj_bool_t is_complete
pj_status_t ice_status
pj_timer_entry timer
pj_ice_sess_cb cb
pj_stun_config stun_cfg
pj_str_t tx_ufrag
pj_str_t tx_uname
pj_str_t tx_pass
pj_str_t rx_ufrag
pj_str_t rx_uname
pj_str_t rx_pass
unsigned comp_cnt
pj_ice_sess_comp comp [PJ_ICE_MAX_COMP]
unsigned comp_ka
unsigned lcand_cnt
pj_ice_sess_cand lcand [PJ_ICE_MAX_CAND]
unsigned rcand_cnt
pj_ice_sess_cand rcand [PJ_ICE_MAX_CAND]
pj_ice_msg_data tp_data [4]
pj_ice_rx_check early_check
pj_ice_sess_checklist clist
pj_ice_sess_checklist valid_list
union {
   char   txt [128]
   char   errmsg [PJ_ERR_MSG_SIZE]
tmp

Detailed Description

This structure describes the ICE session. For this version of PJNATH, an ICE session corresponds to a single media stream (unlike the ICE session described in the ICE standard where an ICE session covers the whole media and may consist of multiple media streams). The decision to support only a single media session was chosen for simplicity, while still allowing application to utilize multiple media streams by creating multiple ICE sessions, one for each media stream.

Forward declaration for pj_ice_sess


Field Documentation

Component array

# of components.

Next comp for KA

Array of cand.

# of local cand.

char pj_ice_sess::obj_name[PJ_MAX_OBJ_NAME]

Object name.

Pool instance.

Type preference.

Array of cand.

# of remote cand.

Local password.

union { ... } pj_ice_sess::tmp

Temporary buffer for misc stuffs to avoid using stack too much

Array of transport datas

Remote password.

App. data.


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.