pjsip_dialog Struct Reference
[Base Dialog]

#include <sip_dialog.h>

Public Member Functions
	PJ_DECL_LIST_MEMBER (pjsip_dialog)
Data Fields
char	obj_name [PJ_MAX_OBJ_NAME]
pj_pool_t *	pool
pj_mutex_t *	mutex_
pjsip_user_agent *	ua
pjsip_endpoint *	endpt
void *	dlg_set
pjsip_dialog_state	state
pjsip_uri *	target
pjsip_target_set	target_set
pjsip_hdr	inv_hdr
pjsip_dlg_party	local
pjsip_dlg_party	remote
pjsip_hdr	rem_cap_hdr
pjsip_role_e	role
pj_bool_t	uac_has_2xx
pj_bool_t	secure
pj_bool_t	add_allow
pjsip_cid_hdr *	call_id
pjsip_route_hdr	route_set
pj_bool_t	route_set_frozen
pjsip_auth_clt_sess	auth_sess
int	sess_count
int	tsx_count
pjsip_tpselector	tp_sel
unsigned	usage_cnt
pjsip_module *	usage [32]
void *	mod_data [32]

---

Detailed Description

This structure describes the dialog structure. Application MUST NOT try to SET the values here directly, but instead it MUST use the appropriate dialog API. The dialog declaration only needs to be made visible because other PJSIP modules need to see it (e.g. INVITE session, the event framework, etc.).

Application MAY READ the dialog contents directly after it acquires dialog lock.

To acquire dialog lock, use pjsip_dlg_inc_lock(), and to release it, use pjsip_dlg_dec_lock(). DO NOT USE pj_mutex_lock()/pj_mutex_unlock() on the dialog's mutex directly, because this will not protect against dialog being destroyed.

Forward declaration for dialog (sip_dialog.h).

---

Member Function Documentation

pjsip_dialog::PJ_DECL_LIST_MEMBER

(

pjsip_dialog

)

The dialog set list.

---

Field Documentation

char pjsip_dialog::obj_name[PJ_MAX_OBJ_NAME]

Standard id.

pj_pool_t* pjsip_dialog::pool

Dialog's pool.

pj_mutex_t* pjsip_dialog::mutex_

Dialog's mutex. Do not call!! Use pjsip_dlg_inc_lock() instead!

pjsip_user_agent* pjsip_dialog::ua

User agent instance.

pjsip_endpoint* pjsip_dialog::endpt

Endpoint instance.

void* pjsip_dialog::dlg_set

The dialog set which this dialog belongs (opaque type).

pjsip_dialog_state pjsip_dialog::state

Dialog state.

pjsip_uri* pjsip_dialog::target

Current target.

pjsip_target_set pjsip_dialog::target_set

Target set, for UAC only.

pjsip_hdr pjsip_dialog::inv_hdr

Headers from hparam in dest URL

pjsip_dlg_party pjsip_dialog::local

Local party info.

pjsip_dlg_party pjsip_dialog::remote

Remote party info.

pjsip_hdr pjsip_dialog::rem_cap_hdr

List of remote capability header.

pjsip_role_e pjsip_dialog::role

Initial role.

pj_bool_t pjsip_dialog::uac_has_2xx

UAC has received 2xx response?

pj_bool_t pjsip_dialog::secure

Use secure transport?

pj_bool_t pjsip_dialog::add_allow

Add Allow header in requests?

pjsip_cid_hdr* pjsip_dialog::call_id

Call-ID header.

pjsip_route_hdr pjsip_dialog::route_set

Route set.

pj_bool_t pjsip_dialog::route_set_frozen

Route set has been set.

pjsip_auth_clt_sess pjsip_dialog::auth_sess

Client authentication session.

int pjsip_dialog::sess_count

Session counter. Number of sessions.

int pjsip_dialog::tsx_count

Transaction counter. Number of pending transactions.

pjsip_tpselector pjsip_dialog::tp_sel

Transport selector.

unsigned pjsip_dialog::usage_cnt

Number of registered usages.

pjsip_module* pjsip_dialog::usage[32]

Array of usages, priority sorted

void* pjsip_dialog::mod_data[32]

Module specific data. Module data.

---

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

• sip_dialog.h