Asterisk - The Open Source Telephony Project  21.4.1
Data Structures
stasis_app.h File Reference

Stasis Application API. See Stasis Application API for detailed documentation. More...

#include "asterisk/channel.h"

Go to the source code of this file.

Data Structures

struct  stasis_app_control_rule
 Rule to check to see if an operation is allowed. More...
 
struct  stasis_app_event_source
 Event source information and callbacks. More...
 
enum  stasis_app_user_event_res {
  STASIS_APP_USER_OK, STASIS_APP_USER_APP_NOT_FOUND, STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND, STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME,
  STASIS_APP_USER_USEREVENT_INVALID, STASIS_APP_USER_INTERNAL_ERROR
}
 Return code for stasis_app_user_event.
 
enum  stasis_app_subscribe_res {
  STASIS_ASR_OK, STASIS_ASR_APP_NOT_FOUND, STASIS_ASR_EVENT_SOURCE_NOT_FOUND, STASIS_ASR_EVENT_SOURCE_BAD_SCHEME,
  STASIS_ASR_INTERNAL_ERROR
}
 Return code for stasis_app_[un]subscribe.
 
typedef void(* stasis_app_cb) (void *data, const char *app_name, struct ast_json *message)
 Callback for Stasis application handler. More...
 
struct ao2_containerstasis_app_get_all (void)
 Gets the names of all registered Stasis applications. More...
 
struct stasis_appstasis_app_get_by_name (const char *name)
 Retrieve a handle to a Stasis application by its name. More...
 
int stasis_app_register (const char *app_name, stasis_app_cb handler, void *data)
 Register a new Stasis application. More...
 
int stasis_app_register_all (const char *app_name, stasis_app_cb handler, void *data)
 Register a new Stasis application that receives all Asterisk events. More...
 
void stasis_app_unregister (const char *app_name)
 Unregister a Stasis application. More...
 
int stasis_app_send (const char *app_name, struct ast_json *message)
 Send a message to the given Stasis application. More...
 
const char * stasis_app_name (const struct stasis_app *app)
 Retrieve an application's name. More...
 
struct ast_jsonstasis_app_object_to_json (struct stasis_app *app)
 Return the JSON representation of a Stasis application. More...
 
struct ast_jsonstasis_app_to_json (const char *app_name)
 Return the JSON representation of a Stasis application. More...
 
void stasis_app_register_event_source (struct stasis_app_event_source *obj)
 Register an application event source. More...
 
void stasis_app_register_event_sources (void)
 Register core event sources.
 
void stasis_app_unregister_event_source (struct stasis_app_event_source *obj)
 Unregister an application event source. More...
 
void stasis_app_unregister_event_sources (void)
 Unregister core event sources.
 
enum stasis_app_user_event_res stasis_app_user_event (const char *app_name, const char *event_name, const char **source_uris, int sources_count, struct ast_json *json_variables)
 Generate a Userevent for stasis app (echo to AMI) More...
 
enum stasis_app_subscribe_res stasis_app_subscribe (const char *app_name, const char **event_source_uris, int event_sources_count, struct ast_json **json)
 Subscribes an application to a list of event sources. More...
 
enum stasis_app_subscribe_res stasis_app_unsubscribe (const char *app_name, const char **event_source_uris, int event_sources_count, struct ast_json **json)
 Unsubscribes an application from a list of event sources. More...
 
enum stasis_app_subscribe_res stasis_app_subscribe_channel (const char *app_name, struct ast_channel *chan)
 Directly subscribe an application to a channel. More...
 
enum  stasis_app_control_channel_result { STASIS_APP_CHANNEL_OKAY = 0, STASIS_APP_CHANNEL_RECORDING }
 Result codes used when adding/removing channels to/from bridges. More...
 
void stasis_app_control_register_add_rule (struct stasis_app_control *control, struct stasis_app_control_rule *rule)
 Registers an add channel to bridge rule. More...
 
void stasis_app_control_unregister_add_rule (struct stasis_app_control *control, struct stasis_app_control_rule *rule)
 UnRegister an add channel to bridge rule. More...
 
void stasis_app_control_register_remove_rule (struct stasis_app_control *control, struct stasis_app_control_rule *rule)
 Registers a remove channel from bridge rule. More...
 
void stasis_app_control_unregister_remove_rule (struct stasis_app_control *control, struct stasis_app_control_rule *rule)
 Unregisters a remove channel from bridge rule. More...
 
struct stasis_app_controlstasis_app_control_find_by_channel (const struct ast_channel *chan)
 Returns the handler for the given channel. More...
 
struct stasis_app_controlstasis_app_control_find_by_channel_id (const char *channel_id)
 Returns the handler for the channel with the given id. More...
 
struct stasis_app_controlstasis_app_control_create (struct ast_channel *chan)
 Creates a control handler for a channel that isn't in a stasis app. More...
 
void stasis_app_control_execute_until_exhausted (struct ast_channel *chan, struct stasis_app_control *control)
 Act on a stasis app control queue until it is empty. More...
 
int stasis_app_control_is_done (struct stasis_app_control *control)
 Check if a control is marked as done. More...
 
void stasis_app_control_flush_queue (struct stasis_app_control *control)
 Flush the control command queue. More...
 
const char * stasis_app_control_get_channel_id (const struct stasis_app_control *control)
 Returns the uniqueid of the channel associated with this control. More...
 
int stasis_app_control_add_role (struct stasis_app_control *control, const char *role)
 Apply a bridge role to a channel controlled by a stasis app control. More...
 
void stasis_app_control_clear_roles (struct stasis_app_control *control)
 Clear bridge roles currently applied to a channel controlled by a stasis app control. More...
 
int stasis_app_control_continue (struct stasis_app_control *control, const char *context, const char *extension, int priority)
 Exit res_stasis and continue execution in the dialplan. More...
 
int stasis_app_control_move (struct stasis_app_control *control, const char *app_name, const char *app_args)
 Exit res_stasis and move to another Stasis application. More...
 
int stasis_app_control_redirect (struct stasis_app_control *control, const char *endpoint)
 Redirect a channel in res_stasis to a particular endpoint. More...
 
int stasis_app_control_ring (struct stasis_app_control *control)
 Indicate ringing to the channel associated with this control. More...
 
int stasis_app_control_ring_stop (struct stasis_app_control *control)
 Stop locally generated ringing on the channel associated with this control. More...
 
int stasis_app_control_dtmf (struct stasis_app_control *control, const char *dtmf, int before, int between, unsigned int duration, int after)
 Send DTMF to the channel associated with this control. More...
 
int stasis_app_control_mute (struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype)
 Mute the channel associated with this control. More...
 
int stasis_app_control_unmute (struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype)
 Unmute the channel associated with this control. More...
 
int stasis_app_control_answer (struct stasis_app_control *control)
 Answer the channel associated with this control. More...
 
int stasis_app_control_set_channel_var (struct stasis_app_control *control, const char *variable, const char *value)
 Set a variable on the channel associated with this control to value. More...
 
void stasis_app_control_hold (struct stasis_app_control *control)
 Place the channel associated with the control on hold. More...
 
void stasis_app_control_unhold (struct stasis_app_control *control)
 Remove the channel associated with the control from hold. More...
 
void stasis_app_control_moh_start (struct stasis_app_control *control, const char *moh_class)
 Play music on hold to a channel (does not affect hold status) More...
 
void stasis_app_control_moh_stop (struct stasis_app_control *control)
 Stop playing music on hold to a channel (does not affect hold status) More...
 
void stasis_app_control_silence_start (struct stasis_app_control *control)
 Start playing silence to a channel. More...
 
void stasis_app_control_silence_stop (struct stasis_app_control *control)
 Stop playing silence to a channel. More...
 
struct ast_channel_snapshotstasis_app_control_get_snapshot (const struct stasis_app_control *control)
 Returns the most recent snapshot for the associated channel. More...
 
void stasis_app_control_publish (struct stasis_app_control *control, struct stasis_message *message)
 Publish a message to the control's channel's topic. More...
 
struct stasis_topicast_app_get_topic (struct stasis_app *app)
 Returns the stasis topic for an app. More...
 
int stasis_app_control_queue_control (struct stasis_app_control *control, enum ast_control_frame_type frame_type)
 Queue a control frame without payload. More...
 
struct ast_bridgestasis_app_bridge_create (const char *type, const char *name, const char *id)
 Create a bridge of the specified type. More...
 
struct ast_bridgestasis_app_bridge_create_invisible (const char *type, const char *name, const char *id)
 Create an invisible bridge of the specified type. More...
 
struct ast_bridgestasis_app_bridge_find_by_id (const char *bridge_id)
 Returns the bridge with the given id. More...
 
struct ast_channelstasis_app_bridge_moh_channel (struct ast_bridge *bridge)
 Finds or creates an announcer channel in a bridge that can play music on hold. More...
 
int stasis_app_bridge_moh_stop (struct ast_bridge *bridge)
 Breaks down MOH channels playing on the bridge created by stasis_app_bridge_moh_channel. More...
 
struct ast_channelstasis_app_bridge_playback_channel_find (struct ast_bridge *bridge)
 Finds an existing ARI playback channel in a bridge. More...
 
int stasis_app_bridge_playback_channel_add (struct ast_bridge *bridge, struct ast_channel *chan, struct stasis_app_control *control)
 Adds a channel to the list of ARI playback channels for bridges. More...
 
void stasis_app_bridge_playback_channel_remove (char *bridge_id, struct stasis_app_control *control)
 remove channel from list of ARI playback channels for bridges. More...
 
int stasis_app_control_add_channel_to_bridge (struct stasis_app_control *control, struct ast_bridge *bridge)
 Add a channel to the bridge. More...
 
int stasis_app_control_remove_channel_from_bridge (struct stasis_app_control *control, struct ast_bridge *bridge)
 Remove a channel from the bridge. More...
 
int stasis_app_control_bridge_features_init (struct stasis_app_control *control)
 Initialize bridge features into a channel control. More...
 
void stasis_app_control_absorb_dtmf_in_bridge (struct stasis_app_control *control, int absorb)
 Set whether DTMF from the channel is absorbed instead of passing through to the bridge. More...
 
void stasis_app_control_mute_in_bridge (struct stasis_app_control *control, int mute)
 Set whether audio from the channel is muted instead of passing through to the bridge. More...
 
void stasis_app_control_inhibit_colp_in_bridge (struct stasis_app_control *control, int inhibit_colp)
 Set whether COLP frames should be generated when joining the bridge. More...
 
struct ast_bridgestasis_app_get_bridge (struct stasis_app_control *control)
 Gets the bridge currently associated with a control object. More...
 
void stasis_app_bridge_destroy (const char *bridge_id)
 Destroy the bridge. More...
 
struct stasis_message_sanitizerstasis_app_get_sanitizer (void)
 Get the Stasis message sanitizer for app_stasis applications. More...
 
void stasis_app_channel_set_stasis_end_published (struct ast_channel *chan)
 Indicate that this channel has had a StasisEnd published for it. More...
 
int stasis_app_channel_is_stasis_end_published (struct ast_channel *chan)
 Has this channel had a StasisEnd published on it? More...
 
int stasis_app_channel_is_internal (struct ast_channel *chan)
 Is this channel internal to Stasis? More...
 
int stasis_app_channel_unreal_set_internal (struct ast_channel *chan)
 Mark this unreal channel and it's other half as being internal to Stasis. More...
 
int stasis_app_channel_set_internal (struct ast_channel *chan)
 Mark this channel as being internal to Stasis. More...
 
int stasis_app_control_dial (struct stasis_app_control *control, const char *dialstring, unsigned int timeout)
 Dial a channel. More...
 
void stasis_app_control_shutdown (void)
 Let Stasis app internals shut down. More...
 
void stasis_app_set_debug (struct stasis_app *app, int debug)
 Enable/disable request/response and event logging on an application. More...
 
void stasis_app_set_debug_by_name (const char *app_name, int debug)
 Enable/disable request/response and event logging on an application. More...
 
int stasis_app_get_debug (struct stasis_app *app)
 Get debug status of an application. More...
 
int stasis_app_get_debug_by_name (const char *app_name)
 Get debug status of an application. More...
 
void stasis_app_set_global_debug (int debug)
 Enable/disable request/response and event logging on all applications. More...
 
void stasis_app_to_cli (const struct stasis_app *app, struct ast_cli_args *a)
 Dump properties of a stasis_app to the CLI. More...
 
struct ast_jsonstasis_app_event_filter_to_json (struct stasis_app *app, struct ast_json *json)
 Convert and add the app's event type filter(s) to the given json object. More...
 
int stasis_app_event_filter_set (struct stasis_app *app, struct ast_json *filter)
 Set the application's event type filter. More...
 
int stasis_app_event_allowed (const char *app_name, struct ast_json *event)
 Check if the given event should be filtered. More...
 

Detailed Description

Stasis Application API. See Stasis Application API for detailed documentation.

Author
David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m
Since
12

Definition in file stasis_app.h.

Typedef Documentation

typedef void(* stasis_app_cb) (void *data, const char *app_name, struct ast_json *message)

Callback for Stasis application handler.

The message given to the handler is a borrowed copy. If you want to keep a reference to it, you should use ao2_ref() to keep it around.

Parameters
dataData ptr given when registered.
app_nameName of the application being dispatched to.
messageMessage to handle. (borrowed copy)

Definition at line 67 of file stasis_app.h.

Enumeration Type Documentation

Result codes used when adding/removing channels to/from bridges.

Enumerator
STASIS_APP_CHANNEL_OKAY 

The channel is okay to be added/removed

STASIS_APP_CHANNEL_RECORDING 

The channel is currently recording

Definition at line 776 of file stasis_app.h.

776  {
777  /*! The channel is okay to be added/removed */
779  /*! The channel is currently recording */
781 };

Function Documentation

struct stasis_topic* ast_app_get_topic ( struct stasis_app app)

Returns the stasis topic for an app.

Parameters
appStasis app to get topic of

Definition at line 1028 of file res/stasis/app.c.

References stasis_app::topic.

Referenced by app_send_end_msg(), and stasis_app_user_event().

1029 {
1030  return app->topic;
1031 }
struct stasis_topic * topic
struct ast_bridge* stasis_app_bridge_create ( const char *  type,
const char *  name,
const char *  id 
)

Create a bridge of the specified type.

Parameters
typeThe type of bridge to be created
nameOptional name to give to the bridge
idOptional Unique ID to give to the bridge
Returns
New bridge.
Return values
NULLon error.

Definition at line 854 of file res_stasis.c.

Referenced by ast_ari_bridges_create(), and ast_ari_bridges_create_with_id().

855 {
856  return bridge_create_common(type, name, id, 0);
857 }
char * name
Definition: stasis.c:386
struct ast_bridge* stasis_app_bridge_create_invisible ( const char *  type,
const char *  name,
const char *  id 
)

Create an invisible bridge of the specified type.

Parameters
typeThe type of bridge to be created
nameOptional name to give to the bridge
idOptional Unique ID to give to the bridge
Returns
New bridge.
Return values
NULLon error.

Definition at line 859 of file res_stasis.c.

Referenced by get_dial_bridge().

860 {
861  return bridge_create_common(type, name, id, 1);
862 }
char * name
Definition: stasis.c:386
void stasis_app_bridge_destroy ( const char *  bridge_id)

Destroy the bridge.

Parameters
bridge_idUniqueid of bridge to be destroyed

Definition at line 864 of file res_stasis.c.

References ao2_unlink, ast_bridge_destroy(), and stasis_app_bridge_find_by_id().

Referenced by ast_ari_bridges_destroy().

865 {
866  struct ast_bridge *bridge = stasis_app_bridge_find_by_id(bridge_id);
867  if (!bridge) {
868  return;
869  }
870  ao2_unlink(app_bridges, bridge);
871  ast_bridge_destroy(bridge, 0);
872 }
int ast_bridge_destroy(struct ast_bridge *bridge, int cause)
Destroy a bridge.
Definition: bridge.c:944
Structure that contains information about a bridge.
Definition: bridge.h:349
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition: astobj2.h:1578
struct ast_bridge * stasis_app_bridge_find_by_id(const char *bridge_id)
Returns the bridge with the given id.
Definition: res_stasis.c:774
struct ast_bridge* stasis_app_bridge_find_by_id ( const char *  bridge_id)

Returns the bridge with the given id.

Parameters
bridge_idUniqueid of the bridge.
Returns
NULL bridge not created by a Stasis application, or bridge does not exist.
Pointer to bridge.

Definition at line 774 of file res_stasis.c.

References OBJ_SEARCH_KEY.

Referenced by find_bridge(), and stasis_app_bridge_destroy().

776 {
777  return ao2_find(app_bridges, bridge_id, OBJ_SEARCH_KEY);
778 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
struct ast_channel* stasis_app_bridge_moh_channel ( struct ast_bridge bridge)

Finds or creates an announcer channel in a bridge that can play music on hold.

Parameters
bridgeBridge we want an MOH channel for
Returns
NULL if the music on hold channel fails to be created or join the bridge for any reason.
Pointer to the ;1 end of the announcer channel chain.

Definition at line 629 of file res_stasis.c.

References ao2_ref, ast_channel_get_by_name(), OBJ_NOLOCK, OBJ_SEARCH_KEY, and ast_bridge::uniqueid.

Referenced by ast_ari_bridges_start_moh().

630 {
631  struct ast_channel *chan;
632  struct stasis_app_bridge_channel_wrapper *moh_wrapper;
633 
634  ao2_lock(app_bridges_moh);
635  moh_wrapper = ao2_find(app_bridges_moh, bridge->uniqueid, OBJ_SEARCH_KEY | OBJ_NOLOCK);
636  if (!moh_wrapper) {
637  chan = bridge_moh_create(bridge);
638  }
639  ao2_unlock(app_bridges_moh);
640 
641  if (moh_wrapper) {
642  chan = ast_channel_get_by_name(moh_wrapper->channel_id);
643  ao2_ref(moh_wrapper, -1);
644  }
645 
646  return chan;
647 }
Main Channel structure associated with a channel.
const ast_string_field uniqueid
Definition: bridge.h:401
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
Assume that the ao2_container is already locked.
Definition: astobj2.h:1063
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_channel * ast_channel_get_by_name(const char *name)
Find a channel by name.
Definition: channel.c:1454
int stasis_app_bridge_moh_stop ( struct ast_bridge bridge)

Breaks down MOH channels playing on the bridge created by stasis_app_bridge_moh_channel.

Parameters
bridgeBridge we want to stop the MOH on
Returns
-1 if no moh channel could be found and stopped
0 on success

Definition at line 649 of file res_stasis.c.

References ao2_ref, ast_channel_get_by_name(), ast_moh_stop(), ast_softhangup(), OBJ_SEARCH_KEY, OBJ_UNLINK, and ast_bridge::uniqueid.

Referenced by ast_ari_bridges_stop_moh().

650 {
651  struct stasis_app_bridge_channel_wrapper *moh_wrapper;
652  struct ast_channel *chan;
653 
654  moh_wrapper = ao2_find(app_bridges_moh, bridge->uniqueid, OBJ_SEARCH_KEY | OBJ_UNLINK);
655  if (!moh_wrapper) {
656  return -1;
657  }
658 
659  chan = ast_channel_get_by_name(moh_wrapper->channel_id);
660  ao2_ref(moh_wrapper, -1);
661  if (!chan) {
662  return -1;
663  }
664 
665  ast_moh_stop(chan);
666  ast_softhangup(chan, AST_CAUSE_NORMAL_CLEARING);
667  ao2_cleanup(chan);
668 
669  return 0;
670 }
Main Channel structure associated with a channel.
const ast_string_field uniqueid
Definition: bridge.h:401
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
int ast_softhangup(struct ast_channel *chan, int cause)
Softly hangup up a channel.
Definition: channel.c:2471
void ast_moh_stop(struct ast_channel *chan)
Turn off music on hold on a given channel.
Definition: channel.c:7776
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_channel * ast_channel_get_by_name(const char *name)
Find a channel by name.
Definition: channel.c:1454
int stasis_app_bridge_playback_channel_add ( struct ast_bridge bridge,
struct ast_channel chan,
struct stasis_app_control control 
)

Adds a channel to the list of ARI playback channels for bridges.

Parameters
bridgeBridge we are adding the playback channel for
chanChannel being added as a playback channel (must be ;1)
controlThe app control structure for the playback channel
Return values
-1failed to add channel for any reason
0on success

Definition at line 705 of file res_stasis.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_link, ast_bridge_set_after_callback(), ast_strdup, ast_string_field_init, ast_string_field_set, RAII_VAR, and ast_bridge::uniqueid.

708 {
709  RAII_VAR(struct stasis_app_bridge_channel_wrapper *, new_wrapper, NULL, ao2_cleanup);
710  char *bridge_id = ast_strdup(bridge->uniqueid);
711 
712  if (!bridge_id) {
713  return -1;
714  }
715 
717  playback_after_bridge_cb, playback_after_bridge_cb_failed, bridge_id)) {
718  ast_free(bridge_id);
719  return -1;
720  }
721 
722  new_wrapper = ao2_alloc_options(sizeof(*new_wrapper),
723  stasis_app_bridge_channel_wrapper_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
724  if (!new_wrapper) {
725  return -1;
726  }
727 
728  if (ast_string_field_init(new_wrapper, 32)) {
729  return -1;
730  }
731 
732  ast_string_field_set(new_wrapper, bridge_id, bridge->uniqueid);
733  ast_string_field_set(new_wrapper, channel_id, ast_channel_uniqueid(chan));
734 
735  if (!ao2_link(app_bridges_playback, new_wrapper)) {
736  return -1;
737  }
738 
739  ao2_link(app_controls, control);
740  return 0;
741 }
const ast_string_field uniqueid
Definition: bridge.h:401
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
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.
Definition: bridge_after.c:251
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:359
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:521
#define ao2_link(container, obj)
Add an object to a container.
Definition: astobj2.h:1532
struct ast_channel* stasis_app_bridge_playback_channel_find ( struct ast_bridge bridge)

Finds an existing ARI playback channel in a bridge.

Parameters
bridgeBridge we want to find the playback channel for
Returns
NULL if the playback channel can not be found for any reason.
Pointer to the ;1 end of the playback channel chain.

Definition at line 759 of file res_stasis.c.

References ao2_ref, ast_channel_get_by_name(), OBJ_SEARCH_KEY, and ast_bridge::uniqueid.

760 {
761  struct stasis_app_bridge_channel_wrapper *playback_wrapper;
762  struct ast_channel *chan;
763 
764  playback_wrapper = ao2_find(app_bridges_playback, bridge->uniqueid, OBJ_SEARCH_KEY);
765  if (!playback_wrapper) {
766  return NULL;
767  }
768 
769  chan = ast_channel_get_by_name(playback_wrapper->channel_id);
770  ao2_ref(playback_wrapper, -1);
771  return chan;
772 }
Main Channel structure associated with a channel.
const ast_string_field uniqueid
Definition: bridge.h:401
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_channel * ast_channel_get_by_name(const char *name)
Find a channel by name.
Definition: channel.c:1454
void stasis_app_bridge_playback_channel_remove ( char *  bridge_id,
struct stasis_app_control control 
)

remove channel from list of ARI playback channels for bridges.

Parameters
bridge_idThe unique ID of the bridge the playback channel is in.
controlThe app control structure for the playback channel

Definition at line 743 of file res_stasis.c.

References ao2_ref, ao2_unlink, OBJ_SEARCH_KEY, and OBJ_UNLINK.

745 {
746  struct stasis_app_bridge_channel_wrapper *wrapper;
747 
748  wrapper = ao2_find(app_bridges_playback, bridge_id, OBJ_SEARCH_KEY | OBJ_UNLINK);
749  if (wrapper) {
750  /* If wrapper is not found, then that means the after bridge callback has been
751  * called or is in progress. No need to unlink the control here since that has
752  * been done or is about to be done in the after bridge callback
753  */
754  ao2_unlink(app_controls, control);
755  ao2_ref(wrapper, -1);
756  }
757 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition: astobj2.h:1578
int stasis_app_channel_is_internal ( struct ast_channel chan)

Is this channel internal to Stasis?

Parameters
chanThe channel to check.
Return values
0No
1Yes

Definition at line 2329 of file res_stasis.c.

References ast_channel_datastore_find().

2330 {
2331  struct ast_datastore *datastore;
2332  int res = 0;
2333 
2334  ast_channel_lock(chan);
2335  datastore = ast_channel_datastore_find(chan, &stasis_internal_channel_info, NULL);
2336  if (datastore) {
2337  res = 1;
2338  }
2339  ast_channel_unlock(chan);
2340 
2341  return res;
2342 }
Structure for a data store object.
Definition: datastore.h:64
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2399
int stasis_app_channel_is_stasis_end_published ( struct ast_channel chan)

Has this channel had a StasisEnd published on it?

Parameters
chanThe channel upon which the query rests.
Return values
0No
1Yes

Definition at line 1302 of file res_stasis.c.

References ast_channel_datastore_find().

Referenced by stasis_app_exec().

1303 {
1304  struct ast_datastore *datastore;
1305 
1306  ast_channel_lock(chan);
1307  datastore = ast_channel_datastore_find(chan, &set_end_published_info, NULL);
1308  ast_channel_unlock(chan);
1309 
1310  return datastore ? 1 : 0;
1311 }
Structure for a data store object.
Definition: datastore.h:64
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2399
int stasis_app_channel_set_internal ( struct ast_channel chan)

Mark this channel as being internal to Stasis.

Parameters
chanThe channel to mark.
Return values
zeroSuccess
non-zeroFailure

Definition at line 2318 of file res_stasis.c.

2319 {
2320  int res;
2321 
2322  ast_channel_lock(chan);
2323  res = set_internal_datastore(chan);
2324  ast_channel_unlock(chan);
2325 
2326  return res;
2327 }
void stasis_app_channel_set_stasis_end_published ( struct ast_channel chan)

Indicate that this channel has had a StasisEnd published for it.

Parameters
chanThe channel that is exiting Stasis.

Definition at line 1290 of file res_stasis.c.

References ast_channel_datastore_add().

1291 {
1292  struct ast_datastore *datastore;
1293 
1294  datastore = ast_datastore_alloc(&set_end_published_info, NULL);
1295  if (datastore) {
1296  ast_channel_lock(chan);
1297  ast_channel_datastore_add(chan, datastore);
1298  ast_channel_unlock(chan);
1299  }
1300 }
Structure for a data store object.
Definition: datastore.h:64
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2385
int stasis_app_channel_unreal_set_internal ( struct ast_channel chan)

Mark this unreal channel and it's other half as being internal to Stasis.

Parameters
chanThe channel to mark.
Return values
zeroSuccess
non-zeroFailure

Definition at line 2295 of file res_stasis.c.

References ao2_ref, ast_channel_unref, and ast_unreal_lock_all().

2296 {
2297  struct ast_channel *outchan = NULL, *outowner = NULL;
2298  int res = 0;
2299  struct ast_unreal_pvt *unreal_pvt = ast_channel_tech_pvt(chan);
2300 
2301  ao2_ref(unreal_pvt, +1);
2302  ast_unreal_lock_all(unreal_pvt, &outowner, &outchan);
2303  if (outowner) {
2304  res |= set_internal_datastore(outowner);
2305  ast_channel_unlock(outowner);
2306  ast_channel_unref(outowner);
2307  }
2308  if (outchan) {
2309  res |= set_internal_datastore(outchan);
2310  ast_channel_unlock(outchan);
2311  ast_channel_unref(outchan);
2312  }
2313  ao2_unlock(unreal_pvt);
2314  ao2_ref(unreal_pvt, -1);
2315  return res;
2316 }
Main Channel structure associated with a channel.
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2958
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
The base pvt structure for local channel derivatives.
Definition: core_unreal.h:91
void ast_unreal_lock_all(struct ast_unreal_pvt *p, struct ast_channel **outchan, struct ast_channel **outowner)
Send an unreal pvt in with no locks held and get all locks.
Definition: core_unreal.c:47
void stasis_app_control_absorb_dtmf_in_bridge ( struct stasis_app_control control,
int  absorb 
)

Set whether DTMF from the channel is absorbed instead of passing through to the bridge.

Parameters
controlControl whose channel should have its DTMF absorbed when bridged
absorbWhether DTMF should be absorbed (1) instead of passed through (0).

Definition at line 1486 of file control.c.

References stasis_app_control::bridge_features, and ast_bridge_features::dtmf_passthrough.

Referenced by ast_ari_bridges_add_channel().

1488 {
1489  control->bridge_features->dtmf_passthrough = !absorb;
1490 }
struct ast_bridge_features * bridge_features
Definition: control.c:70
unsigned int dtmf_passthrough
int stasis_app_control_add_channel_to_bridge ( struct stasis_app_control control,
struct ast_bridge bridge 
)

Add a channel to the bridge.

Parameters
controlControl whose channel should be added to the bridge
bridgePointer to the bridge
Returns
non-zero on failure
zero on success

Definition at line 1405 of file control.c.

References ast_debug, control_add_channel_to_bridge(), and stasis_app_control_get_channel_id().

Referenced by ast_ari_bridges_add_channel().

1407 {
1408  ast_debug(3, "%s: Sending channel add_to_bridge command\n",
1410 
1411  return app_send_command_on_condition(
1412  control, control_add_channel_to_bridge, bridge, NULL,
1413  app_control_can_add_channel_to_bridge);
1414 }
int control_add_channel_to_bridge(struct stasis_app_control *control, struct ast_channel *chan, void *data)
Command callback for adding a channel to a bridge.
Definition: control.c:1400
#define ast_debug(level,...)
Log a DEBUG message.
const char * stasis_app_control_get_channel_id(const struct stasis_app_control *control)
Returns the uniqueid of the channel associated with this control.
Definition: control.c:1452
int stasis_app_control_add_role ( struct stasis_app_control control,
const char *  role 
)

Apply a bridge role to a channel controlled by a stasis app control.

Parameters
controlControl for res_stasis
roleRole to apply
Returns
0 for success
-1 for error.

Definition at line 338 of file control.c.

References ast_free_ptr(), ast_strdup, and stasis_app_send_command_async().

Referenced by ast_ari_bridges_add_channel().

339 {
340  char *role_dup;
341 
342  role_dup = ast_strdup(role);
343  if (!role_dup) {
344  return -1;
345  }
346 
347  stasis_app_send_command_async(control, app_control_add_role, role_dup, ast_free_ptr);
348 
349  return 0;
350 }
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_answer ( struct stasis_app_control control)

Answer the channel associated with this control.

Parameters
controlControl for res_stasis.
Returns
0 for success.
Non-zero for error.

Definition at line 44 of file res_stasis_answer.c.

References ast_debug, stasis_app_control_get_channel_id(), and stasis_app_send_command().

Referenced by ast_ari_channels_answer().

45 {
46  int retval;
47 
48  ast_debug(3, "%s: Sending answer command\n",
50 
51  retval = stasis_app_send_command(control, app_control_answer, NULL, NULL);
52 
53  if (retval != 0) {
54  ast_log(LOG_WARNING, "%s: Failed to answer channel\n",
56  return -1;
57  }
58 
59  return 0;
60 }
int stasis_app_send_command(struct stasis_app_control *control, stasis_app_command_cb command, void *data, command_data_destructor_fn data_destructor)
Invokes a command on a control's channel.
Definition: control.c:920
#define ast_debug(level,...)
Log a DEBUG message.
const char * stasis_app_control_get_channel_id(const struct stasis_app_control *control)
Returns the uniqueid of the channel associated with this control.
Definition: control.c:1452
int stasis_app_control_bridge_features_init ( struct stasis_app_control control)

Initialize bridge features into a channel control.

Note
Bridge features on a control are destroyed after each bridge session, so new features need to be initialized before each bridge add.
Parameters
controlControl in which to store the features
Returns
non-zero on failure
zero on success

Definition at line 1473 of file control.c.

References ast_bridge_features_new(), and stasis_app_control::bridge_features.

Referenced by ast_ari_bridges_add_channel().

1475 {
1476  struct ast_bridge_features *features;
1477 
1478  features = ast_bridge_features_new();
1479  if (!features) {
1480  return 1;
1481  }
1482  control->bridge_features = features;
1483  return 0;
1484 }
Structure that contains features information.
struct ast_bridge_features * bridge_features
Definition: control.c:70
struct ast_bridge_features * ast_bridge_features_new(void)
Allocate a new bridge features struct.
Definition: bridge.c:3683
void stasis_app_control_clear_roles ( struct stasis_app_control control)

Clear bridge roles currently applied to a channel controlled by a stasis app control.

Parameters
controlControl for res_stasis

Definition at line 360 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_bridges_add_channel().

361 {
362  stasis_app_send_command_async(control, app_control_clear_roles, NULL, NULL);
363 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_continue ( struct stasis_app_control control,
const char *  context,
const char *  extension,
int  priority 
)

Exit res_stasis and continue execution in the dialplan.

If the channel is no longer in res_stasis, this function does nothing.

Parameters
controlControl for res_stasis
contextAn optional context to continue to
extensionAn optional extension to continue to
priorityAn optional priority to continue to
Returns
0 for success
-1 for error.

Definition at line 411 of file control.c.

References ast_calloc, ast_copy_string(), ast_free_ptr(), S_OR, and stasis_app_send_command_async().

Referenced by ast_ari_channels_continue_in_dialplan().

412 {
413  struct stasis_app_control_continue_data *continue_data;
414 
415  if (!(continue_data = ast_calloc(1, sizeof(*continue_data)))) {
416  return -1;
417  }
418  ast_copy_string(continue_data->context, S_OR(context, ""), sizeof(continue_data->context));
419  ast_copy_string(continue_data->extension, S_OR(extension, ""), sizeof(continue_data->extension));
420  if (priority > 0) {
421  continue_data->priority = priority;
422  } else {
423  continue_data->priority = -1;
424  }
425 
426  stasis_app_send_command_async(control, app_control_continue, continue_data, ast_free_ptr);
427 
428  return 0;
429 }
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
structure to hold extensions
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one...
Definition: strings.h:80
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
struct stasis_app_control* stasis_app_control_create ( struct ast_channel chan)

Creates a control handler for a channel that isn't in a stasis app.

Since
12.0.0
Parameters
chanChannel to create controller handle for
Returns
NULL on failure to create the handle
Pointer to res_stasis handler.

Definition at line 333 of file res_stasis.c.

References control_create().

Referenced by ast_ari_bridges_record().

334 {
335  return control_create(chan, NULL);
336 }
struct stasis_app_control * control_create(struct ast_channel *channel, struct stasis_app *app)
Create a control object.
Definition: control.c:129
int stasis_app_control_dial ( struct stasis_app_control control,
const char *  dialstring,
unsigned int  timeout 
)

Dial a channel.

Parameters
controlControl for res_stasis.
dialstringThe dialstring to pass to the channel driver
timeoutOptional timeout in milliseconds

Definition at line 1688 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_dial().

1690 {
1691  struct control_dial_args *args;
1692 
1693  args = control_dial_args_alloc(dialstring, timeout);
1694  if (!args) {
1695  return -1;
1696  }
1697 
1698  return stasis_app_send_command_async(control, app_control_dial,
1699  args, control_dial_args_destroy);
1700 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_dtmf ( struct stasis_app_control control,
const char *  dtmf,
int  before,
int  between,
unsigned int  duration,
int  after 
)

Send DTMF to the channel associated with this control.

Parameters
controlControl for res_stasis.
dtmfDTMF string.
beforeAmount of time to wait before sending DTMF digits.
betweenAmount of time between each DTMF digit.
durationAmount of time each DTMF digit lasts for.
afterAmount of time to wait after sending DTMF digits.
Returns
0 for success.
-1 for error.

Definition at line 587 of file control.c.

References ast_calloc, ast_free_ptr(), and stasis_app_send_command_async().

Referenced by ast_ari_channels_send_dtmf().

588 {
589  struct stasis_app_control_dtmf_data *dtmf_data;
590 
591  if (!(dtmf_data = ast_calloc(1, sizeof(*dtmf_data) + strlen(dtmf) + 1))) {
592  return -1;
593  }
594 
595  dtmf_data->before = before;
596  dtmf_data->between = between;
597  dtmf_data->duration = duration;
598  dtmf_data->after = after;
599  strcpy(dtmf_data->dtmf, dtmf);
600 
601  stasis_app_send_command_async(control, app_control_dtmf, dtmf_data, ast_free_ptr);
602 
603  return 0;
604 }
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_execute_until_exhausted ( struct ast_channel chan,
struct stasis_app_control control 
)

Act on a stasis app control queue until it is empty.

Since
12.0.0
Parameters
chanChannel to handle
controlControl object to execute

Definition at line 1253 of file res_stasis.c.

References control_command_count(), control_dispatch_all(), and control_is_done().

1254 {
1255  while (!control_is_done(control)) {
1256  int command_count;
1257  command_count = control_dispatch_all(control, chan);
1258 
1259  ao2_lock(control);
1260 
1261  if (control_command_count(control)) {
1262  /* If the command queue isn't empty, something added to the queue before it was locked. */
1263  ao2_unlock(control);
1264  continue;
1265  }
1266 
1267  if (command_count == 0 || ast_channel_fdno(chan) == -1) {
1268  control_mark_done(control);
1269  ao2_unlock(control);
1270  break;
1271  }
1272  ao2_unlock(control);
1273  }
1274 }
int control_command_count(struct stasis_app_control *control)
Returns the count of items in a control's command queue.
Definition: control.c:365
int control_dispatch_all(struct stasis_app_control *control, struct ast_channel *chan)
Dispatch all commands enqueued to this control.
Definition: control.c:1517
int control_is_done(struct stasis_app_control *control)
Returns true if control_continue() has been called on this control.
Definition: control.c:370
struct stasis_app_control* stasis_app_control_find_by_channel ( const struct ast_channel chan)

Returns the handler for the given channel.

Parameters
chanChannel to handle.
Returns
NULL channel not in Stasis application.
Pointer to res_stasis handler.

Definition at line 338 of file res_stasis.c.

References stasis_app_control_find_by_channel_id().

Referenced by ari_bridges_play_found(), and bridge_timeout().

340 {
341  if (chan == NULL) {
342  return NULL;
343  }
344 
346  ast_channel_uniqueid(chan));
347 }
struct stasis_app_control * stasis_app_control_find_by_channel_id(const char *channel_id)
Returns the handler for the channel with the given id.
Definition: res_stasis.c:349
struct stasis_app_control* stasis_app_control_find_by_channel_id ( const char *  channel_id)

Returns the handler for the channel with the given id.

Parameters
channel_idUniqueid of the channel.
Returns
NULL channel not in Stasis application, or channel does not exist.
Pointer to res_stasis handler.

Definition at line 349 of file res_stasis.c.

References OBJ_SEARCH_KEY.

Referenced by find_channel_control(), find_control(), remove_bridge_playback(), and stasis_app_control_find_by_channel().

351 {
352  return ao2_find(app_controls, channel_id, OBJ_SEARCH_KEY);
353 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
void stasis_app_control_flush_queue ( struct stasis_app_control control)

Flush the control command queue.

Since
13.9.0
Parameters
controlControl object to flush command queue.

Definition at line 1281 of file res_stasis.c.

References control_flush_queue().

1282 {
1283  control_flush_queue(control);
1284 }
void control_flush_queue(struct stasis_app_control *control)
Flush the control command queue.
Definition: control.c:1504
const char* stasis_app_control_get_channel_id ( const struct stasis_app_control control)

Returns the uniqueid of the channel associated with this control.

Parameters
controlControl object.
Returns
Uniqueid of the associate channel.
Return values
NULLif control is NULL.

Definition at line 1452 of file control.c.

References stasis_app_control::channel.

Referenced by control_compare(), control_hash(), control_silence_stop_now(), control_swap_channel_in_bridge(), stasis_app_control_add_channel_to_bridge(), stasis_app_control_answer(), stasis_app_control_get_snapshot(), stasis_app_control_play_uri(), stasis_app_control_record(), and stasis_app_control_remove_channel_from_bridge().

1454 {
1455  return ast_channel_uniqueid(control->channel);
1456 }
struct ast_channel * channel
Definition: control.c:62
struct ast_channel_snapshot* stasis_app_control_get_snapshot ( const struct stasis_app_control control)

Returns the most recent snapshot for the associated channel.

The returned pointer is AO2 managed, so ao2_cleanup() when you're done.

Parameters
controlControl for res_stasis.
Returns
Most recent snapshot. ao2_cleanup() when done.
Return values
NULLif channel isn't in cache.

Definition at line 882 of file control.c.

References ast_channel_snapshot_get_latest(), and stasis_app_control_get_channel_id().

Referenced by ari_bridges_play_helper(), ast_ari_channels_continue_in_dialplan(), and channel_state_invalid().

884 {
886 }
const char * stasis_app_control_get_channel_id(const struct stasis_app_control *control)
Returns the uniqueid of the channel associated with this control.
Definition: control.c:1452
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object...
void stasis_app_control_hold ( struct stasis_app_control control)

Place the channel associated with the control on hold.

Parameters
controlControl for res_stasis.

Definition at line 770 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_hold().

771 {
772  stasis_app_send_command_async(control, app_control_hold, NULL, NULL);
773 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_inhibit_colp_in_bridge ( struct stasis_app_control control,
int  inhibit_colp 
)

Set whether COLP frames should be generated when joining the bridge.

Since
18
Parameters
controlControl whose channel should have its COLP frames inhibited when bridged
inhibit_colpWhether COLP frames should be generated (0) or not (1).

Definition at line 1498 of file control.c.

References stasis_app_control::bridge_features, and ast_bridge_features::inhibit_colp.

Referenced by ast_ari_bridges_add_channel().

1500 {
1501  control->bridge_features->inhibit_colp = inhibit_colp;
1502 }
unsigned int inhibit_colp
struct ast_bridge_features * bridge_features
Definition: control.c:70
int stasis_app_control_is_done ( struct stasis_app_control control)

Check if a control is marked as done.

Since
12.2.0
Parameters
controlWhich control object is being evaluated

Definition at line 1276 of file res_stasis.c.

References control_is_done().

Referenced by ari_bridges_play_found().

1277 {
1278  return control_is_done(control);
1279 }
int control_is_done(struct stasis_app_control *control)
Returns true if control_continue() has been called on this control.
Definition: control.c:370
void stasis_app_control_moh_start ( struct stasis_app_control control,
const char *  moh_class 
)

Play music on hold to a channel (does not affect hold status)

Parameters
controlControl for res_stasis.
moh_classclass of music on hold to play (NULL allowed)

Definition at line 802 of file control.c.

References ast_free_ptr(), ast_strdup, and stasis_app_send_command_async().

Referenced by ast_ari_channels_start_moh().

803 {
804  char *data = NULL;
805 
806  if (!ast_strlen_zero(moh_class)) {
807  data = ast_strdup(moh_class);
808  }
809 
810  stasis_app_send_command_async(control, app_control_moh_start, data, ast_free_ptr);
811 }
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_moh_stop ( struct stasis_app_control control)

Stop playing music on hold to a channel (does not affect hold status)

Parameters
controlControl for res_stasis.

Definition at line 820 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_stop_moh().

821 {
822  stasis_app_send_command_async(control, app_control_moh_stop, NULL, NULL);
823 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_move ( struct stasis_app_control control,
const char *  app_name,
const char *  app_args 
)

Exit res_stasis and move to another Stasis application.

If the channel is no longer in res_stasis, this function does nothing.

Parameters
controlControl for res_stasis
app_nameThe name of the application to switch to
app_argsThe list of arguments to pass to the application
Returns
0 for success
-1 for error

Definition at line 473 of file control.c.

References ast_calloc, ast_free_ptr(), and stasis_app_send_command_async().

Referenced by ast_ari_channels_move().

474 {
475  struct stasis_app_control_move_data *move_data;
476  size_t size;
477 
478  size = sizeof(*move_data) + strlen(app_name) + 1;
479  if (app_args) {
480  /* Application arguments are optional */
481  size += strlen(app_args) + 1;
482  }
483 
484  if (!(move_data = ast_calloc(1, size))) {
485  return -1;
486  }
487 
488  move_data->app_name = (char *)move_data + sizeof(*move_data);
489  strcpy(move_data->app_name, app_name); /* Safe */
490 
491  if (app_args) {
492  move_data->app_args = move_data->app_name + strlen(app_name) + 1;
493  strcpy(move_data->app_args, app_args); /* Safe */
494  } else {
495  move_data->app_args = NULL;
496  }
497 
498  stasis_app_send_command_async(control, app_control_move, move_data, ast_free_ptr);
499 
500  return 0;
501 }
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_mute ( struct stasis_app_control control,
unsigned int  direction,
enum ast_frame_type  frametype 
)

Mute the channel associated with this control.

Parameters
controlControl for res_stasis.
directionThe direction in which the audio should be muted.
frametypeThe type of stream that should be muted.
Returns
0 for success
-1 for error.

Definition at line 653 of file control.c.

References ast_calloc, ast_free_ptr(), and stasis_app_send_command_async().

Referenced by ast_ari_channels_mute().

654 {
655  struct stasis_app_control_mute_data *mute_data;
656 
657  if (!(mute_data = ast_calloc(1, sizeof(*mute_data)))) {
658  return -1;
659  }
660 
661  mute_data->direction = direction;
662  mute_data->frametype = frametype;
663 
664  stasis_app_send_command_async(control, app_control_mute, mute_data, ast_free_ptr);
665 
666  return 0;
667 }
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_mute_in_bridge ( struct stasis_app_control control,
int  mute 
)

Set whether audio from the channel is muted instead of passing through to the bridge.

Parameters
controlControl whose channel should have its audio muted when bridged
muteWhether audio should be muted (1) instead of passed through (0).

Definition at line 1492 of file control.c.

References stasis_app_control::bridge_features, and ast_bridge_features::mute.

Referenced by ast_ari_bridges_add_channel().

1494 {
1495  control->bridge_features->mute = mute;
1496 }
struct ast_bridge_features * bridge_features
Definition: control.c:70
void stasis_app_control_publish ( struct stasis_app_control control,
struct stasis_message message 
)

Publish a message to the control's channel's topic.

Parameters
controlControl to publish to
messageMessage to publish

Definition at line 1458 of file control.c.

References ast_channel_topic(), stasis_app_control::channel, and stasis_publish().

1460 {
1461  if (!control || !control->channel || !message) {
1462  return;
1463  }
1464  stasis_publish(ast_channel_topic(control->channel), message);
1465 }
struct ast_channel * channel
Definition: control.c:62
struct stasis_topic * ast_channel_topic(struct ast_channel *chan)
A topic which publishes the events for a particular channel.
void stasis_publish(struct stasis_topic *topic, struct stasis_message *message)
Publish a message to a topic's subscribers.
Definition: stasis.c:1511
int stasis_app_control_queue_control ( struct stasis_app_control control,
enum ast_control_frame_type  frame_type 
)

Queue a control frame without payload.

Parameters
controlControl to publish to.
frame_typetype of control frame.
Returns
zero on success
non-zero on failure

Definition at line 1467 of file control.c.

References ast_queue_control(), and stasis_app_control::channel.

1469 {
1470  return ast_queue_control(control->channel, frame_type);
1471 }
int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control)
Queue a control frame without payload.
Definition: channel.c:1231
struct ast_channel * channel
Definition: control.c:62
int stasis_app_control_redirect ( struct stasis_app_control control,
const char *  endpoint 
)

Redirect a channel in res_stasis to a particular endpoint.

Parameters
controlControl for res_stasis
endpointThe endpoint transfer string where the channel should be sent to
Returns
0 for success
-1 for error

Definition at line 522 of file control.c.

References ast_free_ptr(), ast_strdup, and stasis_app_send_command_async().

Referenced by ast_ari_channels_redirect().

523 {
524  char *endpoint_data = ast_strdup(endpoint);
525 
526  if (!endpoint_data) {
527  return -1;
528  }
529 
530  stasis_app_send_command_async(control, app_control_redirect, endpoint_data, ast_free_ptr);
531 
532  return 0;
533 }
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_register_add_rule ( struct stasis_app_control control,
struct stasis_app_control_rule rule 
)

Registers an add channel to bridge rule.

Parameters
controlControl object
ruleThe rule to register

Definition at line 232 of file control.c.

References stasis_app_control::add_rules.

Referenced by stasis_app_control_record().

235 {
236  return app_control_register_rule(control, &control->add_rules, rule);
237 }
struct app_control_rules add_rules
Definition: control.c:78
void stasis_app_control_register_remove_rule ( struct stasis_app_control control,
struct stasis_app_control_rule rule 
)

Registers a remove channel from bridge rule.

Parameters
controlControl object
ruleThe rule to register

Definition at line 246 of file control.c.

References stasis_app_control::remove_rules.

249 {
250  return app_control_register_rule(control, &control->remove_rules, rule);
251 }
struct app_control_rules remove_rules
Definition: control.c:82
int stasis_app_control_remove_channel_from_bridge ( struct stasis_app_control control,
struct ast_bridge bridge 
)

Remove a channel from the bridge.

Parameters
controlControl whose channel should be removed from the bridge
bridgePointer to the bridge
Returns
non-zero on failure
zero on success

Definition at line 1442 of file control.c.

References ast_debug, and stasis_app_control_get_channel_id().

Referenced by ast_ari_bridges_remove_channel().

1444 {
1445  ast_debug(3, "%s: Sending channel remove_from_bridge command\n",
1447  return app_send_command_on_condition(
1448  control, app_control_remove_channel_from_bridge, bridge, NULL,
1449  app_control_can_remove_channel_from_bridge);
1450 }
#define ast_debug(level,...)
Log a DEBUG message.
const char * stasis_app_control_get_channel_id(const struct stasis_app_control *control)
Returns the uniqueid of the channel associated with this control.
Definition: control.c:1452
int stasis_app_control_ring ( struct stasis_app_control control)

Indicate ringing to the channel associated with this control.

Parameters
controlControl for res_stasis.
Returns
0 for success.
-1 for error.

Definition at line 614 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_ring().

615 {
616  stasis_app_send_command_async(control, app_control_ring, NULL, NULL);
617 
618  return 0;
619 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_ring_stop ( struct stasis_app_control control)

Stop locally generated ringing on the channel associated with this control.

Parameters
controlControl for res_stasis.
Returns
0 for success.
-1 for error.

Definition at line 629 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_ring_stop().

630 {
631  stasis_app_send_command_async(control, app_control_ring_stop, NULL, NULL);
632 
633  return 0;
634 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_set_channel_var ( struct stasis_app_control control,
const char *  variable,
const char *  value 
)

Set a variable on the channel associated with this control to value.

Parameters
controlControl for res_stasis.
variableThe name of the variable
valueThe value to set the variable to
Returns
0 for success.
-1 for error.

Definition at line 733 of file control.c.

References ast_calloc, ast_strdup, chanvar::name, stasis_app_send_command_async(), and chanvar::value.

Referenced by ast_ari_channels_set_channel_var().

734 {
735  struct chanvar *var;
736 
737  var = ast_calloc(1, sizeof(*var));
738  if (!var) {
739  return -1;
740  }
741 
742  var->name = ast_strdup(variable);
743  if (!var->name) {
744  free_chanvar(var);
745  return -1;
746  }
747 
748  /* It's kosher for value to be NULL. It means the variable is being unset */
749  if (value) {
750  var->value = ast_strdup(value);
751  if (!var->value) {
752  free_chanvar(var);
753  return -1;
754  }
755  }
756 
757  stasis_app_send_command_async(control, app_control_set_channel_var, var, free_chanvar);
758 
759  return 0;
760 }
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
char * value
Definition: control.c:711
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
structure for queuing ARI channel variable setting
Definition: control.c:707
char * name
Definition: control.c:709
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_shutdown ( void  )

Let Stasis app internals shut down.

This is called when res_stasis is unloaded. It ensures that the Stasis app internals can free any resources they may have allocated during the time that res_stasis was loaded.

Definition at line 1702 of file control.c.

References ast_bridge_destroy(), and shutting_down.

1703 {
1704  ast_mutex_lock(&dial_bridge_lock);
1705  shutting_down = 1;
1706  if (dial_bridge) {
1708  dial_bridge = NULL;
1709  }
1710  ast_mutex_unlock(&dial_bridge_lock);
1711 }
int ast_bridge_destroy(struct ast_bridge *bridge, int cause)
Destroy a bridge.
Definition: bridge.c:944
static int shutting_down
Indicates if the Stasis app internals are being shut down.
Definition: control.c:51
static struct ast_bridge * dial_bridge
Singleton dial bridge.
Definition: control.c:980
void stasis_app_control_silence_start ( struct stasis_app_control control)

Start playing silence to a channel.

Parameters
controlControl for res_stasis.

Definition at line 854 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_start_silence().

855 {
856  stasis_app_send_command_async(control, app_control_silence_start, NULL, NULL);
857 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_silence_stop ( struct stasis_app_control control)

Stop playing silence to a channel.

Parameters
controlControl for res_stasis.

Definition at line 877 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_stop_silence().

878 {
879  stasis_app_send_command_async(control, app_control_silence_stop, NULL, NULL);
880 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_unhold ( struct stasis_app_control control)

Remove the channel associated with the control from hold.

Parameters
controlControl for res_stasis.

Definition at line 783 of file control.c.

References stasis_app_send_command_async().

Referenced by ast_ari_channels_unhold().

784 {
785  stasis_app_send_command_async(control, app_control_unhold, NULL, NULL);
786 }
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
int stasis_app_control_unmute ( struct stasis_app_control control,
unsigned int  direction,
enum ast_frame_type  frametype 
)

Unmute the channel associated with this control.

Parameters
controlControl for res_stasis.
directionThe direction in which the audio should be unmuted.
frametypeThe type of stream that should be unmuted.
Returns
0 for success
-1 for error.

Definition at line 681 of file control.c.

References ast_calloc, ast_free_ptr(), and stasis_app_send_command_async().

Referenced by ast_ari_channels_unmute().

682 {
683  struct stasis_app_control_mute_data *mute_data;
684 
685  if (!(mute_data = ast_calloc(1, sizeof(*mute_data)))) {
686  return -1;
687  }
688 
689  mute_data->direction = direction;
690  mute_data->frametype = frametype;
691 
692  stasis_app_send_command_async(control, app_control_unmute, mute_data, ast_free_ptr);
693 
694  return 0;
695 }
void ast_free_ptr(void *ptr)
free() wrapper
Definition: main/astmm.c:1739
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
int stasis_app_send_command_async(struct stasis_app_control *control, stasis_app_command_cb command_fn, void *data, command_data_destructor_fn data_destructor)
Asynchronous version of stasis_app_send_command().
Definition: control.c:926
void stasis_app_control_unregister_add_rule ( struct stasis_app_control control,
struct stasis_app_control_rule rule 
)

UnRegister an add channel to bridge rule.

Parameters
controlControl object
ruleThe rule to unregister

Definition at line 239 of file control.c.

References stasis_app_control::add_rules.

242 {
243  app_control_unregister_rule(control, &control->add_rules, rule);
244 }
struct app_control_rules add_rules
Definition: control.c:78
void stasis_app_control_unregister_remove_rule ( struct stasis_app_control control,
struct stasis_app_control_rule rule 
)

Unregisters a remove channel from bridge rule.

Parameters
controlControl object
ruleThe rule to unregister

Definition at line 253 of file control.c.

References stasis_app_control::remove_rules.

256 {
257  app_control_unregister_rule(control, &control->remove_rules, rule);
258 }
struct app_control_rules remove_rules
Definition: control.c:82
int stasis_app_event_allowed ( const char *  app_name,
struct ast_json event 
)

Check if the given event should be filtered.

Attempts first to find the event in the application's disallowed events list. If found then the event won't be sent to the remote. If not found in the disallowed list then a search is done to see if it can be found in the allowed list. If found the event message is sent, otherwise it is not sent.

Parameters
app_nameThe application name
eventThe event to check
Returns
True if allowed, false otherwise

Definition at line 1734 of file res/stasis/app.c.

References ao2_ref, stasis_app::events_allowed, stasis_app::events_disallowed, and stasis_app_get_by_name().

Referenced by stasis_app_message_handler().

1735 {
1737  int res;
1738 
1739  if (!app) {
1740  return 0;
1741  }
1742 
1743  ao2_lock(app);
1744  res = !app_event_filter_matched(app->events_disallowed, event, 0) &&
1745  app_event_filter_matched(app->events_allowed, event, 1);
1746  ao2_unlock(app);
1747  ao2_ref(app, -1);
1748 
1749  return res;
1750 }
struct ast_json * events_allowed
struct stasis_app * stasis_app_get_by_name(const char *name)
Retrieve a handle to a Stasis application by its name.
Definition: res_stasis.c:1701
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
struct ast_json * events_disallowed
int stasis_app_event_filter_set ( struct stasis_app app,
struct ast_json filter 
)

Set the application's event type filter.

Parameters
appThe application
filterThe allowed and/or disallowed event filter
Returns
0 if successfully set

Definition at line 1708 of file res/stasis/app.c.

Referenced by ast_ari_applications_filter().

1709 {
1710  return app_events_disallowed_set(app, filter) || app_events_allowed_set(app, filter);
1711 }
struct ast_json* stasis_app_event_filter_to_json ( struct stasis_app app,
struct ast_json json 
)

Convert and add the app's event type filter(s) to the given json object.

Parameters
appThe application
jsonThe json object to add the filter data to
Returns
The given json object

Definition at line 1636 of file res/stasis/app.c.

References ast_json_array_create(), ast_json_object_set(), ast_json_ref(), stasis_app::events_allowed, and stasis_app::events_disallowed.

Referenced by stasis_app_object_to_json().

1637 {
1638  if (!app || !json) {
1639  return json;
1640  }
1641 
1642  ast_json_object_set(json, "events_allowed", app->events_allowed ?
1644  ast_json_object_set(json, "events_disallowed", app->events_disallowed ?
1646 
1647  return json;
1648 }
struct ast_json * events_allowed
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition: json.c:67
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition: json.c:414
struct ast_json * ast_json_array_create(void)
Create a empty JSON array.
Definition: json.c:362
struct ast_json * events_disallowed
struct ao2_container* stasis_app_get_all ( void  )

Gets the names of all registered Stasis applications.

Returns
ast_str_container of container names.
Return values
NULLon error.

Definition at line 1715 of file res_stasis.c.

References ao2_callback, ast_str_container_alloc, and OBJ_NODATA.

Referenced by ast_ari_applications_list(), and stasis_app_set_global_debug().

1716 {
1717  struct ao2_container *apps;
1718 
1719  if (!apps_registry) {
1720  return NULL;
1721  }
1722 
1723  apps = ast_str_container_alloc(1);
1724  if (!apps) {
1725  return NULL;
1726  }
1727 
1728  ao2_callback(apps_registry, OBJ_NODATA, append_name, apps);
1729 
1730  return apps;
1731 }
Registered applications container.
Definition: pbx_app.c:67
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container, as described below.
Definition: astobj2.h:1693
#define ast_str_container_alloc(buckets)
Allocates a hash container for bare strings.
Definition: strings.h:1365
struct ao2_container * apps_registry
Stasis application container.
Definition: res_stasis.c:100
Generic container type.
struct ast_bridge* stasis_app_get_bridge ( struct stasis_app_control control)

Gets the bridge currently associated with a control object.

Since
12
Note
If the bridge returned by this function is to be held for any length of time, its refcount should be incremented until the caller is finished with it.
Parameters
controlControl object for the channel to query.
Returns
Associated ast_bridge.
Return values
NULLif not associated with a bridge.

Definition at line 953 of file control.c.

References stasis_app_control::bridge.

Referenced by ast_ari_bridges_remove_channel(), ast_ari_bridges_set_video_source(), control_swap_channel_in_bridge(), and stasis_app_exec().

954 {
955  struct ast_bridge *ret;
956 
957  if (!control) {
958  return NULL;
959  }
960 
961  ao2_lock(control);
962  ret = control->bridge;
963  ao2_unlock(control);
964 
965  return ret;
966 }
Structure that contains information about a bridge.
Definition: bridge.h:349
struct ast_bridge * bridge
Definition: control.c:66
struct stasis_app* stasis_app_get_by_name ( const char *  name)

Retrieve a handle to a Stasis application by its name.

Parameters
nameThe name of the registered Stasis application
Returns
stasis_app on success.
Return values
NULLon error.

Definition at line 1701 of file res_stasis.c.

Referenced by ast_ari_applications_filter(), stasis_app_event_allowed(), stasis_app_get_debug_by_name(), stasis_app_set_debug_by_name(), and stasis_app_set_global_debug().

1702 {
1703  return find_app_by_name(name);
1704 }
const ast_string_field name
Definition: bridge.h:401
int stasis_app_get_debug ( struct stasis_app app)

Get debug status of an application.

Parameters
appThe app to check
Returns
The debug flag for the app || the global debug flag

Definition at line 863 of file res/stasis/app.c.

References stasis_app::debug, and global_debug.

864 {
865  return (app ? app->debug : 0) || global_debug;
866 }
int global_debug
int stasis_app_get_debug_by_name ( const char *  app_name)

Get debug status of an application.

Parameters
app_nameThe app_name to check
Returns
The debug flag for the app || the global debug flag

Definition at line 868 of file res/stasis/app.c.

References ao2_ref, stasis_app::debug, global_debug, and stasis_app_get_by_name().

Referenced by stasis_app_message_handler().

869 {
870  int debug_enabled = 0;
871 
872  if (global_debug) {
873  debug_enabled = 1;
874  } else {
876 
877  if (app) {
878  if (app->debug) {
879  debug_enabled = 1;
880  }
881  ao2_ref(app, -1);
882  }
883  }
884  return debug_enabled;
885 }
struct stasis_app * stasis_app_get_by_name(const char *name)
Retrieve a handle to a Stasis application by its name.
Definition: res_stasis.c:1701
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
int global_debug
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
struct stasis_message_sanitizer* stasis_app_get_sanitizer ( void  )

Get the Stasis message sanitizer for app_stasis applications.

Return values
Thestasis message sanitizer

Definition at line 2271 of file res_stasis.c.

References app_sanitizer.

Referenced by app_send_end_msg(), ast_ari_bridges_create(), ast_ari_bridges_create_with_id(), ast_ari_bridges_get(), ast_ari_bridges_list(), ast_ari_channels_list(), ast_ari_endpoints_get(), ast_ari_endpoints_list(), and ast_ari_endpoints_list_by_tech().

2272 {
2273  return &app_sanitizer;
2274 }
struct stasis_message_sanitizer app_sanitizer
Sanitization callbacks for communication to Stasis applications.
Definition: res_stasis.c:2265
const char* stasis_app_name ( const struct stasis_app app)

Retrieve an application's name.

Parameters
appAn application
Returns
The name of the application.

Definition at line 1151 of file res/stasis/app.c.

References stasis_app::name.

Referenced by app_compare(), app_hash(), app_send_end_msg(), and stasis_app_exec().

1152 {
1153  return app->name;
1154 }
struct ast_json* stasis_app_object_to_json ( struct stasis_app app)

Return the JSON representation of a Stasis application.

Since
16.3.0
Parameters
appThe application.
Returns
JSON representation of app with given name.
Return values
NULLon error.

Definition at line 1873 of file res_stasis.c.

References app_to_json(), and stasis_app_event_filter_to_json().

Referenced by ast_ari_applications_filter(), and stasis_app_to_json().

1874 {
1875  if (!app) {
1876  return NULL;
1877  }
1878 
1880  app, app_event_sources_to_json(app, app_to_json(app)));
1881 }
struct ast_json * stasis_app_event_filter_to_json(struct stasis_app *app, struct ast_json *json)
Convert and add the app's event type filter(s) to the given json object.
struct ast_json * app_to_json(const struct stasis_app *app)
Create a JSON representation of a stasis_app.
int stasis_app_register ( const char *  app_name,
stasis_app_cb  handler,
void *  data 
)

Register a new Stasis application.

If an application is already registered with the given name, the old application is sent a 'replaced' message and unregistered.

Parameters
app_nameName of this application.
handlerCallback for application messages.
dataData blob to pass to the callback. Must be AO2 managed.
Returns
0 for success
-1 for error.

Definition at line 1784 of file res_stasis.c.

Referenced by event_session_alloc().

1785 {
1786  return __stasis_app_register(app_name, handler, data, 0);
1787 }
stasis_app_cb handler
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
int stasis_app_register_all ( const char *  app_name,
stasis_app_cb  handler,
void *  data 
)

Register a new Stasis application that receives all Asterisk events.

If an application is already registered with the given name, the old application is sent a 'replaced' message and unregistered.

Parameters
app_nameName of this application.
handlerCallback for application messages.
dataData blob to pass to the callback. Must be AO2 managed.
Returns
0 for success
-1 for error.

Definition at line 1789 of file res_stasis.c.

Referenced by event_session_alloc().

1790 {
1791  return __stasis_app_register(app_name, handler, data, 1);
1792 }
stasis_app_cb handler
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
void stasis_app_register_event_source ( struct stasis_app_event_source obj)

Register an application event source.

Parameters
objthe event source to register

Definition at line 1823 of file res_stasis.c.

References AST_LIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by stasis_app_register_event_sources().

1824 {
1826  AST_LIST_INSERT_TAIL(&event_sources, obj, next);
1828 }
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
int stasis_app_send ( const char *  app_name,
struct ast_json message 
)

Send a message to the given Stasis application.

The message given to the handler is a borrowed copy. If you want to keep a reference to it, you should use ao2_ref() to keep it around.

Parameters
app_nameName of the application to invoke.
messageMessage to send (borrowed reference)
Returns
0 for success.
-1 for error.

Definition at line 1663 of file res_stasis.c.

References ao2_ref, app_send(), and OBJ_SEARCH_KEY.

1664 {
1665  struct stasis_app *app;
1666 
1667  if (!apps_registry) {
1668  return -1;
1669  }
1670 
1671  app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1672  if (!app) {
1673  /* XXX We can do a better job handling late binding, queueing up
1674  * the call for a few seconds to wait for the app to register.
1675  */
1676  ast_log(LOG_WARNING,
1677  "Stasis app '%s' not registered\n", app_name);
1678  return -1;
1679  }
1680  app_send(app, message);
1681  ao2_ref(app, -1);
1682 
1683  return 0;
1684 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
void app_send(struct stasis_app *app, struct ast_json *message)
Send a message to an application.
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
struct ao2_container * apps_registry
Stasis application container.
Definition: res_stasis.c:100
void stasis_app_set_debug ( struct stasis_app app,
int  debug 
)

Enable/disable request/response and event logging on an application.

Parameters
appThe app to debug
debugIf non-zero, enable debugging. If zero, disable.

Definition at line 842 of file res/stasis/app.c.

References stasis_app::debug, and debug.

Referenced by stasis_app_set_global_debug().

843 {
844  if (!app) {
845  return;
846  }
847 
848  app->debug = debug;
849 }
static int debug
Global debug status.
Definition: res_xmpp.c:441
void stasis_app_set_debug_by_name ( const char *  app_name,
int  debug 
)

Enable/disable request/response and event logging on an application.

Parameters
app_nameThe app name to debug
debugIf non-zero, enable debugging. If zero, disable.

Definition at line 851 of file res/stasis/app.c.

References stasis_app::debug, debug, and stasis_app_get_by_name().

852 {
854 
855  if (!app) {
856  return;
857  }
858 
859  app->debug = debug;
860  ao2_cleanup(app);
861 }
struct stasis_app * stasis_app_get_by_name(const char *name)
Retrieve a handle to a Stasis application by its name.
Definition: res_stasis.c:1701
static int debug
Global debug status.
Definition: res_xmpp.c:441
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
void stasis_app_set_global_debug ( int  debug)

Enable/disable request/response and event logging on all applications.

Parameters
debugIf non-zero, enable debugging. If zero, disable.

Definition at line 887 of file res/stasis/app.c.

References ao2_container_count(), ao2_iterator_init(), app_name(), debug, global_debug, stasis_app_get_all(), stasis_app_get_by_name(), and stasis_app_set_debug().

888 {
890  if (!global_debug) {
891  struct ao2_container *app_names = stasis_app_get_all();
892  struct ao2_iterator it_app_names;
893  char *app_name;
894  struct stasis_app *app;
895 
896  if (!app_names || !ao2_container_count(app_names)) {
897  ao2_cleanup(app_names);
898  return;
899  }
900 
901  it_app_names = ao2_iterator_init(app_names, 0);
902  while ((app_name = ao2_iterator_next(&it_app_names))) {
903  if ((app = stasis_app_get_by_name(app_name))) {
904  stasis_app_set_debug(app, 0);
905  }
906 
907  ao2_cleanup(app_name);
908  ao2_cleanup(app);
909  }
910  ao2_iterator_cleanup(&it_app_names);
911  ao2_cleanup(app_names);
912  }
913 }
struct stasis_app * stasis_app_get_by_name(const char *name)
Retrieve a handle to a Stasis application by its name.
Definition: res_stasis.c:1701
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
static int debug
Global debug status.
Definition: res_xmpp.c:441
void stasis_app_set_debug(struct stasis_app *app, int debug)
Enable/disable request/response and event logging on an application.
int global_debug
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
struct ao2_container * stasis_app_get_all(void)
Gets the names of all registered Stasis applications.
Definition: res_stasis.c:1715
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
Generic container type.
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
enum stasis_app_subscribe_res stasis_app_subscribe ( const char *  app_name,
const char **  event_source_uris,
int  event_sources_count,
struct ast_json **  json 
)

Subscribes an application to a list of event sources.

Parameters
app_nameName of the application to subscribe.
event_source_urisURIs for the event sources to subscribe to.
event_sources_countArray size of event_source_uris.
jsonOptional output pointer for JSON representation of the app after adding the subscription.
Returns
stasis_app_subscribe_res return code.
Note
Do not hold any channel locks if subscribing to a channel.

Definition at line 2052 of file res_stasis.c.

Referenced by ast_ari_applications_subscribe().

2055 {
2056  return app_handle_subscriptions(
2057  app_name, event_source_uris, event_sources_count,
2058  json, app_subscribe);
2059 }
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
enum stasis_app_subscribe_res stasis_app_subscribe_channel ( const char *  app_name,
struct ast_channel chan 
)

Directly subscribe an application to a channel.

Parameters
app_nameName of the application to subscribe.
chanThe channel to subscribe to
Returns
stasis_app_subscribe_res return code.
Note
This method can be used when you already hold a channel and its lock. This bypasses the channel lookup that would normally be performed by stasis_app_subscribe.

Definition at line 1991 of file res_stasis.c.

References ao2_ref, app_subscribe_channel(), and ast_debug.

Referenced by ast_ari_channels_create().

1993 {
1994  struct stasis_app *app = find_app_by_name(app_name);
1995  int res;
1996 
1997  if (!app) {
1998  return STASIS_ASR_APP_NOT_FOUND;
1999  }
2000 
2001  ast_debug(3, "%s: Subscribing to %s\n", app_name, ast_channel_uniqueid(chan));
2002 
2003  res = app_subscribe_channel(app, chan);
2004  ao2_ref(app, -1);
2005 
2006  if (res != 0) {
2007  ast_log(LOG_ERROR, "Error subscribing app '%s' to channel '%s'\n",
2008  app_name, ast_channel_uniqueid(chan));
2009  return STASIS_ASR_INTERNAL_ERROR;
2010  }
2011 
2012  return STASIS_ASR_OK;
2013 }
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ast_debug(level,...)
Log a DEBUG message.
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
int app_subscribe_channel(struct stasis_app *app, struct ast_channel *chan)
Subscribes an application to a channel.
void stasis_app_to_cli ( const struct stasis_app app,
struct ast_cli_args a 
)

Dump properties of a stasis_app to the CLI.

Parameters
appThe application
aThe CLI arguments

Definition at line 1168 of file res/stasis/app.c.

References ao2_callback, ao2_container_count(), ao2_iterator_destroy(), ao2_ref, bridges, stasis_app::debug, endpoints, stasis_app::forwards, app_forwards::id, app_forwards::interested, stasis_app::name, OBJ_MULTIPLE, STASIS_APP_SUBSCRIBE_ALL, and stasis_app::subscription_model.

1169 {
1170  struct ao2_iterator *channels;
1171  struct ao2_iterator *endpoints;
1172  struct ao2_iterator *bridges;
1173  struct app_forwards *forward;
1174  enum forward_type forward_type;
1175 
1176  ast_cli(a->fd, "Name: %s\n"
1177  " Debug: %s\n"
1178  " Subscription Model: %s\n",
1179  app->name,
1180  app->debug ? "Yes" : "No",
1182  "Global Resource Subscription" :
1183  "Application/Explicit Resource Subscription");
1184  ast_cli(a->fd, " Subscriptions: %d\n", ao2_container_count(app->forwards));
1185 
1186  ast_cli(a->fd, " Channels:\n");
1187  forward_type = FORWARD_CHANNEL;
1188  channels = ao2_callback(app->forwards, OBJ_MULTIPLE,
1189  forwards_filter_by_type, &forward_type);
1190  if (channels) {
1191  while ((forward = ao2_iterator_next(channels))) {
1192  ast_cli(a->fd, " %s (%d)\n", forward->id, forward->interested);
1193  ao2_ref(forward, -1);
1194  }
1195  ao2_iterator_destroy(channels);
1196  }
1197 
1198  ast_cli(a->fd, " Bridges:\n");
1199  forward_type = FORWARD_BRIDGE;
1200  bridges = ao2_callback(app->forwards, OBJ_MULTIPLE,
1201  forwards_filter_by_type, &forward_type);
1202  if (bridges) {
1203  while ((forward = ao2_iterator_next(bridges))) {
1204  ast_cli(a->fd, " %s (%d)\n", forward->id, forward->interested);
1205  ao2_ref(forward, -1);
1206  }
1207  ao2_iterator_destroy(bridges);
1208  }
1209 
1210  ast_cli(a->fd, " Endpoints:\n");
1211  forward_type = FORWARD_ENDPOINT;
1212  endpoints = ao2_callback(app->forwards, OBJ_MULTIPLE,
1213  forwards_filter_by_type, &forward_type);
1214  if (endpoints) {
1215  while ((forward = ao2_iterator_next(endpoints))) {
1216  ast_cli(a->fd, " %s (%d)\n", forward->id, forward->interested);
1217  ao2_ref(forward, -1);
1218  }
1219  ao2_iterator_destroy(endpoints);
1220  }
1221 }
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container, as described below.
Definition: astobj2.h:1693
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
struct ao2_container * forwards
An application is automatically subscribed to all resources in Asterisk, even if it does not control ...
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
static struct ao2_container * bridges
Definition: bridge.c:123
static struct stasis_rest_handlers endpoints
REST handler for /api-docs/endpoints.json.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
enum stasis_app_subscription_model subscription_model
struct ast_json* stasis_app_to_json ( const char *  app_name)

Return the JSON representation of a Stasis application.

Parameters
app_nameName of the application.
Returns
JSON representation of app with given name.
Return values
NULLon error.

Definition at line 1883 of file res_stasis.c.

References stasis_app_object_to_json().

Referenced by ast_ari_applications_get().

1884 {
1885  struct stasis_app *app = find_app_by_name(app_name);
1886  struct ast_json *json = stasis_app_object_to_json(app);
1887 
1888  ao2_cleanup(app);
1889 
1890  return json;
1891 }
struct ast_json * stasis_app_object_to_json(struct stasis_app *app)
Return the JSON representation of a Stasis application.
Definition: res_stasis.c:1873
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
Abstract JSON element (object, array, string, int, ...).
void stasis_app_unregister ( const char *  app_name)

Unregister a Stasis application.

Parameters
app_nameName of the application to unregister.

Definition at line 1794 of file res_stasis.c.

References ao2_ref, app_deactivate(), cleanup(), and OBJ_SEARCH_KEY.

Referenced by event_session_shutdown().

1795 {
1796  struct stasis_app *app;
1797 
1798  if (!app_name) {
1799  return;
1800  }
1801 
1802  if (!apps_registry) {
1803  return;
1804  }
1805 
1806  app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1807  if (!app) {
1808  ast_log(LOG_ERROR,
1809  "Stasis app '%s' not registered\n", app_name);
1810  return;
1811  }
1812 
1813  app_deactivate(app);
1814 
1815  /* There's a decent chance that app is ready for cleanup. Go ahead
1816  * and clean up, just in case
1817  */
1818  cleanup();
1819 
1820  ao2_ref(app, -1);
1821 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
void app_deactivate(struct stasis_app *app)
Deactivates an application.
static void cleanup(void)
Clean up any old apps that we don't need any more.
Definition: res_stasis.c:327
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
struct ao2_container * apps_registry
Stasis application container.
Definition: res_stasis.c:100
void stasis_app_unregister_event_source ( struct stasis_app_event_source obj)

Unregister an application event source.

Parameters
objthe event source to unregister

Definition at line 1830 of file res_stasis.c.

References AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by stasis_app_unregister_event_sources().

1831 {
1832  struct stasis_app_event_source *source;
1833 
1835  AST_RWLIST_TRAVERSE_SAFE_BEGIN(&event_sources, source, next) {
1836  if (source == obj) {
1837  AST_RWLIST_REMOVE_CURRENT(next);
1838  break;
1839  }
1840  }
1841  AST_RWLIST_TRAVERSE_SAFE_END;
1843 }
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
Event source information and callbacks.
Definition: stasis_app.h:174
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
enum stasis_app_subscribe_res stasis_app_unsubscribe ( const char *  app_name,
const char **  event_source_uris,
int  event_sources_count,
struct ast_json **  json 
)

Unsubscribes an application from a list of event sources.

Parameters
app_nameName of the application to subscribe.
event_source_urisURIs for the event sources to subscribe to.
event_sources_countArray size of event_source_uris.
jsonOptional output pointer for JSON representation of the app after adding the subscription.
Returns
stasis_app_subscribe_res return code.

Definition at line 2093 of file res_stasis.c.

Referenced by ast_ari_applications_unsubscribe().

2096 {
2097  return app_handle_subscriptions(
2098  app_name, event_source_uris, event_sources_count,
2099  json, app_unsubscribe);
2100 }
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
enum stasis_app_user_event_res stasis_app_user_event ( const char *  app_name,
const char *  event_name,
const char **  source_uris,
int  sources_count,
struct ast_json json_variables 
)

Generate a Userevent for stasis app (echo to AMI)

Parameters
app_nameName of the application to generate event for/to.
event_nameName of the Userevent.
source_urisURIs for the source objects to attach to event.
sources_countArray size of source_uris.
json_variablesevent blob variables.
Returns
stasis_app_user_event_res return code.

Definition at line 2102 of file res_stasis.c.

References ao2_ref, ast_app_get_topic(), ast_begins_with(), ast_bridge_get_snapshot_by_uniqueid(), ast_channel_snapshot_get_latest(), ast_endpoint_latest_snapshot(), ast_json_object_set(), ast_json_pack(), ast_json_ref(), ast_json_string_create(), ast_json_unref(), ast_manager_get_topic(), ast_multi_object_blob_add(), ast_multi_object_blob_create(), ast_multi_user_event_type(), RAII_VAR, stasis_message_create(), stasis_publish(), STASIS_UMOS_BRIDGE, STASIS_UMOS_CHANNEL, and STASIS_UMOS_ENDPOINT.

Referenced by ast_ari_events_user_event().

2106 {
2107  RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
2108  struct ast_json *blob = NULL;
2109  struct ast_multi_object_blob *multi;
2110  struct stasis_message *message;
2111  enum stasis_app_user_event_res res = STASIS_APP_USER_INTERNAL_ERROR;
2112  int have_channel = 0;
2113  int i;
2114 
2115  if (!app) {
2116  ast_log(LOG_WARNING, "App %s not found\n", app_name);
2117  return STASIS_APP_USER_APP_NOT_FOUND;
2118  }
2119 
2120  if (!ast_multi_user_event_type()) {
2121  return res;
2122  }
2123 
2124  if (json_variables) {
2125  struct ast_json *json_value = ast_json_string_create(event_name);
2126 
2127  if (json_value && !ast_json_object_set(json_variables, "eventname", json_value)) {
2128  blob = ast_json_ref(json_variables);
2129  }
2130  } else {
2131  blob = ast_json_pack("{s: s}", "eventname", event_name);
2132  }
2133 
2134  if (!blob) {
2135  ast_log(LOG_ERROR, "Failed to initialize blob\n");
2136 
2137  return res;
2138  }
2139 
2140  multi = ast_multi_object_blob_create(blob);
2141  ast_json_unref(blob);
2142  if (!multi) {
2143  ast_log(LOG_ERROR, "Failed to initialize multi\n");
2144 
2145  return res;
2146  }
2147 
2148  for (i = 0; i < sources_count; ++i) {
2149  const char *uri = source_uris[i];
2150  void *snapshot=NULL;
2152 
2153  if (ast_begins_with(uri, "channel:")) {
2154  type = STASIS_UMOS_CHANNEL;
2155  snapshot = ast_channel_snapshot_get_latest(uri + 8);
2156  have_channel = 1;
2157  } else if (ast_begins_with(uri, "bridge:")) {
2158  type = STASIS_UMOS_BRIDGE;
2159  snapshot = ast_bridge_get_snapshot_by_uniqueid(uri + 7);
2160  } else if (ast_begins_with(uri, "endpoint:")) {
2161  type = STASIS_UMOS_ENDPOINT;
2162  snapshot = ast_endpoint_latest_snapshot(uri + 9, NULL);
2163  } else {
2164  ast_log(LOG_WARNING, "Invalid scheme: %s\n", uri);
2165  ao2_ref(multi, -1);
2166 
2167  return STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME;
2168  }
2169  if (!snapshot) {
2170  ast_log(LOG_ERROR, "Unable to get snapshot for %s\n", uri);
2171  ao2_ref(multi, -1);
2172 
2173  return STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND;
2174  }
2175  ast_multi_object_blob_add(multi, type, snapshot);
2176  }
2177 
2179  ao2_ref(multi, -1);
2180 
2181  if (!message) {
2182  ast_log(LOG_ERROR, "Unable to create stasis user event message\n");
2183  return res;
2184  }
2185 
2186  /*
2187  * Publishing to two different topics is normally to be avoided -- except
2188  * in this case both are final destinations with no forwards (only listeners).
2189  * The message has to be delivered to the application topic for ARI, but a
2190  * copy is also delivered directly to the manager for AMI if there is a channel.
2191  */
2192  stasis_publish(ast_app_get_topic(app), message);
2193 
2194  if (have_channel) {
2196  }
2197  ao2_ref(message, -1);
2198 
2199  return STASIS_APP_USER_OK;
2200 }
struct stasis_topic * ast_app_get_topic(struct stasis_app *app)
Returns the stasis topic for an app.
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition: json.c:67
struct ast_multi_object_blob * ast_multi_object_blob_create(struct ast_json *blob)
Create a stasis multi object blob.
Definition: stasis.c:1975
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition: json.c:612
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
struct ast_bridge_snapshot * ast_bridge_get_snapshot_by_uniqueid(const char *uniqueid)
Returns the current snapshot for the bridge.
struct ast_endpoint_snapshot * ast_endpoint_latest_snapshot(const char *tech, const char *resource)
Retrieve the most recent snapshot for the endpoint with the given name.
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition: json.c:414
A multi object blob data structure to carry user event stasis messages.
Definition: stasis.c:1950
struct ast_json * ast_json_string_create(const char *value)
Construct a JSON string from value.
Definition: json.c:278
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
stasis_user_multi_object_snapshot_type
Object type code for multi user object snapshots.
Definition: stasis.h:1353
struct stasis_message * stasis_message_create(struct stasis_message_type *type, void *data)
Create a new message.
const char * app_name(struct ast_app *app)
Definition: pbx_app.c:463
void stasis_publish(struct stasis_topic *topic, struct stasis_message *message)
Publish a message to a topic's subscribers.
Definition: stasis.c:1511
struct stasis_topic * ast_manager_get_topic(void)
Get the Stasis Message Bus API topic for AMI.
Definition: manager.c:1880
void ast_multi_object_blob_add(struct ast_multi_object_blob *multi, enum stasis_user_multi_object_snapshot_type type, void *object)
Add an object to a multi object blob previously created.
Definition: stasis.c:2001
struct stasis_message_type * ast_multi_user_event_type(void)
Message type for custom user defined events with multi object blobs.
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object...
stasis_app_user_event_res
Return code for stasis_app_user_event.
Definition: stasis_app.h:255
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition: strings.h:97
Abstract JSON element (object, array, string, int, ...).
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941