b11670ac5dd2704d42657a5362bf4bf47e3aa797
[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 Gets the names of all registered Stasis applications.
73  *
74  * \return \c ast_str_container of container names.
75  * \return \c NULL on error.
76  */
77 struct ao2_container *stasis_app_get_all(void);
78
79 /*!
80  * \brief Register a new Stasis application.
81  *
82  * If an application is already registered with the given name, the old
83  * application is sent a 'replaced' message and unregistered.
84  *
85  * \param app_name Name of this application.
86  * \param handler Callback for application messages.
87  * \param data Data blob to pass to the callback. Must be AO2 managed.
88  *
89  * \return 0 for success
90  * \return -1 for error.
91  */
92 int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data);
93
94 /*!
95  * \brief Unregister a Stasis application.
96  * \param app_name Name of the application to unregister.
97  */
98 void stasis_app_unregister(const char *app_name);
99
100 /*!
101  * \brief Send a message to the given Stasis application.
102  *
103  * The message given to the handler is a borrowed copy. If you want to keep a
104  * reference to it, you should use \c ao2_ref() to keep it around.
105  *
106  * \param app_name Name of the application to invoke.
107  * \param message Message to send (borrowed reference)
108  *
109  * \return 0 for success.
110  * \return -1 for error.
111  */
112 int stasis_app_send(const char *app_name, struct ast_json *message);
113
114 /*!
115  * \brief Return the JSON representation of a Stasis application.
116  *
117  * \param app_name Name of the application.
118  *
119  * \return JSON representation of app with given name.
120  * \return \c NULL on error.
121  */
122 struct ast_json *stasis_app_to_json(const char *app_name);
123
124 /*! \brief Return code for stasis_app_[un]subscribe */
125 enum stasis_app_subscribe_res {
126         STASIS_ASR_OK,
127         STASIS_ASR_APP_NOT_FOUND,
128         STASIS_ASR_EVENT_SOURCE_NOT_FOUND,
129         STASIS_ASR_EVENT_SOURCE_BAD_SCHEME,
130         STASIS_ASR_INTERNAL_ERROR,
131 };
132
133 /*!
134  * \brief Subscribes an application to a list of event sources.
135  *
136  * \param app_name Name of the application to subscribe.
137  * \param event_source_uris URIs for the event sources to subscribe to.
138  * \param event_sources_count Array size of event_source_uris.
139  * \param json Optional output pointer for JSON representation of the app
140  *             after adding the subscription.
141  *
142  * \return \ref stasis_app_subscribe_res return code.
143  */
144 enum stasis_app_subscribe_res stasis_app_subscribe(const char *app_name,
145         const char **event_source_uris, int event_sources_count,
146         struct ast_json **json);
147
148 /*!
149  * \brief Unsubscribes an application from a list of event sources.
150  *
151  * \param app_name Name of the application to subscribe.
152  * \param event_source_uris URIs for the event sources to subscribe to.
153  * \param event_sources_count Array size of event_source_uris.
154  * \param json Optional output pointer for JSON representation of the app
155  *             after adding the subscription.
156  *
157  * \return \ref stasis_app_subscribe_res return code.
158  */
159 enum stasis_app_subscribe_res stasis_app_unsubscribe(const char *app_name,
160         const char **event_source_uris, int event_sources_count,
161         struct ast_json **json);
162
163 /*! @} */
164
165 /*! @{ */
166
167 /*! \brief Handler for controlling a channel that's in a Stasis application */
168 struct stasis_app_control;
169
170 /*!
171  * \brief Returns the handler for the given channel.
172  * \param chan Channel to handle.
173  *
174  * \return NULL channel not in Stasis application.
175  * \return Pointer to \c res_stasis handler.
176  */
177 struct stasis_app_control *stasis_app_control_find_by_channel(
178         const struct ast_channel *chan);
179
180 /*!
181  * \brief Returns the handler for the channel with the given id.
182  * \param channel_id Uniqueid of the channel.
183  *
184  * \return NULL channel not in Stasis application, or channel does not exist.
185  * \return Pointer to \c res_stasis handler.
186  */
187 struct stasis_app_control *stasis_app_control_find_by_channel_id(
188         const char *channel_id);
189
190 /*!
191  * \brief Creates a control handler for a channel that isn't in a stasis app.
192  * \since 12.0.0
193  *
194  * \param chan Channel to create controller handle for
195  *
196  * \return NULL on failure to create the handle
197  * \return Pointer to \c res_stasis handler.
198  */
199 struct stasis_app_control *stasis_app_control_create(
200         struct ast_channel *chan);
201
202 /*!
203  * \brief Act on a stasis app control queue until it is empty
204  * \since 12.0.0
205  *
206  * \param chan Channel to handle
207  * \param control Control object to execute
208  */
209 void stasis_app_control_execute_until_exhausted(
210         struct ast_channel *chan,
211         struct stasis_app_control *control);
212
213 /*!
214  * \brief Returns the uniqueid of the channel associated with this control
215  *
216  * \param control Control object.
217  *
218  * \return Uniqueid of the associate channel.
219  * \return \c NULL if \a control is \c NULL.
220  */
221 const char *stasis_app_control_get_channel_id(
222         const struct stasis_app_control *control);
223
224 /*!
225  * \brief Dial an endpoint and bridge it to a channel in \c res_stasis
226  *
227  * If the channel is no longer in \c res_stasis, this function does nothing.
228  *
229  * \param control Control for \c res_stasis
230  * \param endpoint The endpoint to dial.
231  * \param exten Extension to dial if no endpoint specified.
232  * \param context Context to use with extension.
233  * \param timeout The amount of time to wait for answer, before giving up.
234  *
235  * \return 0 for success
236  * \return -1 for error.
237  */
238 int stasis_app_control_dial(struct stasis_app_control *control, const char *endpoint, const char *exten,
239                             const char *context, int timeout);
240
241 /*!
242  * \brief Apply a bridge role to a channel controlled by a stasis app control
243  *
244  * \param control Control for \c res_stasis
245  * \param role Role to apply
246  *
247  * \return 0 for success
248  * \return -1 for error.
249  */
250 int stasis_app_control_add_role(struct stasis_app_control *control, const char *role);
251
252 /*!
253  * \brief Clear bridge roles currently applied to a channel controlled by a stasis app control
254  *
255  * \param control Control for \c res_stasis
256  */
257 void stasis_app_control_clear_roles(struct stasis_app_control *control);
258
259 /*!
260  * \brief Exit \c res_stasis and continue execution in the dialplan.
261  *
262  * If the channel is no longer in \c res_stasis, this function does nothing.
263  *
264  * \param control Control for \c res_stasis
265  * \param context An optional context to continue to
266  * \param extension An optional extension to continue to
267  * \param priority An optional priority to continue to
268  *
269  * \return 0 for success
270  * \return -1 for error.
271  */
272 int stasis_app_control_continue(struct stasis_app_control *control, const char *context, const char *extension, int priority);
273
274 /*!
275  * \brief Mute the channel associated with this control.
276  *
277  * \param control Control for \c res_stasis.
278  * \param direction The direction in which the audio should be muted.
279  * \param frametype The type of stream that should be muted.
280  *
281  * \return 0 for success
282  * \return -1 for error.
283  */
284 int stasis_app_control_mute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
285
286 /*!
287  * \brief Unmute the channel associated with this control.
288  *
289  * \param control Control for \c res_stasis.
290  * \param direction The direction in which the audio should be unmuted.
291  * \param frametype The type of stream that should be unmuted.
292  *
293  * \return 0 for success
294  * \return -1 for error.
295  */
296 int stasis_app_control_unmute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
297
298 /*!
299  * \brief Answer the channel associated with this control.
300  * \param control Control for \c res_stasis.
301  * \return 0 for success.
302  * \return Non-zero for error.
303  */
304 int stasis_app_control_answer(struct stasis_app_control *control);
305
306 /*!
307  * \brief Get the value of a variable on the channel associated with this control.
308  * \param control Control for \c res_stasis.
309  * \param variable The name of the variable.
310  *
311  * \return The value of the variable.  The returned variable must be freed.
312  */
313 char *stasis_app_control_get_channel_var(struct stasis_app_control *control, const char *variable);
314
315 /*!
316  * \brief Set a variable on the channel associated with this control to value.
317  * \param control Control for \c res_stasis.
318  * \param variable The name of the variable
319  * \param value The value to set the variable to
320  *
321  * \return 0 for success.
322  * \return -1 for error.
323  */
324 int stasis_app_control_set_channel_var(struct stasis_app_control *control, const char *variable, const char *value);
325
326 /*!
327  * \brief Place the channel associated with the control on hold.
328  * \param control Control for \c res_stasis.
329  */
330 void stasis_app_control_hold(struct stasis_app_control *control);
331
332 /*!
333  * \brief Remove the channel associated with the control from hold.
334  * \param control Control for \c res_stasis.
335  */
336 void stasis_app_control_unhold(struct stasis_app_control *control);
337
338 /*!
339  * \brief Play music on hold to a channel (does not affect hold status)
340  * \param control Control for \c res_stasis.
341  * \param moh_class class of music on hold to play (NULL allowed)
342  */
343 void stasis_app_control_moh_start(struct stasis_app_control *control, const char *moh_class);
344
345 /*!
346  * \brief Stop playing music on hold to a channel (does not affect hold status)
347  * \param control Control for \c res_stasis.
348  */
349 void stasis_app_control_moh_stop(struct stasis_app_control *control);
350
351 /*!
352  * \brief Returns the most recent snapshot for the associated channel.
353  *
354  * The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
355  *
356  * \param control Control for \c res_stasis.
357  *
358  * \return Most recent snapshot. ao2_cleanup() when done.
359  * \return \c NULL if channel isn't in cache.
360  */
361 struct ast_channel_snapshot *stasis_app_control_get_snapshot(
362         const struct stasis_app_control *control);
363
364 /*!
365  * \brief Publish a message to the \a control's channel's topic.
366  *
367  * \param control Control to publish to
368  * \param message Message to publish
369  */
370 void stasis_app_control_publish(
371         struct stasis_app_control *control, struct stasis_message *message);
372
373 /*!
374  * \brief Queue a control frame without payload.
375  *
376  * \param control Control to publish to.
377  * \param frame_type type of control frame.
378  *
379  * \return zero on success
380  * \return non-zero on failure
381  */
382 int stasis_app_control_queue_control(struct stasis_app_control *control,
383         enum ast_control_frame_type frame_type);
384
385 /*!
386  * \brief Create a bridge of the specified type.
387  *
388  * \param type The type of bridge to be created
389  *
390  * \return New bridge.
391  * \return \c NULL on error.
392  */
393 struct ast_bridge *stasis_app_bridge_create(const char *type);
394
395 /*!
396  * \brief Returns the bridge with the given id.
397  * \param bridge_id Uniqueid of the bridge.
398  *
399  * \return NULL bridge not created by a Stasis application, or bridge does not exist.
400  * \return Pointer to bridge.
401  */
402 struct ast_bridge *stasis_app_bridge_find_by_id(
403         const char *bridge_id);
404
405 /*!
406  * \brief Finds or creates an announcer channel in a bridge that can play music on hold.
407  *
408  * \param bridge Bridge we want an MOH channel for
409  *
410  * \return NULL if the music on hold channel fails to be created or join the bridge for any reason.
411  * \return Pointer to the ;1 end of the announcer channel chain.
412  */
413 struct ast_channel *stasis_app_bridge_moh_channel(
414         struct ast_bridge *bridge);
415
416 /*!
417  * \brief Breaks down MOH channels playing on the bridge created by stasis_app_bridge_moh_channel
418  *
419  * \param bridge Bridge we want to stop the MOH on
420  *
421  * \return -1 if no moh channel could be found and stopped
422  * \return 0 on success
423  */
424 int stasis_app_bridge_moh_stop(
425         struct ast_bridge *bridge);
426
427 /*!
428  * \brief Add a channel to the bridge.
429  *
430  * \param control Control whose channel should be added to the bridge
431  * \param bridge Pointer to the bridge
432  *
433  * \return non-zero on failure
434  * \return zero on success
435  */
436 int stasis_app_control_add_channel_to_bridge(
437         struct stasis_app_control *control, struct ast_bridge *bridge);
438
439 /*!
440  * \brief Remove a channel from the bridge.
441  *
442  * \param control Control whose channel should be removed from the bridge
443  * \param bridge Pointer to the bridge
444  *
445  * \return non-zero on failure
446  * \return zero on success
447  */
448 int stasis_app_control_remove_channel_from_bridge(
449         struct stasis_app_control *control, struct ast_bridge *bridge);
450
451 /*!
452  * \since 12
453  * \brief Gets the bridge currently associated with a control object.
454  *
455  * \param control Control object for the channel to query.
456  *
457  * \return Associated \ref ast_bridge.
458  * \return \c NULL if not associated with a bridge.
459  */
460 struct ast_bridge *stasis_app_get_bridge(struct stasis_app_control *control);
461
462 /*!
463  * \brief Destroy the bridge.
464  *
465  * \param bridge_id Uniqueid of bridge to be destroyed
466  *
467  * \retval non-zero on failure
468  * \retval zero on success
469  */
470 void stasis_app_bridge_destroy(const char *bridge_id);
471
472 /*!
473  * \brief Increment the res_stasis reference count.
474  *
475  * This ensures graceful shutdown happens in the proper order.
476  */
477 void stasis_app_ref(void);
478
479 /*!
480  * \brief Decrement the res_stasis reference count.
481  *
482  * This ensures graceful shutdown happens in the proper order.
483  */
484 void stasis_app_unref(void);
485
486 /*! @} */
487
488 #endif /* _ASTERISK_STASIS_APP_H */