A structure describing a SIP session. More...
#include <res_pjsip_session.h>
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 181 of file res_pjsip_session.h.
Field Documentation
◆ active_media_state
| struct ast_sip_session_media_state* active_media_state |
Active media state (sessions + streams) - contents are guaranteed not to change
Definition at line 211 of file res_pjsip_session.h.
Referenced by chan_pjsip_digit_begin(), chan_pjsip_digit_end(), chan_pjsip_get_rtp_peer(), chan_pjsip_get_vrtp_peer(), chan_pjsip_indicate(), chan_pjsip_write_stream(), hangup(), and pjsip_acf_dtmf_mode_write().
◆ ani2
| int ani2 |
Originating Line Info (ANI II digits)
Definition at line 247 of file res_pjsip_session.h.
◆ aor
| struct ast_sip_aor* aor |
The AOR associated with this session
Definition at line 225 of file res_pjsip_session.h.
◆ authentication_challenge_count
| unsigned int authentication_challenge_count |
Number of challenges received during outgoing requests to determine if we are in a loop
Definition at line 243 of file res_pjsip_session.h.
◆ call_direction
| enum ast_sip_session_call_direction call_direction |
The direction of the call respective to Asterisk
Definition at line 245 of file res_pjsip_session.h.
◆ channel
| struct ast_channel* channel |
The Asterisk channel associated with the session
Definition at line 191 of file res_pjsip_session.h.
Referenced by call(), chan_pjsip_fixup(), chan_pjsip_hangup(), chan_pjsip_read_stream(), chan_pjsip_set_rtp_peer(), chan_pjsip_write_stream(), dtmf_mode_refresh_cb(), hangup(), invite_replaces(), refer_attended_alloc(), refer_attended_task(), send_direct_media_request(), and transfer().
◆ contact
| struct ast_sip_contact* contact |
The contact associated with this session
Definition at line 187 of file res_pjsip_session.h.
Referenced by ast_sip_session_alloc(), and ast_sip_session_create_outgoing().
◆ current
| size_t current |
Definition at line 241 of file res_pjsip_session.h.
◆ datastores
| struct ao2_container* datastores |
Datastores added to the session by supplements to the session
Definition at line 195 of file res_pjsip_session.h.
◆ defer_end
| unsigned int defer_end |
Whether the end of the session should be deferred
Definition at line 229 of file res_pjsip_session.h.
◆ defer_terminate
| unsigned int defer_terminate |
Whether the termination of the session should be deferred
Definition at line 217 of file res_pjsip_session.h.
◆ deferred_reinvite
| pjsip_rx_data* deferred_reinvite |
Deferred incoming re-invite
Definition at line 221 of file res_pjsip_session.h.
◆
| struct { ... } delayed_requests |
Requests that could not be sent due to current inv_session state
◆ direct_media_cap
| struct ast_format_cap* direct_media_cap |
Format capabilities pertaining to direct media
Definition at line 205 of file res_pjsip_session.h.
◆ dsp
| struct ast_dsp* dsp |
Optional DSP, used only for inband DTMF/Fax-CNG detection if configured
Definition at line 215 of file res_pjsip_session.h.
Referenced by pjsip_acf_dtmf_mode_write().
◆ dtmf
| enum ast_sip_dtmf_mode dtmf |
DTMF mode to use with this session, from endpoint but can change
Definition at line 237 of file res_pjsip_session.h.
Referenced by chan_pjsip_digit_begin(), chan_pjsip_digit_end(), pjsip_acf_dtmf_mode_read(), and pjsip_acf_dtmf_mode_write().
◆ early_confirmed
| unsigned int early_confirmed |
Whether early media state has been confirmed through PRACK
Definition at line 235 of file res_pjsip_session.h.
◆ elems
| struct ast_rtp_instance_stats* * elems |
Definition at line 241 of file res_pjsip_session.h.
◆ ended_while_deferred
| unsigned int ended_while_deferred |
Session end (remote hangup) requested while termination deferred
Definition at line 231 of file res_pjsip_session.h.
◆ endpoint
| struct ast_sip_endpoint* endpoint |
The endpoint with which Asterisk is communicating
Definition at line 185 of file res_pjsip_session.h.
Referenced by ast_sip_session_alloc(), ast_sip_session_create_outgoing(), chan_pjsip_get_rtp_peer(), chan_pjsip_get_vrtp_peer(), chan_pjsip_indicate(), chan_pjsip_queryoption(), handle_new_invite_request(), media_offer_write_av(), new_invite(), push_notify(), sendtext(), and t38_framehook().
◆ exten
| char exten[AST_MAX_EXTENSION] |
Dialplan extension where incoming call is destined
Definition at line 183 of file res_pjsip_session.h.
Referenced by new_invite(), and session_inv_on_redirected().
◆ first [1/2]
| struct ast_sip_session_supplement* first |
Definition at line 193 of file res_pjsip_session.h.
◆ first [2/2]
| struct ast_sip_session_delayed_request* first |
Definition at line 201 of file res_pjsip_session.h.
◆ id
| struct ast_party_id id |
Identity of endpoint this session deals with
Definition at line 209 of file res_pjsip_session.h.
Referenced by Section::__cmp__(), Section::__eq__(), Section::__ge__(), Section::__gt__(), Section::__le__(), Section::__lt__(), and Model::load().
◆ inv_session
| struct pjsip_inv_session* inv_session |
The PJSIP details of the session, which includes the dialog
Definition at line 189 of file res_pjsip_session.h.
Referenced by ast_sip_dialog_get_session(), ast_sip_session_alloc(), ast_sip_session_create_outgoing(), ast_sip_session_get_dialog(), ast_sip_session_get_pjsip_inv_state(), chan_pjsip_get_uniqueid(), chan_pjsip_indicate(), channel_read_pjsip(), dtmf_mode_refresh_cb(), handle_new_invite_request(), media_offer_write_av(), new_invite(), pjsip_app_hangup_handler(), pjsip_hangup(), sendtext(), session_on_rx_request(), session_on_rx_response(), session_on_tsx_state(), transfer(), and update_header().
◆ last [1/2]
| struct ast_sip_session_supplement* last |
Definition at line 193 of file res_pjsip_session.h.
◆ last [2/2]
| struct ast_sip_session_delayed_request* last |
Definition at line 201 of file res_pjsip_session.h.
◆ lock
| ast_mutex_t lock |
Definition at line 193 of file res_pjsip_session.h.
◆ max
| size_t max |
Definition at line 241 of file res_pjsip_session.h.
◆
| struct { ... } media_stats |
Media statistics for negotiated RTP streams
Referenced by ast_sip_session_media_stats_save().
◆ moh_passthrough
| unsigned int moh_passthrough |
Whether to pass through hold and unhold using re-invites with recvonly and sendrecv
Definition at line 233 of file res_pjsip_session.h.
Referenced by chan_pjsip_indicate(), pjsip_acf_moh_passthrough_read(), and pjsip_acf_moh_passthrough_write().
◆ pending_media_state
| struct ast_sip_session_media_state* pending_media_state |
Pending media state (sessions + streams)
Definition at line 213 of file res_pjsip_session.h.
Referenced by chan_pjsip_call(), and media_offer_write_av().
◆ request_uri
| pjsip_uri* request_uri |
Initial incoming INVITE Request-URI. NULL otherwise.
Definition at line 239 of file res_pjsip_session.h.
Referenced by channel_read_pjsip().
◆ rescheduled_reinvite
| pj_timer_entry rescheduled_reinvite |
When we need to reschedule a reinvite, we use this structure to do it
Definition at line 203 of file res_pjsip_session.h.
◆ saved_from_hdr
| pjsip_fromto_hdr* saved_from_hdr |
From header saved at invite creation
Definition at line 227 of file res_pjsip_session.h.
◆ scheduled_termination
| pj_timer_entry scheduled_termination |
When we need to forcefully end the session
Definition at line 207 of file res_pjsip_session.h.
◆ serializer
| struct ast_taskprocessor* serializer |
Serializer for tasks relating to this SIP session
Definition at line 197 of file res_pjsip_session.h.
Referenced by aoc_framehook(), chan_pjsip_call(), chan_pjsip_digit_end(), chan_pjsip_hangup(), chan_pjsip_indicate(), chan_pjsip_sendtext_data(), chan_pjsip_transfer(), func_read_header(), func_read_headers(), func_read_param(), func_response_read_header(), func_response_read_headers(), func_write_header(), func_write_param(), pjsip_acf_dtmf_mode_write(), pjsip_acf_media_offer_write(), pjsip_acf_session_refresh_write(), pjsip_app_hangup_handler(), refer_attended_task(), and t38_framehook().
◆
| struct { ... } supplements |
Registered session supplements
◆ suspended
| struct ast_sip_session_suspender* suspended |
Non-null if the session serializer is suspended or being suspended.
Definition at line 199 of file res_pjsip_session.h.
◆ t38state
| enum ast_sip_session_t38state t38state |
Current T.38 state
Definition at line 223 of file res_pjsip_session.h.
Referenced by chan_pjsip_indicate(), chan_pjsip_queryoption(), and channel_read_pjsip().
◆ terminate_while_deferred
| unsigned int terminate_while_deferred |
Termination requested while termination deferred
Definition at line 219 of file res_pjsip_session.h.
The documentation for this struct was generated from the following file:
