Asterisk - The Open Source Telephony Project  18.5.0
Data Structures | Macros | Typedefs | Enumerations | Functions
bridge_features.h File Reference

Channel Bridging API. More...

#include "asterisk/channel.h"
Include dependency graph for bridge_features.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_bridge_features
 Structure that contains features information. More...
 
struct  ast_bridge_features_attended_transfer
 Structure that contains configuration information for the attended transfer built in feature. More...
 
struct  ast_bridge_features_automixmonitor
 
struct  ast_bridge_features_automonitor
 
struct  ast_bridge_features_blind_transfer
 Structure that contains configuration information for the blind transfer built in feature. More...
 
struct  ast_bridge_features_limits
 Structure that contains configuration information for the limits feature. More...
 
struct  ast_bridge_hook
 Structure that is the essence of a feature hook. More...
 
struct  ast_bridge_hook_dtmf
 
struct  ast_bridge_hook_dtmf_parms
 
struct  ast_bridge_hook_timer
 
struct  ast_bridge_hook_timer_parms
 

Macros

#define MAXIMUM_DTMF_FEATURE_STRING   (11 + 1)
 Maximum length of a DTMF feature string. More...
 

Typedefs

typedef int(* ast_bridge_builtin_set_limits_fn) (struct ast_bridge_features *features, struct ast_bridge_features_limits *limits, enum ast_bridge_hook_remove_flags remove_flags)
 Attach interval hooks to a bridge features structure. More...
 
typedef int(* ast_bridge_hook_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt)
 Hook callback type. More...
 
typedef void(* ast_bridge_hook_pvt_destructor) (void *hook_pvt)
 Hook pvt destructor callback. More...
 
typedef int(* ast_bridge_move_indicate_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt, struct ast_bridge *src, struct ast_bridge *dst)
 Move indicator callback. More...
 
typedef int(* ast_bridge_talking_indicate_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt, int talking)
 Talking indicator callback. More...
 

Enumerations

enum  ast_bridge_builtin_feature {
  AST_BRIDGE_BUILTIN_BLINDTRANSFER, AST_BRIDGE_BUILTIN_ATTENDEDTRANSFER, AST_BRIDGE_BUILTIN_HANGUP, AST_BRIDGE_BUILTIN_PARKCALL,
  AST_BRIDGE_BUILTIN_AUTOMON, AST_BRIDGE_BUILTIN_AUTOMIXMON, AST_BRIDGE_BUILTIN_END
}
 Built in DTMF features. More...
 
enum  ast_bridge_builtin_interval { AST_BRIDGE_BUILTIN_INTERVAL_LIMITS, AST_BRIDGE_BUILTIN_INTERVAL_END }
 
enum  ast_bridge_channel_feature_flags { AST_BRIDGE_CHANNEL_FLAG_DISSOLVE_HANGUP = (1 << 0), AST_BRIDGE_CHANNEL_FLAG_LONELY = (1 << 1), AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE = (1 << 2) }
 Flags used for per bridge channel features. More...
 
enum  ast_bridge_feature_flags {
  AST_BRIDGE_FLAG_DISSOLVE_HANGUP = (1 << 0), AST_BRIDGE_FLAG_DISSOLVE_EMPTY = (1 << 1), AST_BRIDGE_FLAG_SMART = (1 << 2), AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM = (1 << 3),
  AST_BRIDGE_FLAG_MERGE_INHIBIT_TO = (1 << 4), AST_BRIDGE_FLAG_SWAP_INHIBIT_FROM = (1 << 5), AST_BRIDGE_FLAG_SWAP_INHIBIT_TO = (1 << 6), AST_BRIDGE_FLAG_MASQUERADE_ONLY = (1 << 7),
  AST_BRIDGE_FLAG_TRANSFER_PROHIBITED = (1 << 8), AST_BRIDGE_FLAG_TRANSFER_BRIDGE_ONLY = (1 << 9), AST_BRIDGE_FLAG_INVISIBLE = (1 << 10)
}
 Flags used for bridge features. More...
 
enum  ast_bridge_features_monitor { AUTO_MONITOR_TOGGLE, AUTO_MONITOR_START, AUTO_MONITOR_STOP }
 
enum  ast_bridge_hook_remove_flags { AST_BRIDGE_HOOK_REMOVE_ON_PULL = (1 << 0), AST_BRIDGE_HOOK_REMOVE_ON_PERSONALITY_CHANGE = (1 << 1) }
 
enum  ast_bridge_hook_timer_option { AST_BRIDGE_HOOK_TIMER_OPTION_MEDIA = (1 << 0) }
 
enum  ast_bridge_hook_type {
  AST_BRIDGE_HOOK_TYPE_NONE, AST_BRIDGE_HOOK_TYPE_DTMF, AST_BRIDGE_HOOK_TYPE_TIMER, AST_BRIDGE_HOOK_TYPE_HANGUP,
  AST_BRIDGE_HOOK_TYPE_JOIN, AST_BRIDGE_HOOK_TYPE_LEAVE, AST_BRIDGE_HOOK_TYPE_TALK, AST_BRIDGE_HOOK_TYPE_MOVE
}
 

Functions

int ast_bridge_dtmf_hook (struct ast_bridge_features *features, const char *dtmf, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach a DTMF hook to a bridge features structure. More...
 
void ast_bridge_features_cleanup (struct ast_bridge_features *features)
 Clean up the contents of a bridge features structure. More...
 
void ast_bridge_features_destroy (struct ast_bridge_features *features)
 Destroy an allocated bridge features struct. More...
 
int ast_bridge_features_do (enum ast_bridge_builtin_feature feature, struct ast_bridge_channel *bridge_channel, void *hook_pvt)
 Invoke a built in feature hook now. More...
 
int ast_bridge_features_enable (struct ast_bridge_features *features, enum ast_bridge_builtin_feature feature, const char *dtmf, void *config, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Enable a built in feature on a bridge features structure. More...
 
int ast_bridge_features_init (struct ast_bridge_features *features)
 Initialize bridge features structure. More...
 
int ast_bridge_features_limits_construct (struct ast_bridge_features_limits *limits)
 Constructor function for ast_bridge_features_limits. More...
 
void ast_bridge_features_limits_destroy (struct ast_bridge_features_limits *limits)
 Destructor function for ast_bridge_features_limits. More...
 
void ast_bridge_features_merge (struct ast_bridge_features *into, const struct ast_bridge_features *from)
 Merge one ast_bridge_features into another. More...
 
struct ast_bridge_featuresast_bridge_features_new (void)
 Allocate a new bridge features struct. More...
 
int ast_bridge_features_register (enum ast_bridge_builtin_feature feature, ast_bridge_hook_callback callback, const char *dtmf)
 Register a handler for a built in feature. More...
 
void ast_bridge_features_set_flag (struct ast_bridge_features *features, unsigned int flag)
 Set a flag on a bridge channel features structure. More...
 
int ast_bridge_features_set_limits (struct ast_bridge_features *features, struct ast_bridge_features_limits *limits, enum ast_bridge_hook_remove_flags remove_flags)
 Limit the amount of time a channel may stay in the bridge and optionally play warning messages as time runs out. More...
 
int ast_bridge_features_unregister (enum ast_bridge_builtin_feature feature)
 Unregister a handler for a built in feature. More...
 
int ast_bridge_hangup_hook (struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach a hangup hook to a bridge features structure. More...
 
int ast_bridge_interval_hook (struct ast_bridge_features *features, enum ast_bridge_hook_timer_option flags, unsigned int interval, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach an interval hook to a bridge features structure. More...
 
int ast_bridge_interval_register (enum ast_bridge_builtin_interval interval, ast_bridge_builtin_set_limits_fn callback)
 Register a handler for a built in interval feature. More...
 
int ast_bridge_join_hook (struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Unregisters a handler for a built in interval feature. More...
 
int ast_bridge_leave_hook (struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach a bridge channel leave hook to a bridge features structure. More...
 
int ast_bridge_move_hook (struct ast_bridge_features *features, ast_bridge_move_indicate_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach a bridge channel move detection hook to a bridge features structure. More...
 
int ast_bridge_talk_detector_hook (struct ast_bridge_features *features, ast_bridge_talking_indicate_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
 Attach a bridge channel talk detection hook to a bridge features structure. More...
 

Detailed Description

Channel Bridging API.

Author
Joshua Colp jcolp[email protected]@dig[email protected]ium.c[email protected]om

Definition in file bridge_features.h.

Macro Definition Documentation

◆ MAXIMUM_DTMF_FEATURE_STRING

#define MAXIMUM_DTMF_FEATURE_STRING   (11 + 1)

Maximum length of a DTMF feature string.

Definition at line 217 of file bridge_features.h.

Referenced by action_playback_and_continue().

Typedef Documentation

◆ ast_bridge_builtin_set_limits_fn

typedef int(* ast_bridge_builtin_set_limits_fn) (struct ast_bridge_features *features, struct ast_bridge_features_limits *limits, enum ast_bridge_hook_remove_flags remove_flags)

Attach interval hooks to a bridge features structure.

Parameters
featuresBridge features structure
limitsConfigured limits applicable to the channel
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure

Definition at line 422 of file bridge_features.h.

◆ ast_bridge_hook_callback

typedef int(* ast_bridge_hook_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt)

Hook callback type.

Parameters
bridge_channelChannel executing the feature
hook_pvtPrivate data passed in when the hook was created

For interval hooks:

Return values
0Setup to fire again at the last interval.
positiveSetup to fire again at the new interval returned.
-1Remove the callback hook.

For other hooks:

Return values
0Keep the callback hook.
-1Remove the callback hook.

Definition at line 136 of file bridge_features.h.

◆ ast_bridge_hook_pvt_destructor

typedef void(* ast_bridge_hook_pvt_destructor) (void *hook_pvt)

Hook pvt destructor callback.

Parameters
hook_pvtPrivate data passed in when the hook was created to destroy

Definition at line 143 of file bridge_features.h.

◆ ast_bridge_move_indicate_callback

typedef int(* ast_bridge_move_indicate_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt, struct ast_bridge *src, struct ast_bridge *dst)

Move indicator callback.

This callback can be registered with the bridge channel in order to be notified when the bridge channel is being moved from one bridge to another.

Parameters
bridge_channelThe channel executing the feature
hook_pvtPrivate data passed in when the hook was created
srcThe bridge from which the bridge channel is moving
dstThe bridge into which the bridge channel is moving
Return values
0Keep the callback hook.
-1Remove the callback hook.

Definition at line 178 of file bridge_features.h.

◆ ast_bridge_talking_indicate_callback

typedef int(* ast_bridge_talking_indicate_callback) (struct ast_bridge_channel *bridge_channel, void *hook_pvt, int talking)

Talking indicator callback.

This callback can be registered with the bridge channel in order to receive updates when the bridge_channel has started and stopped talking.

Parameters
bridge_channelChannel executing the feature
hook_pvtPrivate data passed in when the hook was created
talkingTRUE if the channel is now talking
Return values
0Keep the callback hook.
-1Remove the callback hook.

Definition at line 160 of file bridge_features.h.

Enumeration Type Documentation

◆ ast_bridge_builtin_feature

Built in DTMF features.

Enumerator
AST_BRIDGE_BUILTIN_BLINDTRANSFER 

DTMF based Blind Transfer

AST_BRIDGE_BUILTIN_ATTENDEDTRANSFER 

DTMF based Attended Transfer

AST_BRIDGE_BUILTIN_HANGUP 

DTMF based depart bridge feature

Note
Imparted channels are optionally hangup depending upon how it was imparted.
Joined channels exit the bridge with BRIDGE_CHANNEL_STATE_END_WITH_DISSOLVE.
AST_BRIDGE_BUILTIN_PARKCALL 

DTMF based Park

The bridge is parked and the channel hears the parking slot to which it was parked.

AST_BRIDGE_BUILTIN_AUTOMON 

DTMF one-touch-record toggle using Monitor app.

Note
Only valid on two party bridges.
AST_BRIDGE_BUILTIN_AUTOMIXMON 

DTMF one-touch-record toggle using MixMonitor app.

Note
Only valid on two party bridges.
AST_BRIDGE_BUILTIN_END 

End terminator for list of built in features. Must remain last.

Definition at line 71 of file bridge_features.h.

71  {
72  /*! DTMF based Blind Transfer */
74  /*! DTMF based Attended Transfer */
76  /*!
77  * DTMF based depart bridge feature
78  *
79  * \note Imparted channels are optionally hangup depending upon
80  * how it was imparted.
81  *
82  * \note Joined channels exit the bridge with
83  * BRIDGE_CHANNEL_STATE_END_WITH_DISSOLVE.
84  */
86  /*!
87  * DTMF based Park
88  *
89  * \details The bridge is parked and the channel hears the
90  * parking slot to which it was parked.
91  */
93  /*!
94  * DTMF one-touch-record toggle using Monitor app.
95  *
96  * \note Only valid on two party bridges.
97  */
99  /*!
100  * DTMF one-touch-record toggle using MixMonitor app.
101  *
102  * \note Only valid on two party bridges.
103  */
105 
106  /*! End terminator for list of built in features. Must remain last. */
108 };

◆ ast_bridge_builtin_interval

Enumerator
AST_BRIDGE_BUILTIN_INTERVAL_LIMITS 

Apply Call Duration Limits

AST_BRIDGE_BUILTIN_INTERVAL_END 

End terminator for list of built in interval features. Must remain last.

Definition at line 110 of file bridge_features.h.

110  {
111  /*! Apply Call Duration Limits */
113 
114  /*! End terminator for list of built in interval features. Must remain last. */
116 };

◆ ast_bridge_channel_feature_flags

Flags used for per bridge channel features.

Enumerator
AST_BRIDGE_CHANNEL_FLAG_DISSOLVE_HANGUP 

Upon channel hangup all bridge participants should be kicked out.

AST_BRIDGE_CHANNEL_FLAG_LONELY 

This channel leaves the bridge if all participants have this flag set.

AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE 

This channel cannot be moved to another bridge.

Definition at line 61 of file bridge_features.h.

61  {
62  /*! Upon channel hangup all bridge participants should be kicked out. */
64  /*! This channel leaves the bridge if all participants have this flag set. */
66  /*! This channel cannot be moved to another bridge. */
68 };

◆ ast_bridge_feature_flags

Flags used for bridge features.

Enumerator
AST_BRIDGE_FLAG_DISSOLVE_HANGUP 

Upon channel hangup all bridge participants should be kicked out.

AST_BRIDGE_FLAG_DISSOLVE_EMPTY 

The last channel to leave the bridge dissolves it.

AST_BRIDGE_FLAG_SMART 

Move between bridging technologies as needed.

AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM 

Bridge channels cannot be merged from this bridge.

AST_BRIDGE_FLAG_MERGE_INHIBIT_TO 

Bridge channels cannot be merged to this bridge.

AST_BRIDGE_FLAG_SWAP_INHIBIT_FROM 

Bridge channels cannot be local channel swap optimized from this bridge.

AST_BRIDGE_FLAG_SWAP_INHIBIT_TO 

Bridge channels cannot be local channel swap optimized to this bridge.

AST_BRIDGE_FLAG_MASQUERADE_ONLY 

Bridge channels can be moved to another bridge only by masquerade (ConfBridge)

AST_BRIDGE_FLAG_TRANSFER_PROHIBITED 

Bridge does not allow transfers of channels out

AST_BRIDGE_FLAG_TRANSFER_BRIDGE_ONLY 

Bridge transfers require transfer of entire bridge rather than individual channels

AST_BRIDGE_FLAG_INVISIBLE 

Bridge is invisible to AMI/CLI/ARI/etc.

Definition at line 35 of file bridge_features.h.

35  {
36  /*! Upon channel hangup all bridge participants should be kicked out. */
38  /*! The last channel to leave the bridge dissolves it. */
40  /*! Move between bridging technologies as needed. */
41  AST_BRIDGE_FLAG_SMART = (1 << 2),
42  /*! Bridge channels cannot be merged from this bridge. */
44  /*! Bridge channels cannot be merged to this bridge. */
46  /*! Bridge channels cannot be local channel swap optimized from this bridge. */
48  /*! Bridge channels cannot be local channel swap optimized to this bridge. */
50  /*! Bridge channels can be moved to another bridge only by masquerade (ConfBridge) */
52  /*! Bridge does not allow transfers of channels out */
54  /*! Bridge transfers require transfer of entire bridge rather than individual channels */
56  /*! Bridge is invisible to AMI/CLI/ARI/etc. */
57  AST_BRIDGE_FLAG_INVISIBLE = (1 << 10),
58 };

◆ ast_bridge_features_monitor

Enumerator
AUTO_MONITOR_TOGGLE 

Toggle start/stop of Monitor/MixMonitor.

AUTO_MONITOR_START 

Start Monitor/MixMonitor if not already started.

AUTO_MONITOR_STOP 

Stop Monitor/MixMonitor if not already stopped.

Definition at line 310 of file bridge_features.h.

310  {
311  /*! Toggle start/stop of Monitor/MixMonitor. */
313  /*! Start Monitor/MixMonitor if not already started. */
315  /*! Stop Monitor/MixMonitor if not already stopped. */
317 };

◆ ast_bridge_hook_remove_flags

Enumerator
AST_BRIDGE_HOOK_REMOVE_ON_PULL 

The hook is removed when the channel is pulled from the bridge.

AST_BRIDGE_HOOK_REMOVE_ON_PERSONALITY_CHANGE 

The hook is removed when the bridge's personality changes.

Definition at line 181 of file bridge_features.h.

181  {
182  /*! The hook is removed when the channel is pulled from the bridge. */
184  /*! The hook is removed when the bridge's personality changes. */
186 };

◆ ast_bridge_hook_timer_option

Enumerator
AST_BRIDGE_HOOK_TIMER_OPTION_MEDIA 

The timer temporarily affects media. (Like a custom playfile.)

Definition at line 233 of file bridge_features.h.

233  {
234  /*! The timer temporarily affects media. (Like a custom playfile.) */
236 };

◆ ast_bridge_hook_type

Enumerator
AST_BRIDGE_HOOK_TYPE_NONE 

The hook type has not been specified.

AST_BRIDGE_HOOK_TYPE_DTMF 
AST_BRIDGE_HOOK_TYPE_TIMER 
AST_BRIDGE_HOOK_TYPE_HANGUP 
AST_BRIDGE_HOOK_TYPE_JOIN 
AST_BRIDGE_HOOK_TYPE_LEAVE 
AST_BRIDGE_HOOK_TYPE_TALK 
AST_BRIDGE_HOOK_TYPE_MOVE 

Definition at line 188 of file bridge_features.h.

Function Documentation

◆ ast_bridge_dtmf_hook()

int ast_bridge_dtmf_hook ( struct ast_bridge_features features,
const char *  dtmf,
ast_bridge_hook_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach a DTMF hook to a bridge features structure.

Parameters
featuresBridge features structure
dtmfDTMF string to be activated upon
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)

Example usage:

struct ast_bridge_features features;
ast_bridge_dtmf_hook(&features, "#", pound_callback, NULL, NULL, 0);

This makes the bridging core call pound_callback if a channel that has this feature structure inputs the DTMF string '#'. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3245 of file bridge.c.

References ao2_link, ao2_ref, AST_BRIDGE_HOOK_TYPE_DTMF, ast_copy_string(), bridge_hook_generic(), ast_bridge_hook_dtmf_parms::code, ast_bridge_hook::destructor, ast_bridge_hook_dtmf::dtmf, ast_bridge_features::dtmf_hooks, ast_bridge_hook_dtmf::generic, NULL, and ast_bridge_hook::type.

Referenced by apply_menu_to_user(), ast_bridge_features_enable(), AST_TEST_DEFINE(), bridge_agent_hold_push(), bridge_personality_atxfer_push(), and dynamic_dtmf_hook_add().

3251 {
3252  struct ast_bridge_hook_dtmf *hook;
3253  int res;
3254 
3255  /* Allocate new hook and setup it's various variables */
3256  hook = (struct ast_bridge_hook_dtmf *) bridge_hook_generic(sizeof(*hook), callback,
3257  hook_pvt, destructor, remove_flags);
3258  if (!hook) {
3259  return -1;
3260  }
3262  ast_copy_string(hook->dtmf.code, dtmf, sizeof(hook->dtmf.code));
3263 
3264  /* Once done we put it in the container. */
3265  res = ao2_link(features->dtmf_hooks, hook) ? 0 : -1;
3266  if (res) {
3267  /*
3268  * Could not link the hook into the container.
3269  *
3270  * Remove the hook_pvt destructor call from the hook since we
3271  * are returning failure to install the hook.
3272  */
3273  hook->generic.destructor = NULL;
3274  }
3275  ao2_ref(hook, -1);
3276 
3277  return res;
3278 }
static struct ast_bridge_hook * bridge_hook_generic(size_t size, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
Definition: bridge.c:3225
ast_bridge_hook_pvt_destructor destructor
struct ao2_container * dtmf_hooks
#define NULL
Definition: resample.c:96
enum ast_bridge_hook_type type
#define ao2_ref(o, delta)
Definition: astobj2.h:464
struct ast_bridge_hook_dtmf_parms dtmf
struct ast_bridge_hook generic
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
char code[MAXIMUM_DTMF_FEATURE_STRING]
#define ao2_link(container, obj)
Definition: astobj2.h:1549

◆ ast_bridge_features_cleanup()

void ast_bridge_features_cleanup ( struct ast_bridge_features features)

Clean up the contents of a bridge features structure.

Parameters
featuresBridge features structure
Returns
Nothing

Example usage:

This cleans up the feature structure 'features'.

Note
This MUST be called after the features structure is done being used or a memory leak may occur.

Definition at line 3720 of file bridge.c.

References ao2_cleanup, ao2_ref, ast_heap_destroy(), ast_heap_pop(), ast_bridge_features::dtmf_hooks, ast_bridge_features::interval_hooks, NULL, and ast_bridge_features::other_hooks.

Referenced by agent_request_exec(), agent_run(), ast_bridge_call_with_flags(), ast_bridge_features_destroy(), AST_TEST_DEFINE(), bridge_exec(), bridgeadd_exec(), bridgewait_exec(), channel_feature_hooks_set_full(), confbridge_exec(), park_and_announce_app_exec(), park_app_exec(), and parked_call_app_exec().

3721 {
3722  struct ast_bridge_hook_timer *hook;
3723 
3724  /* Destroy the interval hooks heap. */
3725  if (features->interval_hooks) {
3726  while ((hook = ast_heap_pop(features->interval_hooks))) {
3727  ao2_ref(hook, -1);
3728  }
3729  features->interval_hooks = ast_heap_destroy(features->interval_hooks);
3730  }
3731 
3732  /* Destroy the miscellaneous other hooks container. */
3733  ao2_cleanup(features->other_hooks);
3734  features->other_hooks = NULL;
3735 
3736  /* Destroy the DTMF hooks container. */
3737  ao2_cleanup(features->dtmf_hooks);
3738  features->dtmf_hooks = NULL;
3739 }
struct ast_heap * ast_heap_destroy(struct ast_heap *h)
Destroy a max heap.
Definition: heap.c:146
struct ao2_container * dtmf_hooks
#define NULL
Definition: resample.c:96
void * ast_heap_pop(struct ast_heap *h)
Pop the max element off of the heap.
Definition: heap.c:262
#define ao2_ref(o, delta)
Definition: astobj2.h:464
struct ast_heap * interval_hooks
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
struct ao2_container * other_hooks

◆ ast_bridge_features_destroy()

void ast_bridge_features_destroy ( struct ast_bridge_features features)

Destroy an allocated bridge features struct.

Since
12.0.0
Parameters
featuresBridge features structure

Example usage:

Returns
Nothing

Definition at line 3741 of file bridge.c.

References ast_bridge_features_cleanup(), and ast_free.

Referenced by ast_bridge_add_channel(), ast_bridge_call_with_flags(), ast_bridge_features_new(), ast_local_setup_bridge(), bridge_channel_depart_thread(), bridge_channel_ind_thread(), bridge_exec(), bridge_impart_internal(), conf_start_record(), control_dtor(), features_destroy(), and local_pvt_destructor().

3742 {
3743  if (!features) {
3744  return;
3745  }
3746  ast_bridge_features_cleanup(features);
3747  ast_free(features);
3748 }
#define ast_free(a)
Definition: astmm.h:182
void ast_bridge_features_cleanup(struct ast_bridge_features *features)
Clean up the contents of a bridge features structure.
Definition: bridge.c:3720

◆ ast_bridge_features_do()

int ast_bridge_features_do ( enum ast_bridge_builtin_feature  feature,
struct ast_bridge_channel bridge_channel,
void *  hook_pvt 
)

Invoke a built in feature hook now.

Parameters
featureThe feature to invoke
bridge_channelChannel executing the feature
hook_pvtPrivate data passed in when the hook was created
Note
This API call is only meant to be used by bridge subclasses and hook callbacks to request a builtin feature hook to be executed.
Return values
0on success
-1on failure

Example usage:

ast_bridge_features_do(AST_BRIDGE_BUILTIN_ATTENDED_TRANSFER, bridge_channel, hook_pvt);

Definition at line 3151 of file bridge.c.

References ARRAY_LEN, and builtin_features_handlers.

Referenced by agent_connect_caller().

3152 {
3153  ast_bridge_hook_callback callback;
3154 
3155  if (ARRAY_LEN(builtin_features_handlers) <= feature) {
3156  return -1;
3157  }
3158 
3159  callback = builtin_features_handlers[feature];
3160  if (!callback) {
3161  return -1;
3162  }
3163  callback(bridge_channel, hook_pvt);
3164 
3165  return 0;
3166 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static ast_bridge_hook_callback builtin_features_handlers[AST_BRIDGE_BUILTIN_END]
Definition: bridge.c:147
int(* ast_bridge_hook_callback)(struct ast_bridge_channel *bridge_channel, void *hook_pvt)
Hook callback type.

◆ ast_bridge_features_enable()

int ast_bridge_features_enable ( struct ast_bridge_features features,
enum ast_bridge_builtin_feature  feature,
const char *  dtmf,
void *  config,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Enable a built in feature on a bridge features structure.

Parameters
featuresBridge features structure
featureFeature to enable
dtmfOptionally the DTMF stream to trigger the feature, if not specified it will be the default
configConfiguration structure unique to the built in type
destructorOptional destructor callback for config data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure

Example usage:

This enables the attended transfer DTMF option using the default DTMF string. An alternate string may be provided using the dtmf parameter. Internally this is simply setting up a hook to a built in feature callback function.

Definition at line 3428 of file bridge.c.

References ARRAY_LEN, ast_bridge_dtmf_hook(), ast_debug, ast_strlen_zero, builtin_features_dtmf, and builtin_features_handlers.

Referenced by builtin_features_helper().

3434 {
3435  if (ARRAY_LEN(builtin_features_handlers) <= feature
3436  || !builtin_features_handlers[feature]) {
3437  return -1;
3438  }
3439 
3440  /* If no alternate DTMF stream was provided use the default one */
3441  if (ast_strlen_zero(dtmf)) {
3442  dtmf = builtin_features_dtmf[feature];
3443  /* If no DTMF is still available (ie: it has been disabled) then error out now */
3444  if (ast_strlen_zero(dtmf)) {
3445  ast_debug(1, "Failed to enable built in feature %u on %p, no DTMF string is available for it.\n",
3446  feature, features);
3447  return -1;
3448  }
3449  }
3450 
3451  /*
3452  * The rest is basically pretty easy. We create another hook
3453  * using the built in feature's DTMF callback. Easy as pie.
3454  */
3455  return ast_bridge_dtmf_hook(features, dtmf, builtin_features_handlers[feature],
3456  config, destructor, remove_flags);
3457 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char * config
Definition: conf2ael.c:66
static ast_bridge_hook_callback builtin_features_handlers[AST_BRIDGE_BUILTIN_END]
Definition: bridge.c:147
static char builtin_features_dtmf[AST_BRIDGE_BUILTIN_END][MAXIMUM_DTMF_FEATURE_STRING]
Definition: bridge.c:144
#define ast_strlen_zero(foo)
Definition: strings.h:52
int ast_bridge_dtmf_hook(struct ast_bridge_features *features, const char *dtmf, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
Attach a DTMF hook to a bridge features structure.
Definition: bridge.c:3245
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:452

◆ ast_bridge_features_init()

int ast_bridge_features_init ( struct ast_bridge_features features)

Initialize bridge features structure.

Parameters
featuresBridge featues structure
Return values
0on success
-1on failure

Example usage:

struct ast_bridge_features features;

This initializes the feature structure 'features' to have nothing enabled.

Note
This MUST be called before enabling features or flags. Failure to do so may result in a crash.

Definition at line 3687 of file bridge.c.

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_list, AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, ast_heap_create, bridge_dtmf_hook_sort(), ast_bridge_features::dtmf_hooks, ast_bridge_features::dtmf_passthrough, interval_hook_time_cmp(), ast_bridge_features::interval_hooks, NULL, ast_bridge_features::other_hooks, ast_bridge_features::text_messaging, and timer.

Referenced by agent_request_exec(), agent_run(), ast_bridge_call_with_flags(), ast_bridge_features_new(), AST_TEST_DEFINE(), bridge_exec(), bridgeadd_exec(), bridgewait_exec(), channel_feature_hooks_set_full(), confbridge_exec(), park_and_announce_app_exec(), park_app_exec(), and parked_call_app_exec().

3688 {
3689  /* Zero out the structure */
3690  memset(features, 0, sizeof(*features));
3691 
3692  /* Initialize the DTMF hooks container */
3695  if (!features->dtmf_hooks) {
3696  return -1;
3697  }
3698 
3699  /* Initialize the miscellaneous other hooks container */
3701  NULL);
3702  if (!features->other_hooks) {
3703  return -1;
3704  }
3705 
3706  /* Initialize the interval hooks heap */
3708  offsetof(struct ast_bridge_hook_timer, timer.heap_index));
3709  if (!features->interval_hooks) {
3710  return -1;
3711  }
3712 
3713  features->dtmf_passthrough = 1;
3714  features->text_messaging = 1;
3715 
3716  return 0;
3717 }
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Definition: astobj2.h:1335
static int bridge_dtmf_hook_sort(const void *obj_left, const void *obj_right, int flags)
Definition: bridge.c:3606
struct ao2_container * dtmf_hooks
#define NULL
Definition: resample.c:96
unsigned int text_messaging
struct ast_heap * interval_hooks
unsigned int dtmf_passthrough
static int interval_hook_time_cmp(void *a, void *b)
Definition: bridge.c:3575
#define ast_heap_create(init_height, cmp_fn, index_offset)
Definition: heap.h:102
Replace objects with duplicate keys in container.
Definition: astobj2.h:1215
struct ao2_container * other_hooks
static struct ast_timer * timer
Definition: chan_iax2.c:360

◆ ast_bridge_features_limits_construct()

int ast_bridge_features_limits_construct ( struct ast_bridge_features_limits limits)

Constructor function for ast_bridge_features_limits.

Parameters
limitspointer to a ast_bridge_features_limits struct that has been allocted, but not initialized
Return values
0on success
-1on failure

Definition at line 3459 of file bridge.c.

References ast_string_field_init.

Referenced by bridge_builtin_set_limits(), and pre_bridge_setup().

3460 {
3461  memset(limits, 0, sizeof(*limits));
3462 
3463  if (ast_string_field_init(limits, 256)) {
3464  return -1;
3465  }
3466 
3467  return 0;
3468 }
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:353

◆ ast_bridge_features_limits_destroy()

void ast_bridge_features_limits_destroy ( struct ast_bridge_features_limits limits)

Destructor function for ast_bridge_features_limits.

Parameters
limitspointer to an ast_bridge_features_limits struct that needs to be destroyed

This function does not free memory allocated to the ast_bridge_features_limits struct, it only frees elements within the struct. You must still call ast_free on the struct if you allocated it with malloc.

Definition at line 3470 of file bridge.c.

References ast_string_field_free_memory.

Referenced by bridge_features_limits_dtor(), and pre_bridge_setup().

3471 {
3473 }
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:368

◆ ast_bridge_features_merge()

void ast_bridge_features_merge ( struct ast_bridge_features into,
const struct ast_bridge_features from 
)

Merge one ast_bridge_features into another.

Parameters
intoThe ast_bridge_features that will be merged into
fromThe ast_bridge_features that will be merged from

Definition at line 3662 of file bridge.c.

References ao2_callback, ast_heap_peek(), ast_heap_unlock, ast_heap_wrlock, ast_bridge_features::dtmf_hooks, ast_bridge_features::dtmf_passthrough, ast_bridge_features::feature_flags, ast_flags::flags, ast_bridge_features::interval_hooks, merge_container_cb(), ast_bridge_features::mute, ast_bridge_features::other_hooks, ast_bridge_features::usable, and wrap_hook().

Referenced by bridge_channel_internal_join(), and channel_feature_hooks_set_full().

3663 {
3664  struct ast_bridge_hook_timer *hook;
3665  int idx;
3666 
3667  /* Merge hook containers */
3670 
3671  /* Merge hook heaps */
3673  for (idx = 1; (hook = ast_heap_peek(from->interval_hooks, idx)); idx++) {
3674  wrap_hook(into, hook);
3675  }
3677 
3678  /* Merge feature flags */
3679  into->feature_flags.flags |= from->feature_flags.flags;
3680  into->usable |= from->usable;
3681 
3682  into->mute |= from->mute;
3683  into->dtmf_passthrough |= from->dtmf_passthrough;
3684 }
#define ast_heap_unlock(h)
Definition: heap.h:248
#define ao2_callback(c, flags, cb_fn, arg)
Definition: astobj2.h:1716
unsigned int flags
Definition: utils.h:200
struct ao2_container * dtmf_hooks
static int merge_container_cb(void *obj, void *data, int flags)
Callback for merging hook ao2_containers.
Definition: bridge.c:3629
struct ast_flags feature_flags
struct ast_heap * interval_hooks
unsigned int dtmf_passthrough
static void wrap_hook(struct ast_bridge_features *features, struct ast_bridge_hook_timer *hook)
Wrap the provided interval hook and add it to features.
Definition: bridge.c:3650
struct ao2_container * other_hooks
void * ast_heap_peek(struct ast_heap *h, unsigned int index)
Peek at an element on a heap.
Definition: heap.c:267
#define ast_heap_wrlock(h)
Definition: heap.h:246

◆ ast_bridge_features_new()

struct ast_bridge_features* ast_bridge_features_new ( void  )

Allocate a new bridge features struct.

Since
12.0.0

Example usage:

Return values
featuresNew allocated features struct.
NULLon error.

Definition at line 3750 of file bridge.c.

References ast_bridge_features_destroy(), ast_bridge_features_init(), ast_malloc, and NULL.

Referenced by ast_bridge_call_with_flags(), ast_unreal_channel_push_to_bridge(), bridge_exec(), bridge_impart_internal(), channel_feature_hooks_set_full(), conf_announce_channel_push(), conf_start_record(), and stasis_app_control_bridge_features_init().

3751 {
3752  struct ast_bridge_features *features;
3753 
3754  features = ast_malloc(sizeof(*features));
3755  if (features) {
3756  if (ast_bridge_features_init(features)) {
3757  ast_bridge_features_destroy(features);
3758  features = NULL;
3759  }
3760  }
3761 
3762  return features;
3763 }
Structure that contains features information.
#define NULL
Definition: resample.c:96
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:193
int ast_bridge_features_init(struct ast_bridge_features *features)
Initialize bridge features structure.
Definition: bridge.c:3687
void ast_bridge_features_destroy(struct ast_bridge_features *features)
Destroy an allocated bridge features struct.
Definition: bridge.c:3741

◆ ast_bridge_features_register()

int ast_bridge_features_register ( enum ast_bridge_builtin_feature  feature,
ast_bridge_hook_callback  callback,
const char *  dtmf 
)

Register a handler for a built in feature.

Parameters
featureThe feature that the handler will be responsible for
callbackThe callback function that will handle it
dtmfDefault DTMF string used to activate the feature
Return values
0on success
-1on failure

Example usage:

ast_bridge_features_register(AST_BRIDGE_BUILTIN_ATTENDED_TRANSFER, bridge_builtin_attended_transfer, "*1");

This registers the function bridge_builtin_attended_transfer as the function responsible for the built in attended transfer feature.

Definition at line 3123 of file bridge.c.

References ARRAY_LEN, ast_copy_string(), ast_strlen_zero, builtin_features_dtmf, and builtin_features_handlers.

Referenced by ast_bridging_init_basic(), load_module(), and load_parking_bridge_features().

3124 {
3125  if (ARRAY_LEN(builtin_features_handlers) <= feature
3126  || builtin_features_handlers[feature]) {
3127  return -1;
3128  }
3129 
3130  if (!ast_strlen_zero(dtmf)) {
3131  ast_copy_string(builtin_features_dtmf[feature], dtmf, sizeof(builtin_features_dtmf[feature]));
3132  }
3133 
3134  builtin_features_handlers[feature] = callback;
3135 
3136  return 0;
3137 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static ast_bridge_hook_callback builtin_features_handlers[AST_BRIDGE_BUILTIN_END]
Definition: bridge.c:147
static char builtin_features_dtmf[AST_BRIDGE_BUILTIN_END][MAXIMUM_DTMF_FEATURE_STRING]
Definition: bridge.c:144
#define ast_strlen_zero(foo)
Definition: strings.h:52
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401

◆ ast_bridge_features_set_flag()

void ast_bridge_features_set_flag ( struct ast_bridge_features features,
unsigned int  flag 
)

Set a flag on a bridge channel features structure.

Parameters
featuresBridge channel features structure
flagFlag to enable
Returns
Nothing

Example usage:

This sets the AST_BRIDGE_CHANNEL_FLAG_DISSOLVE_HANGUP feature to be enabled on the features structure 'features'.

Definition at line 3490 of file bridge.c.

References ast_set_flag, ast_bridge_features::feature_flags, and ast_bridge_features::usable.

3491 {
3492  ast_set_flag(&features->feature_flags, flag);
3493  features->usable = 1;
3494 }
#define ast_set_flag(p, flag)
Definition: utils.h:70
struct ast_flags feature_flags
long int flag
Definition: f2c.h:83

◆ ast_bridge_features_set_limits()

int ast_bridge_features_set_limits ( struct ast_bridge_features features,
struct ast_bridge_features_limits limits,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Limit the amount of time a channel may stay in the bridge and optionally play warning messages as time runs out.

Parameters
featuresBridge features structure
limitsConfigured limits applicable to the channel
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure

Example usage:

This sets the maximum time the channel can be in the bridge to 10 seconds and does not play any warnings.

Note
This API call can only be used on a features structure that will be used in association with a bridge channel.
The ast_bridge_features_limits structure must remain accessible for the lifetime of the features structure.

Definition at line 3475 of file bridge.c.

References AST_BRIDGE_BUILTIN_INTERVAL_LIMITS, ast_log, builtin_interval_handlers, and LOG_ERROR.

Referenced by pre_bridge_setup().

3478 {
3481 
3483  return callback(features, limits, remove_flags);
3484  }
3485 
3486  ast_log(LOG_ERROR, "Attempted to set limits without an AST_BRIDGE_BUILTIN_INTERVAL_LIMITS callback registered.\n");
3487  return -1;
3488 }
int(* ast_bridge_builtin_set_limits_fn)(struct ast_bridge_features *features, struct ast_bridge_features_limits *limits, enum ast_bridge_hook_remove_flags remove_flags)
Attach interval hooks to a bridge features structure.
static ast_bridge_builtin_set_limits_fn builtin_interval_handlers[AST_BRIDGE_BUILTIN_INTERVAL_END]
Definition: bridge.c:150
#define ast_log
Definition: astobj2.c:42
#define LOG_ERROR
Definition: logger.h:285

◆ ast_bridge_features_unregister()

int ast_bridge_features_unregister ( enum ast_bridge_builtin_feature  feature)

Unregister a handler for a built in feature.

Parameters
featureThe feature to unregister
Return values
0on success
-1on failure

Example usage:

ast_bridge_features_unregister(AST_BRIDGE_BUILTIN_ATTENDED_TRANSFER);

This unregisters the function that is handling the built in attended transfer feature.

Definition at line 3139 of file bridge.c.

References ARRAY_LEN, builtin_features_handlers, and NULL.

Referenced by unload_module(), and unload_parking_bridge_features().

3140 {
3141  if (ARRAY_LEN(builtin_features_handlers) <= feature
3142  || !builtin_features_handlers[feature]) {
3143  return -1;
3144  }
3145 
3146  builtin_features_handlers[feature] = NULL;
3147 
3148  return 0;
3149 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static ast_bridge_hook_callback builtin_features_handlers[AST_BRIDGE_BUILTIN_END]
Definition: bridge.c:147
#define NULL
Definition: resample.c:96

◆ ast_bridge_hangup_hook()

int ast_bridge_hangup_hook ( struct ast_bridge_features features,
ast_bridge_hook_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach a hangup hook to a bridge features structure.

Parameters
featuresBridge features structure
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)

Example usage:

struct ast_bridge_features features;
ast_bridge_hangup_hook(&features, hangup_callback, NULL, NULL, 0);

This makes the bridging core call hangup_callback if a channel that has this hook hangs up. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3328 of file bridge.c.

References AST_BRIDGE_HOOK_TYPE_HANGUP, and bridge_other_hook().

Referenced by add_normal_hooks(), and bridge_personality_atxfer_push().

3333 {
3334  return bridge_other_hook(features, callback, hook_pvt, destructor, remove_flags,
3336 }
static int bridge_other_hook(struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags, enum ast_bridge_hook_type type)
Definition: bridge.c:3294

◆ ast_bridge_interval_hook()

int ast_bridge_interval_hook ( struct ast_bridge_features features,
enum ast_bridge_hook_timer_option  flags,
unsigned int  interval,
ast_bridge_hook_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach an interval hook to a bridge features structure.

Parameters
featuresBridge features structure
flagsInterval timer callback option flags.
intervalThe interval that the hook should execute at in milliseconds
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)
struct ast_bridge_features features;
ast_bridge_interval_hook(&features, 1000, playback_callback, NULL, NULL, 0);

This makes the bridging core call playback_callback every second. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3382 of file bridge.c.

References ao2_ref, ast_atomic_fetchadd_int(), AST_BRIDGE_HOOK_TYPE_TIMER, ast_debug, ast_heap_push, ast_heap_unlock, ast_heap_wrlock, ast_samp2tv(), ast_tvadd(), ast_tvnow(), bridge_hook_generic(), ast_bridge_hook::destructor, ast_bridge_hook_timer_parms::flags, ast_bridge_hook_timer::generic, ast_bridge_hook_timer_parms::interval, ast_bridge_features::interval_hooks, ast_bridge_features::interval_sequence, NULL, ast_bridge_hook_timer_parms::seqno, ast_bridge_hook_timer::timer, ast_bridge_hook_timer_parms::trip_time, and ast_bridge_hook::type.

Referenced by agent_request_exec(), apply_option_timeout(), AST_TEST_DEFINE(), bridge_agent_hold_push(), bridge_builtin_set_limits(), confbridge_exec(), parking_set_duration(), set_interval_hook(), and wrap_hook().

3389 {
3390  struct ast_bridge_hook_timer *hook;
3391  int res;
3392 
3393  if (!features ||!interval || !callback) {
3394  return -1;
3395  }
3396 
3397  /* Allocate new hook and setup it's various variables */
3398  hook = (struct ast_bridge_hook_timer *) bridge_hook_generic(sizeof(*hook), callback,
3399  hook_pvt, destructor, remove_flags);
3400  if (!hook) {
3401  return -1;
3402  }
3404  hook->timer.interval = interval;
3405  hook->timer.trip_time = ast_tvadd(ast_tvnow(), ast_samp2tv(interval, 1000));
3406  hook->timer.seqno = ast_atomic_fetchadd_int((int *) &features->interval_sequence, +1);
3407  hook->timer.flags = flags;
3408 
3409  ast_debug(1, "Putting interval hook %p with interval %u in the heap on features %p\n",
3410  hook, hook->timer.interval, features);
3411  ast_heap_wrlock(features->interval_hooks);
3412  res = ast_heap_push(features->interval_hooks, hook);
3413  ast_heap_unlock(features->interval_hooks);
3414  if (res) {
3415  /*
3416  * Could not push the hook into the heap
3417  *
3418  * Remove the hook_pvt destructor call from the hook since we
3419  * are returning failure to install the hook.
3420  */
3421  hook->generic.destructor = NULL;
3422  ao2_ref(hook, -1);
3423  }
3424 
3425  return res ? -1 : 0;
3426 }
static struct ast_bridge_hook * bridge_hook_generic(size_t size, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags)
Definition: bridge.c:3225
#define ast_heap_unlock(h)
Definition: heap.h:248
struct ast_bridge_hook generic
ast_bridge_hook_pvt_destructor destructor
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:150
#define NULL
Definition: resample.c:96
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:755
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:452
#define ast_heap_push(h, elm)
Definition: heap.h:126
enum ast_bridge_hook_type type
#define ao2_ref(o, delta)
Definition: astobj2.h:464
struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate)
Returns a timeval corresponding to the duration of n samples at rate r. Useful to convert samples to ...
Definition: time.h:238
struct ast_heap * interval_hooks
struct timeval ast_tvadd(struct timeval a, struct timeval b)
Returns the sum of two timevals a + b.
Definition: extconf.c:2283
struct ast_bridge_hook_timer_parms timer
unsigned int interval_sequence
#define ast_heap_wrlock(h)
Definition: heap.h:246

◆ ast_bridge_interval_register()

int ast_bridge_interval_register ( enum ast_bridge_builtin_interval  interval,
ast_bridge_builtin_set_limits_fn  callback 
)

Register a handler for a built in interval feature.

Parameters
intervalThe interval feature that the handler will be responsible for
callbackthe Callback function that will handle it
Return values
0on success
-1on failure

Example usage:

This registers the function bridge_builtin_set_limits as the function responsible for the built in duration limit feature.

Definition at line 3168 of file bridge.c.

References ARRAY_LEN, and builtin_interval_handlers.

Referenced by load_module().

3169 {
3170  if (ARRAY_LEN(builtin_interval_handlers) <= interval
3171  || builtin_interval_handlers[interval]) {
3172  return -1;
3173  }
3174 
3175  builtin_interval_handlers[interval] = callback;
3176 
3177  return 0;
3178 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static ast_bridge_builtin_set_limits_fn builtin_interval_handlers[AST_BRIDGE_BUILTIN_INTERVAL_END]
Definition: bridge.c:150

◆ ast_bridge_join_hook()

int ast_bridge_join_hook ( struct ast_bridge_features features,
ast_bridge_hook_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Unregisters a handler for a built in interval feature.

Parameters
intervalthe interval feature to unregister
Return values
0on success
-1on failure

Example usage:

ast_bridge_interval_unregister(AST_BRIDGE_BULTIN_INTERVAL_LIMITS)
/endcode
This unregisters the function that is handling the built in duration limit feature.
/
/*!
* \brief Attach a bridge channel join hook to a bridge features structure
* \param features Bridge features structure
* \param callback Function to execute upon activation
* \param hook_pvt Unique data
* \param destructor Optional destructor callback for hook_pvt data
* \param remove_flags Dictates what situations the hook should be removed.
* \retval 0 on success
* \retval -1 on failure (The caller must cleanup any hook_pvt resources.)
* Example usage:
* \code
* struct ast_bridge_features features;
* ast_bridge_features_init(&features);
* ast_bridge_join_hook(&features, join_callback, NULL, NULL, 0);
*

This makes the bridging core call join_callback when a channel successfully joins the bridging system. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3338 of file bridge.c.

References AST_BRIDGE_HOOK_TYPE_JOIN, and bridge_other_hook().

Referenced by agent_request_exec(), and confbridge_exec().

3343 {
3344  return bridge_other_hook(features, callback, hook_pvt, destructor, remove_flags,
3346 }
static int bridge_other_hook(struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags, enum ast_bridge_hook_type type)
Definition: bridge.c:3294

◆ ast_bridge_leave_hook()

int ast_bridge_leave_hook ( struct ast_bridge_features features,
ast_bridge_hook_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach a bridge channel leave hook to a bridge features structure.

Parameters
featuresBridge features structure
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)

Example usage:

struct ast_bridge_features features;
ast_bridge_leave_hook(&features, leave_callback, NULL, NULL, 0);

This makes the bridging core call leave_callback when a channel successfully leaves the bridging system. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3348 of file bridge.c.

References AST_BRIDGE_HOOK_TYPE_LEAVE, and bridge_other_hook().

Referenced by confbridge_exec().

3353 {
3354  return bridge_other_hook(features, callback, hook_pvt, destructor, remove_flags,
3356 }
static int bridge_other_hook(struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags, enum ast_bridge_hook_type type)
Definition: bridge.c:3294

◆ ast_bridge_move_hook()

int ast_bridge_move_hook ( struct ast_bridge_features features,
ast_bridge_move_indicate_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach a bridge channel move detection hook to a bridge features structure.

Parameters
featuresBridge features structure
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)

Example usage:

struct ast_bridge_features features;
ast_bridge_move_hook(&features, move_callback, NULL, NULL, 0);

This makes the bridging core call callback when a channel is moved from one bridge to another. A pointer to useful data may be provided to the hook_pvt parameter.

Definition at line 3370 of file bridge.c.

References AST_BRIDGE_HOOK_TYPE_MOVE, bridge_other_hook(), and hook_cb().

Referenced by bridge_stasis_pull().

3375 {
3377 
3378  return bridge_other_hook(features, hook_cb, hook_pvt, destructor, remove_flags,
3380 }
int(* ast_bridge_hook_callback)(struct ast_bridge_channel *bridge_channel, void *hook_pvt)
Hook callback type.
static int bridge_other_hook(struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags, enum ast_bridge_hook_type type)
Definition: bridge.c:3294
static int hook_cb(struct ast_config *cfg)
Definition: test_config.c:875

◆ ast_bridge_talk_detector_hook()

int ast_bridge_talk_detector_hook ( struct ast_bridge_features features,
ast_bridge_talking_indicate_callback  callback,
void *  hook_pvt,
ast_bridge_hook_pvt_destructor  destructor,
enum ast_bridge_hook_remove_flags  remove_flags 
)

Attach a bridge channel talk detection hook to a bridge features structure.

Parameters
featuresBridge features structure
callbackFunction to execute upon activation
hook_pvtUnique data
destructorOptional destructor callback for hook_pvt data
remove_flagsDictates what situations the hook should be removed.
Return values
0on success
-1on failure (The caller must cleanup any hook_pvt resources.)

Example usage:

struct ast_bridge_features features;
ast_bridge_talk_hook(&features, talk_callback, NULL, NULL, 0);

This makes the bridging technology call talk_callback when a channel is recognized as starting and stopping talking. A pointer to useful data may be provided to the hook_pvt parameter.

Note
This hook is currently only supported by softmix.

Definition at line 3358 of file bridge.c.

References AST_BRIDGE_HOOK_TYPE_TALK, bridge_other_hook(), and hook_cb().

Referenced by confbridge_exec().

3363 {
3365 
3366  return bridge_other_hook(features, hook_cb, hook_pvt, destructor, remove_flags,
3368 }
int(* ast_bridge_hook_callback)(struct ast_bridge_channel *bridge_channel, void *hook_pvt)
Hook callback type.
static int bridge_other_hook(struct ast_bridge_features *features, ast_bridge_hook_callback callback, void *hook_pvt, ast_bridge_hook_pvt_destructor destructor, enum ast_bridge_hook_remove_flags remove_flags, enum ast_bridge_hook_type type)
Definition: bridge.c:3294
static int hook_cb(struct ast_config *cfg)
Definition: test_config.c:875