ast_sip_session Struct Reference

A structure describing a SIP session. More...

#include <res_pjsip_session.h>

Collaboration diagram for ast_sip_session:

Collaboration graph
[legend]

Data Fields

struct ast_sip_aoraor
struct ast_channelchannel
struct ast_sip_contactcontact
struct ao2_containerdatastores
unsigned int defer_terminate:1
pjsip_rx_data * deferred_reinvite
struct {
   struct
ast_sip_session_delayed_request *   first
   struct
ast_sip_session_delayed_request *   last
delayed_requests
struct ast_format_capdirect_media_cap
struct ast_dspdsp
struct ast_sip_endpointendpoint
char exten [AST_MAX_EXTENSION]
struct ast_party_id id
struct pjsip_inv_session * inv_session
struct ao2_containermedia
struct ast_format_capreq_caps
pj_timer_entry rescheduled_reinvite
pj_timer_entry scheduled_termination
struct ast_taskprocessorserializer
struct {
   struct ast_sip_session_supplement *   first
   struct ast_sip_session_supplement *   last
   ast_mutex_t   lock
supplements
struct ast_sip_session_suspendersuspended
enum ast_sip_session_t38state t38state
unsigned int terminate_while_deferred:1

Detailed Description

A structure describing a SIP session.

For the sake of brevity, a "SIP session" in Asterisk is referring to a dialog initiated by an INVITE. While "session" is typically interpreted to refer to the negotiated media within a SIP dialog, we have opted to use the term "SIP session" to refer to the INVITE dialog itself.

Definition at line 105 of file res_pjsip_session.h.


Field Documentation

struct ast_sip_aor* aor [read]

The AOR associated with this session

Definition at line 149 of file res_pjsip_session.h.

Referenced by ast_sip_session_create_outgoing(), read_pjsip(), request(), and session_destructor().

struct ast_channel* channel [read]

The Asterisk channel associated with the session

Definition at line 115 of file res_pjsip_session.h.

Referenced by __print_debug_details(), answer(), apply_negotiated_sdp_stream(), call(), call_pickup_incoming_request(), caller_id_incoming_request(), caller_id_incoming_response(), caller_id_outgoing_request(), caller_id_outgoing_response(), chan_pjsip_cng_tone_detected(), chan_pjsip_fixup(), chan_pjsip_hangup(), chan_pjsip_incoming_ack(), chan_pjsip_incoming_request(), chan_pjsip_incoming_response(), chan_pjsip_session_end(), clear_session_and_channel(), dtmf_info_incoming_request(), get_destination(), get_redirecting_add_diversion(), handle_incoming_request(), handle_negotiated_sdp(), incoming_in_dialog_request(), invite_replaces(), is_colp_update_allowed(), pbx_start_incoming_request(), queue_connected_line_update(), refer_attended_alloc(), refer_attended_task(), refer_incoming_attended_request(), refer_incoming_blind_request(), refer_incoming_invite_request(), refer_incoming_refer_request(), refer_outgoing_request(), refer_progress_alloc(), reschedule_reinvite(), resend_reinvite(), rfc3326_add_reason_header(), rfc3326_incoming_request(), rfc3326_incoming_response(), rfc3326_outgoing_request(), rfc3326_outgoing_response(), rfc3326_use_reason_header(), send_delayed_request(), session_inv_on_media_update(), session_inv_on_redirected(), session_inv_on_tsx_state_changed(), session_reinvite_on_rx_request(), set_caps(), set_redirecting(), t38_attach_framehook(), t38_change_state(), t38_framehook_read(), t38_initialize_session(), t38_reinvite_response_cb(), transfer(), transfer_redirect(), transfer_refer(), update_connected_line_information(), update_initial_connected_line(), and video_info_incoming_request().

struct ast_sip_contact* contact [read]

struct ao2_container* datastores [read]

unsigned int defer_terminate

pjsip_rx_data* deferred_reinvite

Deferred incoming re-invite

Definition at line 145 of file res_pjsip_session.h.

Referenced by ast_sip_session_resume_reinvite(), and session_reinvite_on_rx_request().

struct { ... } delayed_requests

Format capabilities pertaining to direct media

Definition at line 131 of file res_pjsip_session.h.

Referenced by ast_sip_session_alloc(), chan_pjsip_set_rtp_peer(), create_outgoing_sdp_stream(), session_destructor(), and set_caps().

struct ast_dsp* dsp [read]

Optional DSP, used only for inband DTMF detection if configured

Definition at line 139 of file res_pjsip_session.h.

Referenced by ast_sip_session_alloc(), chan_pjsip_cng_tone_detected(), chan_pjsip_read(), session_destructor(), and set_caps().

struct ast_sip_endpoint* endpoint [read]

The endpoint with which Asterisk is communicating

Definition at line 109 of file res_pjsip_session.h.

Referenced by __print_debug_details(), add_crypto_to_stream(), add_ice_to_stream(), add_id_headers(), add_session_media(), apply_negotiated_sdp_stream(), ast_sip_session_alloc(), ast_sip_session_create_outgoing(), ast_sip_session_refresh(), ast_sip_session_send_request_with_cb(), ast_sip_session_terminate(), caller_id_incoming_request(), caller_id_outgoing_request(), chan_pjsip_cng_tone_detected(), chan_pjsip_digit_begin(), chan_pjsip_digit_end(), chan_pjsip_get_codec(), chan_pjsip_get_rtp_peer(), chan_pjsip_get_vrtp_peer(), chan_pjsip_incoming_ack(), chan_pjsip_indicate(), chan_pjsip_new(), chan_pjsip_queryoption(), chan_pjsip_session_begin(), chan_pjsip_set_rtp_peer(), create_local_sdp(), create_outgoing_sdp_stream(), create_rtp(), defer_incoming_sdp_stream(), direct_media_mitigate_glare(), get_codecs(), get_destination(), get_redirecting_add_diversion(), handle_incoming_request(), is_colp_update_allowed(), nat_incoming_invite_response(), negotiate_incoming_sdp_stream(), path_session_outgoing_request(), path_session_outgoing_response(), process_ice_attributes(), queue_connected_line_update(), read_pjsip(), refer_incoming_attended_request(), refer_incoming_blind_request(), refer_incoming_invite_request(), refer_incoming_refer_request(), refer_progress_alloc(), request(), reschedule_reinvite(), resend_reinvite(), send_delayed_request(), send_direct_media_request(), session_destructor(), session_inv_on_redirected(), session_inv_on_tsx_state_changed(), set_caps(), setup_dtls_srtp(), t38_attach_framehook(), t38_framehook_write(), t38_initialize_session(), t38_interpret_sdp(), transmit_info_dtmf(), update_connected_line_information(), and update_incoming_connected_line().

char exten[AST_MAX_EXTENSION]

Dialplan extension where incoming call is destined

Definition at line 107 of file res_pjsip_session.h.

Referenced by call_pickup_incoming_request(), chan_pjsip_incoming_request(), and get_destination().

Definition at line 127 of file res_pjsip_session.h.

Definition at line 117 of file res_pjsip_session.h.

struct ast_party_id id [read]

struct pjsip_inv_session* inv_session [read]

Definition at line 127 of file res_pjsip_session.h.

Definition at line 117 of file res_pjsip_session.h.

Definition at line 117 of file res_pjsip_session.h.

struct ao2_container* media [read]

struct ast_format_cap* req_caps [read]

pj_timer_entry rescheduled_reinvite

When we need to reschedule a reinvite, we use this structure to do it

Definition at line 129 of file res_pjsip_session.h.

Referenced by invite_terminated(), and reschedule_reinvite().

pj_timer_entry scheduled_termination

When we need to forcefully end the session

Definition at line 133 of file res_pjsip_session.h.

Referenced by ast_sip_session_defer_termination(), ast_sip_session_defer_termination_cancel(), and session_end().

struct ast_taskprocessor* serializer [read]

struct { ... } supplements

Non-null if the session serializer is suspended or being suspended.

Definition at line 125 of file res_pjsip_session.h.

Referenced by ast_sip_session_suspend(), and ast_sip_session_unsuspend().

Termination requested while termination deferred

Definition at line 143 of file res_pjsip_session.h.

Referenced by ast_sip_session_defer_termination_cancel(), and ast_sip_session_terminate().


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

Generated on Thu Apr 16 06:35:37 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6