ARI: allow other operations to happen while bridged
[asterisk/asterisk.git] / include / asterisk / stasis_app.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_STASIS_APP_H
20 #define _ASTERISK_STASIS_APP_H
21
22 /*! \file
23  *
24  * \brief Stasis Application API. See \ref res_stasis "Stasis Application API"
25  * for detailed documentation.
26  *
27  * \author David M. Lee, II <dlee@digium.com>
28  * \since 12
29  *
30  * \page res_stasis Stasis Application API
31  *
32  * This is the API that binds the Stasis dialplan application to external
33  * Stasis applications, such as \c res_stasis_websocket.
34  *
35  * The associated \c res_stasis module registers a dialplan function named \c
36  * Stasis, which uses \c res_stasis to put a channel into the named Stasis
37  * app. As a channel enters and leaves the Stasis diaplan application, the
38  * Stasis app receives a \c 'stasis-start' and \c 'stasis-end' events.
39  *
40  * Stasis apps register themselves using the \ref stasis_app_register and
41  * stasis_app_unregister functions. Messages are sent to an appliction using
42  * \ref stasis_app_send.
43  *
44  * Finally, Stasis apps control channels through the use of the \ref
45  * stasis_app_control object, and the family of \c stasis_app_control_*
46  * functions.
47  *
48  * Since module unload order is based on reference counting, any module that
49  * uses the API defined in this file must call stasis_app_ref() when loaded,
50  * and stasis_app_unref() when unloaded.
51  */
52
53 #include "asterisk/channel.h"
54 #include "asterisk/json.h"
55
56 /*! @{ */
57
58 /*!
59  * \brief Callback for Stasis application handler.
60  *
61  * The message given to the handler is a borrowed copy. If you want to keep a
62  * reference to it, you should use \c ao2_ref() to keep it around.
63  *
64  * \param data Data ptr given when registered.
65  * \param app_name Name of the application being dispatched to.
66  * \param message Message to handle. (borrowed copy)
67  */
68 typedef void (*stasis_app_cb)(void *data, const char *app_name,
69         struct ast_json *message);
70
71 /*!
72  * \brief Register a new Stasis application.
73  *
74  * If an application is already registered with the given name, the old
75  * application is sent a 'replaced' message and unregistered.
76  *
77  * \param app_name Name of this application.
78  * \param handler Callback for application messages.
79  * \param data Data blob to pass to the callback. Must be AO2 managed.
80  * \return 0 for success
81  * \return -1 for error.
82  */
83 int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data);
84
85 /*!
86  * \brief Unregister a Stasis application.
87  * \param app_name Name of the application to unregister.
88  */
89 void stasis_app_unregister(const char *app_name);
90
91 /*!
92  * \brief Send a message to the given Stasis application.
93  *
94  * The message given to the handler is a borrowed copy. If you want to keep a
95  * reference to it, you should use \c ao2_ref() to keep it around.
96  *
97  * \param app_name Name of the application to invoke.
98  * \param message Message to send (borrowed reference)
99  * \return 0 for success.
100  * \return -1 for error.
101  */
102 int stasis_app_send(const char *app_name, struct ast_json *message);
103
104 /*! @} */
105
106 /*! @{ */
107
108 /*! \brief Handler for controlling a channel that's in a Stasis application */
109 struct stasis_app_control;
110
111 /*!
112  * \brief Returns the handler for the given channel.
113  * \param chan Channel to handle.
114  * \return NULL channel not in Stasis application.
115  * \return Pointer to \c res_stasis handler.
116  */
117 struct stasis_app_control *stasis_app_control_find_by_channel(
118         const struct ast_channel *chan);
119
120 /*!
121  * \brief Returns the handler for the channel with the given id.
122  * \param channel_id Uniqueid of the channel.
123  * \return NULL channel not in Stasis application, or channel does not exist.
124  * \return Pointer to \c res_stasis handler.
125  */
126 struct stasis_app_control *stasis_app_control_find_by_channel_id(
127         const char *channel_id);
128
129 /*!
130  * \brief Creates a control handler for a channel that isn't in a stasis app.
131  * \since 12.0.0
132  *
133  * \param chan Channel to create controller handle for
134  *
135  * \return NULL on failure to create the handle
136  * \return Pointer to \c res_stasis handler.
137  */
138 struct stasis_app_control *stasis_app_control_create(
139         struct ast_channel *chan);
140
141 /*!
142  * \brief Act on a stasis app control queue until it is empty
143  * \since 12.0.0
144  *
145  * \param chan Channel to handle
146  * \param control Control object to execute
147  */
148 void stasis_app_control_execute_until_exhausted(
149         struct ast_channel *chan,
150         struct stasis_app_control *control);
151
152 /*!
153  * \brief Returns the uniqueid of the channel associated with this control
154  *
155  * \param control Control object.
156  * \return Uniqueid of the associate channel.
157  * \return \c NULL if \a control is \c NULL.
158  */
159 const char *stasis_app_control_get_channel_id(
160         const struct stasis_app_control *control);
161
162 /*!
163  * \brief Dial an endpoint and bridge it to a channel in \c res_stasis
164  *
165  * If the channel is no longer in \c res_stasis, this function does nothing.
166  *
167  * \param control Control for \c res_stasis
168  * \param endpoint The endpoint to dial.
169  * \param timeout The amount of time to wait for answer, before giving up.
170  *
171  * \return 0 for success
172  * \return -1 for error.
173  */
174 int stasis_app_control_dial(struct stasis_app_control *control, const char *endpoint, int timeout);
175
176 /*!
177  * \brief Apply a bridge role to a channel controlled by a stasis app control
178  *
179  * \param control Control for \c res_stasis
180  * \param role Role to apply
181  *
182  * \return 0 for success
183  * \return -1 for error.
184  */
185 int stasis_app_control_add_role(struct stasis_app_control *control, const char *role);
186
187 /*!
188  * \brief Clear bridge roles currently applied to a channel controlled by a stasis app control
189  *
190  * \param control Control for \c res_stasis
191  */
192 void stasis_app_control_clear_roles(struct stasis_app_control *control);
193
194 /*!
195  * \brief Exit \c res_stasis and continue execution in the dialplan.
196  *
197  * If the channel is no longer in \c res_stasis, this function does nothing.
198  *
199  * \param control Control for \c res_stasis
200  * \param context An optional context to continue to
201  * \param extension An optional extension to continue to
202  * \param priority An optional priority to continue to
203  *
204  * \return 0 for success
205  * \return -1 for error.
206  */
207 int stasis_app_control_continue(struct stasis_app_control *control, const char *context, const char *extension, int priority);
208
209 /*!
210  * \brief Mute the channel associated with this control.
211  *
212  * \param control Control for \c res_stasis.
213  * \param direction The direction in which the audio should be muted.
214  * \param frametype The type of stream that should be muted.
215  *
216  * \return 0 for success
217  * \return -1 for error.
218  */
219 int stasis_app_control_mute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
220
221 /*!
222  * \brief Unmute the channel associated with this control.
223  *
224  * \param control Control for \c res_stasis.
225  * \param direction The direction in which the audio should be unmuted.
226  * \param frametype The type of stream that should be unmuted.
227  *
228  * \return 0 for success
229  * \return -1 for error.
230  */
231 int stasis_app_control_unmute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
232
233 /*!
234  * \brief Answer the channel associated with this control.
235  * \param control Control for \c res_stasis.
236  * \return 0 for success.
237  * \return Non-zero for error.
238  */
239 int stasis_app_control_answer(struct stasis_app_control *control);
240
241 /*!
242  * \brief Get the value of a variable on the channel associated with this control.
243  * \param control Control for \c res_stasis.
244  * \param variable The name of the variable.
245  * \return The value of the variable.  The returned variable must be freed.
246  */
247 char *stasis_app_control_get_channel_var(struct stasis_app_control *control, const char *variable);
248
249 /*!
250  * \brief Set a variable on the channel associated with this control to value.
251  * \param control Control for \c res_stasis.
252  * \param variable The name of the variable
253  * \param value The value to set the variable to
254  *
255  * \return 0 for success.
256  * \return -1 for error.
257  */
258 int stasis_app_control_set_channel_var(struct stasis_app_control *control, const char *variable, const char *value);
259
260 /*!
261  * \brief Place the channel associated with the control on hold.
262  * \param control Control for \c res_stasis.
263  */
264 void stasis_app_control_hold(struct stasis_app_control *control);
265
266 /*!
267  * \brief Remove the channel associated with the control from hold.
268  * \param control Control for \c res_stasis.
269  */
270 void stasis_app_control_unhold(struct stasis_app_control *control);
271
272 /*!
273  * \brief Play music on hold to a channel (does not affect hold status)
274  * \param control Control for \c res_stasis.
275  * \param moh_class class of music on hold to play (NULL allowed)
276  */
277 void stasis_app_control_moh_start(struct stasis_app_control *control, const char *moh_class);
278
279 /*!
280  * \brief Stop playing music on hold to a channel (does not affect hold status)
281  * \param control Control for \c res_stasis.
282  */
283 void stasis_app_control_moh_stop(struct stasis_app_control *control);
284
285 /*!
286  * \brief Returns the most recent snapshot for the associated channel.
287  *
288  * The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
289  *
290  * \param control Control for \c res_stasis.
291  * \return Most recent snapshot. ao2_cleanup() when done.
292  * \return \c NULL if channel isn't in cache.
293  */
294 struct ast_channel_snapshot *stasis_app_control_get_snapshot(
295         const struct stasis_app_control *control);
296
297 /*!
298  * \brief Publish a message to the \a control's channel's topic.
299  *
300  * \param control Control to publish to
301  * \param message Message to publish
302  */
303 void stasis_app_control_publish(
304         struct stasis_app_control *control, struct stasis_message *message);
305
306 /*!
307  * \brief Queue a control frame without payload.
308  *
309  * \param control Control to publish to.
310  * \param frame_type type of control frame.
311  *
312  * \return zero on success
313  * \return non-zero on failure
314  */
315 int stasis_app_control_queue_control(struct stasis_app_control *control,
316         enum ast_control_frame_type frame_type);
317
318 /*!
319  * \brief Create a bridge of the specified type.
320  *
321  * \param type The type of bridge to be created
322  *
323  * \return New bridge.
324  * \return \c NULL on error.
325  */
326 struct ast_bridge *stasis_app_bridge_create(const char *type);
327
328 /*!
329  * \brief Returns the bridge with the given id.
330  * \param bridge_id Uniqueid of the bridge.
331  * \return NULL bridge not created by a Stasis application, or bridge does not exist.
332  * \return Pointer to bridge.
333  */
334 struct ast_bridge *stasis_app_bridge_find_by_id(
335         const char *bridge_id);
336
337 /*!
338  * \brief Add a channel to the bridge.
339  *
340  * \param control Control whose channel should be added to the bridge
341  * \param bridge Pointer to the bridge
342  */
343 void stasis_app_control_add_channel_to_bridge(
344         struct stasis_app_control *control, struct ast_bridge *bridge);
345
346 /*!
347  * \brief Remove a channel from the bridge.
348  *
349  * \param control Control whose channel should be removed from the bridge
350  * \param bridge Pointer to the bridge
351  */
352 void stasis_app_control_remove_channel_from_bridge(
353         struct stasis_app_control *control, struct ast_bridge *bridge);
354
355 /*!
356  * \brief Destroy the bridge.
357  *
358  * \param bridge_id Uniqueid of bridge to be destroyed
359  *
360  * \retval non-zero on failure
361  * \retval zero on success
362  */
363 void stasis_app_bridge_destroy(const char *bridge_id);
364
365 /*!
366  * \brief Increment the res_stasis reference count.
367  *
368  * This ensures graceful shutdown happens in the proper order.
369  */
370 void stasis_app_ref(void);
371
372 /*!
373  * \brief Decrement the res_stasis reference count.
374  *
375  * This ensures graceful shutdown happens in the proper order.
376  */
377 void stasis_app_unref(void);
378
379 /*! @} */
380
381 #endif /* _ASTERISK_STASIS_APP_H */