bridging: Give bridges a name and a known creator
[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 /*! \brief Forward declare app */
115 struct stasis_app;
116
117 /*!
118  * \brief Retrieve an application's name
119  *
120  * \param app An application
121  *
122  * \return The name of the application.
123  */
124 const char *stasis_app_name(const struct stasis_app *app);
125
126 /*!
127  * \brief Return the JSON representation of a Stasis application.
128  *
129  * \param app_name Name of the application.
130  *
131  * \return JSON representation of app with given name.
132  * \return \c NULL on error.
133  */
134 struct ast_json *stasis_app_to_json(const char *app_name);
135
136 /*!
137  * \brief Event source information and callbacks.
138  */
139 struct stasis_app_event_source {
140         /*! \brief The scheme to match against on [un]subscribes */
141         const char *scheme;
142
143         /*!
144          * \brief Find an event source data object by the given id/name.
145          *
146          * \param app Application
147          * \param id A unique identifier to search on
148          *
149          * \return The data object associated with the id/name.
150          */
151         void *(*find)(const struct stasis_app *app, const char *id);
152
153         /*!
154          * \brief Subscribe an application to an event source.
155          *
156          * \param app Application
157          * \param obj an event source data object
158          *
159          * \return 0 on success, failure code otherwise
160          */
161         int (*subscribe)(struct stasis_app *app, void *obj);
162
163         /*!
164          * \brief Cancel the subscription an app has to an event source.
165          *
166          * \param app Application
167          * \param id a previously subscribed object id
168          *
169          * \return 0 on success, failure code otherwise
170          */
171         int (*unsubscribe)(struct stasis_app *app, const char *id);
172
173         /*!
174          * \brief Find an event source by the given id/name.
175          *
176          * \param app Application
177          * \param id A unique identifier to check
178          *
179          * \return true if id is subscribed, false otherwise.
180          */
181         int (*is_subscribed)(struct stasis_app *app, const char *id);
182
183         /*!
184          * \brief Convert event source data to json
185          *
186          * \param app Application
187          * \param id json object to fill
188          */
189         void (*to_json)(const struct stasis_app *app, struct ast_json *json);
190
191         /*! Next item in the list */
192         AST_LIST_ENTRY(stasis_app_event_source) next;
193 };
194
195 /*!
196  * \brief Register an application event source.
197  *
198  * \param obj the event source to register
199  */
200 void stasis_app_register_event_source(struct stasis_app_event_source *obj);
201
202 /*!
203  * \brief Register core event sources.
204  */
205 void stasis_app_register_event_sources(void);
206
207 /*!
208  * \brief Checks to see if the given object is a core event source
209  *
210  * \note core event sources are currently only endpoint, bridge, and channel.
211  *
212  * \param obj event source object to check
213  *
214  * \return non-zero if core event source, otherwise 0 (false)
215
216  */
217 int stasis_app_is_core_event_source(struct stasis_app_event_source *obj);
218
219 /*!
220  * \brief Unregister an application event source.
221  *
222  * \param obj the event source to unregister
223  */
224 void stasis_app_unregister_event_source(struct stasis_app_event_source *obj);
225
226 /*!
227  * \brief Unregister core event sources.
228  */
229 void stasis_app_unregister_event_sources(void);
230
231
232 /*! \brief Return code for stasis_app_[un]subscribe */
233 enum stasis_app_subscribe_res {
234         STASIS_ASR_OK,
235         STASIS_ASR_APP_NOT_FOUND,
236         STASIS_ASR_EVENT_SOURCE_NOT_FOUND,
237         STASIS_ASR_EVENT_SOURCE_BAD_SCHEME,
238         STASIS_ASR_INTERNAL_ERROR,
239 };
240
241 /*!
242  * \brief Subscribes an application to a list of event sources.
243  *
244  * \param app_name Name of the application to subscribe.
245  * \param event_source_uris URIs for the event sources to subscribe to.
246  * \param event_sources_count Array size of event_source_uris.
247  * \param json Optional output pointer for JSON representation of the app
248  *             after adding the subscription.
249  *
250  * \return \ref stasis_app_subscribe_res return code.
251  *
252  * \note Do not hold any channel locks if subscribing to a channel.
253  */
254 enum stasis_app_subscribe_res stasis_app_subscribe(const char *app_name,
255         const char **event_source_uris, int event_sources_count,
256         struct ast_json **json);
257
258 /*!
259  * \brief Unsubscribes an application from a list of event sources.
260  *
261  * \param app_name Name of the application to subscribe.
262  * \param event_source_uris URIs for the event sources to subscribe to.
263  * \param event_sources_count Array size of event_source_uris.
264  * \param json Optional output pointer for JSON representation of the app
265  *             after adding the subscription.
266  *
267  * \return \ref stasis_app_subscribe_res return code.
268  */
269 enum stasis_app_subscribe_res stasis_app_unsubscribe(const char *app_name,
270         const char **event_source_uris, int event_sources_count,
271         struct ast_json **json);
272
273 /*! @} */
274
275 /*! @{ */
276
277 /*! \brief Handler for controlling a channel that's in a Stasis application */
278 struct stasis_app_control;
279
280 /*! \brief Rule to check to see if an operation is allowed */
281 struct stasis_app_control_rule {
282         /*!
283          * \brief Checks to see if an operation is allowed on the control
284          *
285          * \param control Control object to check
286          * \return 0 on success, otherwise a failure code
287          */
288         enum stasis_app_control_channel_result (*check_rule)(
289                 const struct stasis_app_control *control);
290         /*! Next item in the list */
291         AST_LIST_ENTRY(stasis_app_control_rule) next;
292 };
293
294 /*!
295  * \brief Registers an add channel to bridge rule.
296  *
297  * \param control Control object
298  * \param rule The rule to register
299  */
300 void stasis_app_control_register_add_rule(
301         struct stasis_app_control *control,
302         struct stasis_app_control_rule *rule);
303
304 /*!
305  * \brief UnRegister an add channel to bridge rule.
306  *
307  * \param control Control object
308  * \param rule The rule to unregister
309  */
310 void stasis_app_control_unregister_add_rule(
311         struct stasis_app_control *control,
312         struct stasis_app_control_rule *rule);
313
314 /*!
315  * \brief Registers a remove channel from bridge rule.
316  *
317  * \param control Control object
318  * \param rule The rule to register
319  */
320 void stasis_app_control_register_remove_rule(
321         struct stasis_app_control *control,
322         struct stasis_app_control_rule *rule);
323
324 /*!
325  * \brief Unregisters a remove channel from bridge rule.
326  *
327  * \param control Control object
328  * \param rule The rule to unregister
329  */
330 void stasis_app_control_unregister_remove_rule(
331         struct stasis_app_control *control,
332         struct stasis_app_control_rule *rule);
333
334 /*!
335  * \brief Returns the handler for the given channel.
336  * \param chan Channel to handle.
337  *
338  * \return NULL channel not in Stasis application.
339  * \return Pointer to \c res_stasis handler.
340  */
341 struct stasis_app_control *stasis_app_control_find_by_channel(
342         const struct ast_channel *chan);
343
344 /*!
345  * \brief Returns the handler for the channel with the given id.
346  * \param channel_id Uniqueid of the channel.
347  *
348  * \return NULL channel not in Stasis application, or channel does not exist.
349  * \return Pointer to \c res_stasis handler.
350  */
351 struct stasis_app_control *stasis_app_control_find_by_channel_id(
352         const char *channel_id);
353
354 /*!
355  * \brief Creates a control handler for a channel that isn't in a stasis app.
356  * \since 12.0.0
357  *
358  * \param chan Channel to create controller handle for
359  *
360  * \return NULL on failure to create the handle
361  * \return Pointer to \c res_stasis handler.
362  */
363 struct stasis_app_control *stasis_app_control_create(
364         struct ast_channel *chan);
365
366 /*!
367  * \brief Act on a stasis app control queue until it is empty
368  * \since 12.0.0
369  *
370  * \param chan Channel to handle
371  * \param control Control object to execute
372  */
373 void stasis_app_control_execute_until_exhausted(
374         struct ast_channel *chan,
375         struct stasis_app_control *control);
376
377 /*!
378  * \brief Returns the uniqueid of the channel associated with this control
379  *
380  * \param control Control object.
381  *
382  * \return Uniqueid of the associate channel.
383  * \return \c NULL if \a control is \c NULL.
384  */
385 const char *stasis_app_control_get_channel_id(
386         const struct stasis_app_control *control);
387
388 /*!
389  * \brief Dial an endpoint and bridge it to a channel in \c res_stasis
390  *
391  * If the channel is no longer in \c res_stasis, this function does nothing.
392  *
393  * \param control Control for \c res_stasis
394  * \param endpoint The endpoint to dial.
395  * \param exten Extension to dial if no endpoint specified.
396  * \param context Context to use with extension.
397  * \param timeout The amount of time to wait for answer, before giving up.
398  *
399  * \return 0 for success
400  * \return -1 for error.
401  */
402 int stasis_app_control_dial(struct stasis_app_control *control, const char *endpoint, const char *exten,
403                             const char *context, int timeout);
404
405 /*!
406  * \brief Apply a bridge role to a channel controlled by a stasis app control
407  *
408  * \param control Control for \c res_stasis
409  * \param role Role to apply
410  *
411  * \return 0 for success
412  * \return -1 for error.
413  */
414 int stasis_app_control_add_role(struct stasis_app_control *control, const char *role);
415
416 /*!
417  * \brief Clear bridge roles currently applied to a channel controlled by a stasis app control
418  *
419  * \param control Control for \c res_stasis
420  */
421 void stasis_app_control_clear_roles(struct stasis_app_control *control);
422
423 /*!
424  * \brief Exit \c res_stasis and continue execution in the dialplan.
425  *
426  * If the channel is no longer in \c res_stasis, this function does nothing.
427  *
428  * \param control Control for \c res_stasis
429  * \param context An optional context to continue to
430  * \param extension An optional extension to continue to
431  * \param priority An optional priority to continue to
432  *
433  * \return 0 for success
434  * \return -1 for error.
435  */
436 int stasis_app_control_continue(struct stasis_app_control *control, const char *context, const char *extension, int priority);
437
438 /*!
439  * \brief Indicate ringing to the channel associated with this control.
440  *
441  * \param control Control for \c res_stasis.
442  *
443  * \return 0 for success.
444  * \return -1 for error.
445  */
446 int stasis_app_control_ring(struct stasis_app_control *control);
447
448 /*!
449  * \brief Stop locally generated ringing on the channel associated with this control.
450  *
451  * \param control Control for \c res_stasis.
452  *
453  * \return 0 for success.
454  * \return -1 for error.
455  */
456 int stasis_app_control_ring_stop(struct stasis_app_control *control);
457
458 /*!
459  * \brief Send DTMF to the channel associated with this control.
460  *
461  * \param control Control for \c res_stasis.
462  * \param dtmf DTMF string.
463  * \param before Amount of time to wait before sending DTMF digits.
464  * \param between Amount of time between each DTMF digit.
465  * \param duration Amount of time each DTMF digit lasts for.
466  * \param after Amount of time to wait after sending DTMF digits.
467  *
468  * \return 0 for success.
469  * \return -1 for error.
470  */
471 int stasis_app_control_dtmf(struct stasis_app_control *control, const char *dtmf, int before, int between, unsigned int duration, int after);
472
473 /*!
474  * \brief Mute the channel associated with this control.
475  *
476  * \param control Control for \c res_stasis.
477  * \param direction The direction in which the audio should be muted.
478  * \param frametype The type of stream that should be muted.
479  *
480  * \return 0 for success
481  * \return -1 for error.
482  */
483 int stasis_app_control_mute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
484
485 /*!
486  * \brief Unmute the channel associated with this control.
487  *
488  * \param control Control for \c res_stasis.
489  * \param direction The direction in which the audio should be unmuted.
490  * \param frametype The type of stream that should be unmuted.
491  *
492  * \return 0 for success
493  * \return -1 for error.
494  */
495 int stasis_app_control_unmute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype);
496
497 /*!
498  * \brief Answer the channel associated with this control.
499  * \param control Control for \c res_stasis.
500  * \return 0 for success.
501  * \return Non-zero for error.
502  */
503 int stasis_app_control_answer(struct stasis_app_control *control);
504
505 /*!
506  * \brief Get the value of a variable on the channel associated with this control.
507  * \param control Control for \c res_stasis.
508  * \param variable The name of the variable.
509  *
510  * \return The value of the variable.  The returned variable must be freed.
511  */
512 char *stasis_app_control_get_channel_var(struct stasis_app_control *control, const char *variable);
513
514 /*!
515  * \brief Set a variable on the channel associated with this control to value.
516  * \param control Control for \c res_stasis.
517  * \param variable The name of the variable
518  * \param value The value to set the variable to
519  *
520  * \return 0 for success.
521  * \return -1 for error.
522  */
523 int stasis_app_control_set_channel_var(struct stasis_app_control *control, const char *variable, const char *value);
524
525 /*!
526  * \brief Place the channel associated with the control on hold.
527  * \param control Control for \c res_stasis.
528  */
529 void stasis_app_control_hold(struct stasis_app_control *control);
530
531 /*!
532  * \brief Remove the channel associated with the control from hold.
533  * \param control Control for \c res_stasis.
534  */
535 void stasis_app_control_unhold(struct stasis_app_control *control);
536
537 /*!
538  * \brief Play music on hold to a channel (does not affect hold status)
539  * \param control Control for \c res_stasis.
540  * \param moh_class class of music on hold to play (NULL allowed)
541  */
542 void stasis_app_control_moh_start(struct stasis_app_control *control, const char *moh_class);
543
544 /*!
545  * \brief Stop playing music on hold to a channel (does not affect hold status)
546  * \param control Control for \c res_stasis.
547  */
548 void stasis_app_control_moh_stop(struct stasis_app_control *control);
549
550 /*!
551  * \brief Start playing silence to a channel.
552  * \param control Control for \c res_stasis.
553  */
554 void stasis_app_control_silence_start(struct stasis_app_control *control);
555
556 /*!
557  * \brief Stop playing silence to a channel.
558  * \param control Control for \c res_stasis.
559  */
560 void stasis_app_control_silence_stop(struct stasis_app_control *control);
561
562 /*!
563  * \brief Returns the most recent snapshot for the associated channel.
564  *
565  * The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
566  *
567  * \param control Control for \c res_stasis.
568  *
569  * \return Most recent snapshot. ao2_cleanup() when done.
570  * \return \c NULL if channel isn't in cache.
571  */
572 struct ast_channel_snapshot *stasis_app_control_get_snapshot(
573         const struct stasis_app_control *control);
574
575 /*!
576  * \brief Publish a message to the \a control's channel's topic.
577  *
578  * \param control Control to publish to
579  * \param message Message to publish
580  */
581 void stasis_app_control_publish(
582         struct stasis_app_control *control, struct stasis_message *message);
583
584 /*!
585  * \brief Queue a control frame without payload.
586  *
587  * \param control Control to publish to.
588  * \param frame_type type of control frame.
589  *
590  * \return zero on success
591  * \return non-zero on failure
592  */
593 int stasis_app_control_queue_control(struct stasis_app_control *control,
594         enum ast_control_frame_type frame_type);
595
596 /*!
597  * \brief Create a bridge of the specified type.
598  *
599  * \param type The type of bridge to be created
600  * \param name Optional name to give to the bridge
601  *
602  * \return New bridge.
603  * \return \c NULL on error.
604  */
605 struct ast_bridge *stasis_app_bridge_create(const char *type, const char *name);
606
607 /*!
608  * \brief Returns the bridge with the given id.
609  * \param bridge_id Uniqueid of the bridge.
610  *
611  * \return NULL bridge not created by a Stasis application, or bridge does not exist.
612  * \return Pointer to bridge.
613  */
614 struct ast_bridge *stasis_app_bridge_find_by_id(
615         const char *bridge_id);
616
617 /*!
618  * \brief Finds or creates an announcer channel in a bridge that can play music on hold.
619  *
620  * \param bridge Bridge we want an MOH channel for
621  *
622  * \return NULL if the music on hold channel fails to be created or join the bridge for any reason.
623  * \return Pointer to the ;1 end of the announcer channel chain.
624  */
625 struct ast_channel *stasis_app_bridge_moh_channel(
626         struct ast_bridge *bridge);
627
628 /*!
629  * \brief Breaks down MOH channels playing on the bridge created by stasis_app_bridge_moh_channel
630  *
631  * \param bridge Bridge we want to stop the MOH on
632  *
633  * \return -1 if no moh channel could be found and stopped
634  * \return 0 on success
635  */
636 int stasis_app_bridge_moh_stop(
637         struct ast_bridge *bridge);
638
639 /*!
640  * \brief Result codes used when adding/removing channels to/from bridges.
641  */
642 enum stasis_app_control_channel_result {
643         /*! The channel is okay to be added/removed */
644         STASIS_APP_CHANNEL_OKAY = 0,
645         /*! The channel is currently recording */
646         STASIS_APP_CHANNEL_RECORDING
647 };
648
649 /*!
650  * \brief Add a channel to the bridge.
651  *
652  * \param control Control whose channel should be added to the bridge
653  * \param bridge Pointer to the bridge
654  *
655  * \return non-zero on failure
656  * \return zero on success
657  */
658 int stasis_app_control_add_channel_to_bridge(
659         struct stasis_app_control *control, struct ast_bridge *bridge);
660
661 /*!
662  * \brief Remove a channel from the bridge.
663  *
664  * \param control Control whose channel should be removed from the bridge
665  * \param bridge Pointer to the bridge
666  *
667  * \return non-zero on failure
668  * \return zero on success
669  */
670 int stasis_app_control_remove_channel_from_bridge(
671         struct stasis_app_control *control, struct ast_bridge *bridge);
672
673 /*!
674  * \since 12
675  * \brief Gets the bridge currently associated with a control object.
676  *
677  * \param control Control object for the channel to query.
678  *
679  * \return Associated \ref ast_bridge.
680  * \return \c NULL if not associated with a bridge.
681  */
682 struct ast_bridge *stasis_app_get_bridge(struct stasis_app_control *control);
683
684 /*!
685  * \brief Destroy the bridge.
686  *
687  * \param bridge_id Uniqueid of bridge to be destroyed
688  *
689  * \retval non-zero on failure
690  * \retval zero on success
691  */
692 void stasis_app_bridge_destroy(const char *bridge_id);
693
694 /*!
695  * \brief Increment the res_stasis reference count.
696  *
697  * This ensures graceful shutdown happens in the proper order.
698  */
699 void stasis_app_ref(void);
700
701 /*!
702  * \brief Decrement the res_stasis reference count.
703  *
704  * This ensures graceful shutdown happens in the proper order.
705  */
706 void stasis_app_unref(void);
707
708 /*!
709  * \brief Get the Stasis message sanitizer for app_stasis applications
710  *
711  * \retval The stasis message sanitizer
712  */
713 struct stasis_message_sanitizer *stasis_app_get_sanitizer(void);
714
715 /*! @} */
716
717 #endif /* _ASTERISK_STASIS_APP_H */