bridge_after.h File Reference

After Bridge Execution API. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	ast_bridge_after_cb) (struct ast_channel *chan, void *data)
	After bridge callback function. More...
typedef void(*	ast_bridge_after_cb_failed) (enum ast_bridge_after_cb_reason reason, void *data)
	After bridge callback failed. More...

Enumerations
enum	ast_bridge_after_cb_reason {   AST_BRIDGE_AFTER_CB_REASON_DESTROY, AST_BRIDGE_AFTER_CB_REASON_REPLACED, AST_BRIDGE_AFTER_CB_REASON_MASQUERADE, AST_BRIDGE_AFTER_CB_REASON_DEPART,   AST_BRIDGE_AFTER_CB_REASON_REMOVED, AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED }

Functions
const char *	ast_bridge_after_cb_reason_string (enum ast_bridge_after_cb_reason reason)
	Get a string representation of an after bridge callback reason. More...
void	ast_bridge_discard_after_callback (struct ast_channel *chan, enum ast_bridge_after_cb_reason reason)
	Run discarding any after bridge callbacks. More...
void	ast_bridge_discard_after_goto (struct ast_channel *chan)
	Discard channel after bridge goto location. More...
void	ast_bridge_read_after_goto (struct ast_channel *chan, char *buffer, size_t buf_size)
	Read after bridge goto if it exists. More...
void	ast_bridge_run_after_callback (struct ast_channel *chan)
	Run any after bridge callback. More...
void	ast_bridge_run_after_goto (struct ast_channel *chan)
	Run a PBX on any after bridge goto location. More...
int	ast_bridge_set_after_callback (struct ast_channel *chan, ast_bridge_after_cb callback, ast_bridge_after_cb_failed failed, void *data)
	Setup an after bridge callback for when the channel leaves the bridging system. More...
void	ast_bridge_set_after_go_on (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *parseable_goto)
	Set channel to go on in the dialplan after the bridge. More...
void	ast_bridge_set_after_goto (struct ast_channel *chan, const char *context, const char *exten, int priority)
	Set channel to goto specific location after the bridge. More...
void	ast_bridge_set_after_h (struct ast_channel *chan, const char *context)
	Set channel to run the h exten after the bridge. More...
int	ast_bridge_setup_after_goto (struct ast_channel *chan)
	Setup any after bridge goto location to begin execution. More...

Detailed Description

After Bridge Execution API.

Author

Richard Mudgett rmudg.nosp@m.ett@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

See Also:

• CREDITS

Definition in file bridge_after.h.

Typedef Documentation

ast_bridge_after_cb

typedef void(* ast_bridge_after_cb) (struct ast_channel *chan, void *data)

After bridge callback function.

Since

12.0.0

Parameters

chan	Channel just leaving bridging system.
data	Extra data what setup the callback wanted to pass.

Returns

Nothing

Definition at line 211 of file bridge_after.h.

ast_bridge_after_cb_failed

typedef void(* ast_bridge_after_cb_failed) (enum ast_bridge_after_cb_reason reason, void *data)

After bridge callback failed.

Since

12.0.0

Parameters

reason	Reason callback is failing.
data	Extra data what setup the callback wanted to pass.

Note

Called when the channel leaves the bridging system or is destroyed.

Returns

Nothing

Definition at line 200 of file bridge_after.h.

Enumeration Type Documentation

ast_bridge_after_cb_reason

enum ast_bridge_after_cb_reason

Reason the after bridge callback will not be called.

Enumerator
AST_BRIDGE_AFTER_CB_REASON_DESTROY	The datastore is being destroyed. Likely due to hangup. (Enum value must be zero.)
AST_BRIDGE_AFTER_CB_REASON_REPLACED	Something else replaced the callback with another.
AST_BRIDGE_AFTER_CB_REASON_MASQUERADE	The callback was removed because of a masquerade. (fixup)
AST_BRIDGE_AFTER_CB_REASON_DEPART	The channel was departed from the bridge.
AST_BRIDGE_AFTER_CB_REASON_REMOVED	Was explicitly removed by external code.
AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED	The channel failed to enter the bridge.

Definition at line 37 of file bridge_after.h.

                                {
   /*! The datastore is being destroyed.  Likely due to hangup. (Enum value must be zero.) */
   AST_BRIDGE_AFTER_CB_REASON_DESTROY,
   /*! Something else replaced the callback with another. */
   AST_BRIDGE_AFTER_CB_REASON_REPLACED,
   /*! The callback was removed because of a masquerade. (fixup) */
   AST_BRIDGE_AFTER_CB_REASON_MASQUERADE,
   /*! The channel was departed from the bridge. */
   AST_BRIDGE_AFTER_CB_REASON_DEPART,
   /*! Was explicitly removed by external code. */
   AST_BRIDGE_AFTER_CB_REASON_REMOVED,
   /*! The channel failed to enter the bridge. */
   AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED,
};

Function Documentation

ast_bridge_after_cb_reason_string()

const char* ast_bridge_after_cb_reason_string

(

enum ast_bridge_after_cb_reason

reason

)

Get a string representation of an after bridge callback reason.

Since

12.0.0

Parameters

reason

The reason to interpret to a string

Return values

NULL	Unrecognized reason
non-NULL	String representation of reason

Definition at line 296 of file bridge_after.c.

References AST_BRIDGE_AFTER_CB_REASON_DEPART, AST_BRIDGE_AFTER_CB_REASON_DESTROY, AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED, AST_BRIDGE_AFTER_CB_REASON_MASQUERADE, AST_BRIDGE_AFTER_CB_REASON_REMOVED, and AST_BRIDGE_AFTER_CB_REASON_REPLACED.

Referenced by after_bridge_move_channel_fail(), agent_after_bridge_cb_failed(), bridge_after_cb_failed(), and internal_bridge_after_cb().

{
   switch (reason) {
   case AST_BRIDGE_AFTER_CB_REASON_DESTROY:
      return "Channel destroyed (hungup)";
   case AST_BRIDGE_AFTER_CB_REASON_REPLACED:
      return "Callback was replaced";
   case AST_BRIDGE_AFTER_CB_REASON_MASQUERADE:
      return "Channel masqueraded";
   case AST_BRIDGE_AFTER_CB_REASON_DEPART:
      return "Channel was departed from bridge";
   case AST_BRIDGE_AFTER_CB_REASON_REMOVED:
      return "Callback was removed";
   case AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED:
      return "Channel failed joining the bridge";
   }
   return "Unknown";
}

ast_bridge_discard_after_callback()

void ast_bridge_discard_after_callback	(	struct ast_channel *	chan,
		enum ast_bridge_after_cb_reason	reason
	)

Run discarding any after bridge callbacks.

Since

12.0.0

Parameters

chan	Channel to run after bridge callback.

Returns

Nothing

Definition at line 247 of file bridge_after.c.

References after_bridge_cb_find(), and after_bridge_cb_run_discard().

Referenced by ast_bridge_impart(), and bridge_channel_depart_thread().

{
   struct after_bridge_cb_ds *after_bridge;

   after_bridge = after_bridge_cb_find(chan);
   if (!after_bridge) {
      return;
   }

   after_bridge_cb_run_discard(after_bridge, reason);
}

ast_bridge_discard_after_goto()

void ast_bridge_discard_after_goto

(

struct ast_channel *

chan

)

Discard channel after bridge goto location.

Since

12.0.0

Parameters

chan	Channel to discard after bridge goto location.

Note

chan is locked by this function.

Returns

Nothing

Definition at line 396 of file bridge_after.c.

References after_bridge_goto_remove(), and ast_datastore_free().

Referenced by __after_bridge_set_goto(), after_bridge_goto_fixup(), bridge_channel_depart_thread(), feature_blind_transfer(), and func_channel_write_real().

{
   struct ast_datastore *datastore;

   datastore = after_bridge_goto_remove(chan);
   if (datastore) {
      ast_datastore_free(datastore);
   }
}

ast_bridge_read_after_goto()

void ast_bridge_read_after_goto	(	struct ast_channel *	chan,
		char *	buffer,
		size_t	buf_size
	)

Read after bridge goto if it exists.

Since

12.0.0

Parameters

chan	Channel to read the after bridge goto parseable goto string from
buffer	Buffer to write the after bridge goto data to
buf_size	size of the buffer being written to

Definition at line 406 of file bridge_after.c.

References ast_channel_datastore_find(), ast_strlen_zero, after_bridge_goto_ds::context, ast_datastore::data, after_bridge_goto_ds::exten, lock, NULL, after_bridge_goto_ds::parseable_goto, after_bridge_goto_ds::priority, after_bridge_goto_ds::run_h_exten, and SCOPED_CHANNELLOCK.

Referenced by func_channel_read().

{
   struct ast_datastore *datastore;
   struct after_bridge_goto_ds *after_bridge;
   char *current_pos = buffer;
   size_t remaining_size = buf_size;

   SCOPED_CHANNELLOCK(lock, chan);

   datastore = ast_channel_datastore_find(chan, &after_bridge_goto_info, NULL);
   if (!datastore) {
      buffer[0] = '\0';
      return;
   }

   after_bridge = datastore->data;

   if (after_bridge->parseable_goto) {
      snprintf(buffer, buf_size, "%s", after_bridge->parseable_goto);
      return;
   }

   if (!ast_strlen_zero(after_bridge->context)) {
      snprintf(current_pos, remaining_size, "%s,", after_bridge->context);
      remaining_size = remaining_size - strlen(current_pos);
      current_pos += strlen(current_pos);
   }

   if (after_bridge->run_h_exten) {
      snprintf(current_pos, remaining_size, "h,");
      remaining_size = remaining_size - strlen(current_pos);
      current_pos += strlen(current_pos);
   } else if (!ast_strlen_zero(after_bridge->exten)) {
      snprintf(current_pos, remaining_size, "%s,", after_bridge->exten);
      remaining_size = remaining_size - strlen(current_pos);
      current_pos += strlen(current_pos);
   }

   snprintf(current_pos, remaining_size, "%d", after_bridge->priority);
}

ast_bridge_run_after_callback()

void ast_bridge_run_after_callback

(

struct ast_channel *

chan

)

Run any after bridge callback.

Since

12.0.0

Parameters

chan	Channel to run after bridge callback.

Returns

Nothing

Definition at line 220 of file bridge_after.c.

References after_bridge_cb_failed(), after_bridge_cb_find(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, after_bridge_cb_node::callback, after_bridge_cb_ds::callbacks, after_bridge_cb_node::data, after_bridge_cb_node::failed, after_bridge_cb_node::list, NULL, and after_bridge_cb_node::reason.

Referenced by ast_bridge_join(), and bridge_channel_ind_thread().

{
   struct after_bridge_cb_ds *after_bridge;
   struct after_bridge_cb_node *node;

   after_bridge = after_bridge_cb_find(chan);
   if (!after_bridge) {
      return;
   }

   for (;;) {
      AST_LIST_LOCK(&after_bridge->callbacks);
      node = AST_LIST_REMOVE_HEAD(&after_bridge->callbacks, list);
      AST_LIST_UNLOCK(&after_bridge->callbacks);
      if (!node) {
         break;
      }
      if (node->reason) {
         after_bridge_cb_failed(node);
      } else {
         node->failed = NULL;
         node->callback(chan, node->data);
      }
      ast_free(node);
   }
}

ast_bridge_run_after_goto()

void ast_bridge_run_after_goto

(

struct ast_channel *

chan

)

Run a PBX on any after bridge goto location.

Since

12.0.0

Parameters

chan	Channel to execute after bridge goto location.

Note

chan is locked by this function.

Pull off any after bridge goto location datastore and run a PBX at that location.

Note

On return, the chan pointer is no longer valid because the channel has hung up.

Returns

Nothing

Definition at line 537 of file bridge_after.c.

References ast_bridge_setup_after_goto(), ast_hangup(), and ast_pbx_run().

Referenced by bridge_channel_ind_thread().

{
   int goto_failed;

   goto_failed = ast_bridge_setup_after_goto(chan);
   if (goto_failed || ast_pbx_run(chan)) {
      ast_hangup(chan);
   }
}

ast_bridge_set_after_callback()

int ast_bridge_set_after_callback	(	struct ast_channel *	chan,
		ast_bridge_after_cb	callback,
		ast_bridge_after_cb_failed	failed,
		void *	data
	)

Setup an after bridge callback for when the channel leaves the bridging system.

Since

12.0.0

Parameters

chan	Channel to setup an after bridge callback on.
callback	Function to call when the channel leaves the bridging system.
failed	Function to call when it will not be calling the callback.
data	Extra data to pass with the callback.

Note

chan is locked by this function.

failed is called when the channel leaves the bridging system or is destroyed.

Return values

0	on success.
-1	on error.

Definition at line 259 of file bridge_after.c.

References after_bridge_cb_setup(), ast_assert, AST_BRIDGE_AFTER_CB_REASON_REPLACED, ast_calloc, AST_LIST_INSERT_TAIL, AST_LIST_LAST, AST_LIST_LOCK, AST_LIST_UNLOCK, after_bridge_cb_node::callback, after_bridge_cb_ds::callbacks, after_bridge_cb_node::data, after_bridge_cb_node::failed, after_bridge_cb_node::list, NULL, and after_bridge_cb_node::reason.

Referenced by add_to_dial_bridge(), bridge_agent_hold_push(), bridge_channel_attended_transfer(), bridge_stasis_push(), control_swap_channel_in_bridge(), and stasis_app_bridge_playback_channel_add().

{
   struct after_bridge_cb_ds *after_bridge;
   struct after_bridge_cb_node *new_node;
   struct after_bridge_cb_node *last_node;

   /* Sanity checks. */
   ast_assert(chan != NULL);
   if (!chan || !callback) {
      return -1;
   }

   after_bridge = after_bridge_cb_setup(chan);
   if (!after_bridge) {
      return -1;
   }

   /* Create a new callback node. */
   new_node = ast_calloc(1, sizeof(*new_node));
   if (!new_node) {
      return -1;
   }
   new_node->callback = callback;
   new_node->failed = failed;
   new_node->data = data;

   /* Put it in the container disabling any previously active one. */
   AST_LIST_LOCK(&after_bridge->callbacks);
   last_node = AST_LIST_LAST(&after_bridge->callbacks);
   if (last_node && !last_node->reason) {
      last_node->reason = AST_BRIDGE_AFTER_CB_REASON_REPLACED;
   }
   AST_LIST_INSERT_TAIL(&after_bridge->callbacks, new_node, list);
   AST_LIST_UNLOCK(&after_bridge->callbacks);
   return 0;
}

ast_bridge_set_after_go_on()

void ast_bridge_set_after_go_on	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority,
		const char *	parseable_goto
	)

Set channel to go on in the dialplan after the bridge.

Since

12.0.0

Parameters

chan	Channel to setup after bridge goto location.
context	Current context of the caller channel.
exten	Current exten of the caller channel.
priority	Current priority of the caller channel
parseable_goto	User specified goto string from dialplan.

Note

chan is locked by this function.

Add a channel datastore to setup the goto location when the channel leaves the bridge and run a PBX from there.

If parseable_goto then use the given context/exten/priority as the relative position for the parseable_goto. Else goto the given context/exten/priority+1.

Returns

Nothing

Definition at line 636 of file bridge_after.c.

References __after_bridge_set_goto(), ast_replace_subargument_delimiter(), ast_strdupa, ast_strlen_zero, and NULL.

Referenced by bridge_exec(), feature_blind_transfer(), func_channel_write_real(), and setup_peer_after_bridge_goto().

{
   char *p_goto;

   if (!ast_strlen_zero(parseable_goto)) {
      p_goto = ast_strdupa(parseable_goto);
      ast_replace_subargument_delimiter(p_goto);
   } else {
      p_goto = NULL;
   }
   __after_bridge_set_goto(chan, 0, 0, context, exten, priority, p_goto);
}

ast_bridge_set_after_goto()

void ast_bridge_set_after_goto	(	struct ast_channel *	chan,
		const char *	context,
		const char *	exten,
		int	priority
	)

Set channel to goto specific location after the bridge.

Since

12.0.0

Parameters

chan	Channel to setup after bridge goto location.
context	Context to goto after bridge.
exten	Exten to goto after bridge.
priority	Priority to goto after bridge.

Note

chan is locked by this function.

Add a channel datastore to setup the goto location when the channel leaves the bridge and run a PBX from there.

Returns

Nothing

Definition at line 626 of file bridge_after.c.

References __after_bridge_set_goto(), and NULL.

Referenced by action_bridge().

{
   __after_bridge_set_goto(chan, 0, 1, context, exten, priority, NULL);
}

ast_bridge_set_after_h()

void ast_bridge_set_after_h	(	struct ast_channel *	chan,
		const char *	context
	)

Set channel to run the h exten after the bridge.

Since

12.0.0

Parameters

chan	Channel to setup after bridge goto location.
context	Context to goto after bridge.

Note

chan is locked by this function.

Add a channel datastore to setup the goto location when the channel leaves the bridge and run a PBX from there.

Returns

Nothing

Definition at line 631 of file bridge_after.c.

References __after_bridge_set_goto(), and NULL.

Referenced by setup_peer_after_bridge_goto().

{
   __after_bridge_set_goto(chan, 1, 0, context, NULL, 1, NULL);
}

ast_bridge_setup_after_goto()

int ast_bridge_setup_after_goto

(

struct ast_channel *

chan

)

Setup any after bridge goto location to begin execution.

Since

12.0.0

Parameters

chan	Channel to setup after bridge goto location.

Note

chan is locked by this function.

Pull off any after bridge goto location datastore and setup for dialplan execution there.

Return values

0	on success. The goto location is set for a PBX to run it.
non-zero	on error or no goto location.

Note

If the after bridge goto is set to run an h exten it is run here immediately.

Definition at line 447 of file bridge_after.c.

References after_bridge_goto_remove(), ast_channel_caller(), ast_channel_clear_flag(), ast_channel_clear_softhangup(), ast_channel_context(), ast_channel_context_set(), ast_channel_exten(), ast_channel_exten_set(), ast_channel_flags(), ast_channel_priority(), ast_channel_priority_set(), ast_channel_set_unbridged(), ast_channel_softhangup_internal_flag(), ast_check_hangup(), ast_datastore_free(), ast_debug, ast_exists_extension(), ast_explicit_goto(), AST_FLAG_IN_AUTOLOOP, AST_FLAG_OUTGOING, ast_goto_if_exists(), ast_parseable_goto(), ast_pbx_h_exten_run(), AST_SOFTHANGUP_ASYNCGOTO, ast_strdupa, ast_strlen_zero, ast_test_flag, context, after_bridge_goto_ds::context, ast_datastore::data, exten, after_bridge_goto_ds::exten, NULL, after_bridge_goto_ds::parseable_goto, priority, after_bridge_goto_ds::priority, after_bridge_goto_ds::run_h_exten, S_COR, and after_bridge_goto_ds::specific.

Referenced by app_control_dial(), ast_bridge_join(), ast_bridge_run_after_goto(), bridge_failed_peer_goto(), dial_exec_full(), and internal_bridge_after_cb().

{
   struct ast_datastore *datastore;
   struct after_bridge_goto_ds *after_bridge;
   int goto_failed = -1;

   /* We are going to be leaving the bridging system now;
    * clear any pending unbridge flags
    */
   ast_channel_set_unbridged(chan, 0);

   /* Determine if we are going to setup a dialplan location and where. */
   if (ast_channel_softhangup_internal_flag(chan) & AST_SOFTHANGUP_ASYNCGOTO) {
      /* An async goto has already setup a location. */
      ast_channel_clear_softhangup(chan, AST_SOFTHANGUP_ASYNCGOTO);
      if (!ast_check_hangup(chan)) {
         goto_failed = 0;
      }
      return goto_failed;
   }

   /* Get after bridge goto datastore. */
   datastore = after_bridge_goto_remove(chan);
   if (!datastore) {
      return goto_failed;
   }

   after_bridge = datastore->data;
   if (after_bridge->run_h_exten) {
      if (ast_exists_extension(chan, after_bridge->context, "h", 1,
         S_COR(ast_channel_caller(chan)->id.number.valid,
            ast_channel_caller(chan)->id.number.str, NULL))) {
         ast_debug(1, "Running after bridge goto h exten %s,h,1\n",
            ast_channel_context(chan));
         ast_pbx_h_exten_run(chan, after_bridge->context);
      }
   } else if (!ast_check_hangup(chan)) {
      /* Clear the outgoing flag */
      ast_channel_clear_flag(chan, AST_FLAG_OUTGOING);

      if (after_bridge->specific) {
         goto_failed = ast_explicit_goto(chan, after_bridge->context,
            after_bridge->exten, after_bridge->priority);
      } else if (!ast_strlen_zero(after_bridge->parseable_goto)) {
         char *context;
         char *exten;
         int priority;

         /* Option F(x) for Bridge(), Dial(), and Queue() */

         /* Save current dialplan location in case of failure. */
         context = ast_strdupa(ast_channel_context(chan));
         exten = ast_strdupa(ast_channel_exten(chan));
         priority = ast_channel_priority(chan);

         /* Set current dialplan position to default dialplan position */
         ast_explicit_goto(chan, after_bridge->context, after_bridge->exten,
            after_bridge->priority);

         /* Then perform the goto */
         goto_failed = ast_parseable_goto(chan, after_bridge->parseable_goto);
         if (goto_failed) {
            /* Restore original dialplan location. */
            ast_channel_context_set(chan, context);
            ast_channel_exten_set(chan, exten);
            ast_channel_priority_set(chan, priority);
         }
      } else {
         /* Option F() for Bridge(), Dial(), and Queue() */
         goto_failed = ast_goto_if_exists(chan, after_bridge->context,
            after_bridge->exten, after_bridge->priority + 1);
      }
      if (!goto_failed) {
         if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_IN_AUTOLOOP)) {
            ast_channel_priority_set(chan, ast_channel_priority(chan) + 1);
         }

         ast_debug(1, "Setup after bridge goto location to %s,%s,%d.\n",
            ast_channel_context(chan),
            ast_channel_exten(chan),
            ast_channel_priority(chan));
      }
   }

   /* Discard after bridge goto datastore. */
   ast_datastore_free(datastore);

   return goto_failed;
}