kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-26 14:27:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

chan_pjsip: Add technology-specific off-nominal hangup cause to events.

Browse Source 
Although the ISDN/Q.850/Q.931 hangup cause code is already part of the ARI
and AMI hangup and channel destroyed events, it can be helpful to know what
the actual channel technology code was if the call was unsuccessful.
For PJSIP, it's the SIP response code.

* A new "tech_hangupcause" field was added to the ast_channel structure along
with ast_channel_tech_hangupcause() and ast_channel_tech_hangupcause_set()
functions.  It should only be set for off-nominal terminations.

* chan_pjsip was modified to set the tech hangup cause in the
chan_pjsip_hangup() and chan_pjsip_session_end() functions.  This is a bit
tricky because these two functions aren't always called in the same order.
The channel that hangs up first will get chan_pjsip_session_end() called
first which will trigger the core to call chan_pjsip_hangup() on itself,
then call chan_pjsip_hangup() on the other channel.  The other channel's
chan_pjsip_session_end() function will get called last.  Unfortunately,
the other channel's HangupRequest events are sent before chan_pjsip has had a
chance to set the tech hangupcause code so the HangupRequest events for that
channel won't have the cause code set.  The ChannelDestroyed and Hangup
events however will have the code set for both channels.

* A new "tech_cause" field was added to the ast_channel_snapshot_hangup
structure. This is a public structure so a bit of refactoring was needed to
preserve ABI compatibility.

* The ARI ChannelHangupRequest and ChannelDestroyed events were modified to
include the "tech_cause" parameter in the JSON for off-nominal terminations.
The parameter is suppressed for nominal termination.

* The AMI SoftHangupRequest, HangupRequest and Hangup events were modified to
include the "TechCause" parameter for off-nominal terminations. Like their ARI
counterparts, the parameter is suppressed for nominal termination.

DeveloperNote: A "tech_cause" parameter has been added to the
ChannelHangupRequest and ChannelDestroyed ARI event messages and a "TechCause"
parameter has been added to the HangupRequest, SoftHangupRequest and Hangup
AMI event messages.  For chan_pjsip, these will be set to the last SIP
response status code for off-nominally terminated calls.  The parameter is
suppressed for nominal termination.
This commit is contained in:
George Joseph
2025-10-14 10:53:06 -06:00
committed by github-actions[bot]
parent f32e52721d
commit 721fb4ed03
12 changed files with 156 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
channels/chan_pjsip.c
View File

@@ -2577,16 +2577,23 @@ static int chan_pjsip_hangup(struct ast_channel *ast)
{
struct ast_sip_channel_pvt *channel = ast_channel_tech_pvt(ast);
int cause;
int tech_cause;
int original_tech_cause;
struct hangup_data *h_data;
SCOPE_ENTER(1, "%s\n", ast_channel_name(ast));
if (!channel || !channel->session) {
SCOPE_EXIT_RTN_VALUE(-1, "No channel or session\n");
SCOPE_EXIT_RTN_VALUE(-1, "%s: No channel or session\n", ast_channel_name(ast));
}
cause = hangup_cause2sip(ast_channel_hangupcause(channel->session->channel));
h_data = hangup_data_alloc(cause, ast);
cause = ast_channel_hangupcause(channel->session->channel);
tech_cause = hangup_cause2sip(cause);
original_tech_cause = ast_channel_tech_hangupcause(channel->session->channel);
if (!original_tech_cause) {
ast_channel_tech_hangupcause_set(channel->session->channel, tech_cause);
}
h_data = hangup_data_alloc(tech_cause, ast);
if (!h_data) {
goto failure;
}
@@ -2596,7 +2603,8 @@ static int chan_pjsip_hangup(struct ast_channel *ast)
goto failure;
}
SCOPE_EXIT_RTN_VALUE(0, "Cause: %d\n", cause);
SCOPE_EXIT_RTN_VALUE(0, "%s: Cause: %d Tech Cause: %d\n", ast_channel_name(ast),
cause, tech_cause);
failure:
/* Go ahead and do our cleanup of the session and channel even if we're not going
@@ -2606,7 +2614,7 @@ failure:
ao2_cleanup(channel);
ao2_cleanup(h_data);
SCOPE_EXIT_RTN_VALUE(-1, "Cause: %d\n", cause);
SCOPE_EXIT_RTN_VALUE(-1, "%s: Cause: %d\n", ast_channel_name(ast), cause);
}
struct request_data {
@@ -2943,7 +2951,7 @@ static void chan_pjsip_session_end(struct ast_sip_session *session)
SCOPE_ENTER(1, "%s\n", ast_sip_session_get_name(session));
if (!session->channel) {
SCOPE_EXIT_RTN("No channel\n");
SCOPE_EXIT_RTN("%s: No channel\n", ast_sip_session_get_name(session));
}
@@ -2959,6 +2967,24 @@ static void chan_pjsip_session_end(struct ast_sip_session *session)
chan_pjsip_remove_hold(ast_channel_uniqueid(session->channel));
ast_set_hangupsource(session->channel, ast_channel_name(session->channel), 0);
ast_trace(-1, "%s: channel cause: %d\n", ast_sip_session_get_name(session),
ast_channel_hangupcause(session->channel));
if (session->inv_session) {
/*
* tech_hangupcause should only be set if off-nominal.
*/
if (session->inv_session->cause / 100 > 2) {
ast_trace(-1, "%s: inv_session cause: %d\n", ast_sip_session_get_name(session),
session->inv_session->cause);
ast_channel_tech_hangupcause_set(session->channel, session->inv_session->cause);
} else {
ast_trace(-1, "%s: inv_session cause: %d suppressed\n", ast_sip_session_get_name(session),
session->inv_session->cause);
}
}
if (!ast_channel_hangupcause(session->channel) && session->inv_session) {
int cause = ast_sip_hangup_sip2cause(session->inv_session->cause);
@@ -2967,7 +2993,7 @@ static void chan_pjsip_session_end(struct ast_sip_session *session)
ast_queue_hangup(session->channel);
}
SCOPE_EXIT_RTN();
SCOPE_EXIT_RTN("%s\n", ast_sip_session_get_name(session));
}
static void set_sipdomain_variable(struct ast_sip_session *session)