27b3502f33d2e62d1472fc4ab166dad1fcd259c9
[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 Returns the uniqueid of the channel associated with this control
131  *
132  * \param control Control object.
133  * \return Uniqueid of the associate channel.
134  * \return \c NULL if \a control is \c NULL.
135  */
136 const char *stasis_app_control_get_channel_id(
137         const struct stasis_app_control *control);
138
139 /*!
140  * \brief Exit \c res_stasis and continue execution in the dialplan.
141  *
142  * If the channel is no longer in \c res_stasis, this function does nothing.
143  *
144  * \param control Control for \c res_stasis
145  */
146 void stasis_app_control_continue(struct stasis_app_control *control);
147
148 /*!
149  * \brief Answer the channel associated with this control.
150  * \param control Control for \c res_stasis.
151  * \return 0 for success.
152  * \return Non-zero for error.
153  */
154 int stasis_app_control_answer(struct stasis_app_control *control);
155
156 /*!
157  * \brief Returns the most recent snapshot for the associated channel.
158  *
159  * The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
160  *
161  * \param control Control for \c res_stasis.
162  * \return Most recent snapshot. ao2_cleanup() when done.
163  * \return \c NULL if channel isn't in cache.
164  */
165 struct ast_channel_snapshot *stasis_app_control_get_snapshot(
166         const struct stasis_app_control *control);
167
168 /*!
169  * \brief Publish a message to the \a control's channel's topic.
170  *
171  * \param control Control to publish to
172  * \param message Message to publish
173  */
174 void stasis_app_control_publish(
175         struct stasis_app_control *control, struct stasis_message *message);
176
177 /*!
178  * \brief Queue a control frame without payload.
179  *
180  * \param control Control to publish to.
181  * \param frame_type type of control frame.
182  *
183  * \return zero on success
184  * \return non-zero on failure
185  */
186 int stasis_app_control_queue_control(struct stasis_app_control *control,
187         enum ast_control_frame_type frame_type);
188
189 /*!
190  * \brief Increment the res_stasis reference count.
191  *
192  * This ensures graceful shutdown happens in the proper order.
193  */
194 void stasis_app_ref(void);
195
196 /*!
197  * \brief Decrement the res_stasis reference count.
198  *
199  * This ensures graceful shutdown happens in the proper order.
200  */
201 void stasis_app_unref(void);
202
203 /*! @} */
204
205 #endif /* _ASTERISK_STASIS_APP_H */