This patch adds a RESTful HTTP interface to Asterisk.
[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
49 #include "asterisk/channel.h"
50 #include "asterisk/json.h"
51
52 struct ast_channel_snapshot;
53
54 /*! @{ */
55
56 /*!
57  * \brief Control a channel using \c stasis_app.
58  *
59  * This function blocks until the channel hangs up, or
60  * stasis_app_control_continue() is called on the channel's \ref
61  * stasis_app_control struct.
62  *
63  * \param chan Channel to control with Stasis.
64  * \param app_name Application controlling the channel.
65  * \param argc Number of arguments for the application.
66  * \param argv Arguments for the application.
67  */
68 int stasis_app_exec(struct ast_channel *chan, const char *app_name, int argc,
69         char *argv[]);
70
71 /*! @} */
72
73 /*! @{ */
74
75 /*!
76  * \brief Callback for Stasis application handler.
77  *
78  * The message given to the handler is a borrowed copy. If you want to keep a
79  * reference to it, you should use \c ao2_ref() to keep it around.
80  *
81  * \param data Data ptr given when registered.
82  * \param app_name Name of the application being dispatched to.
83  * \param message Message to handle. (borrowed copy)
84  */
85 typedef void (*stasis_app_cb)(void *data, const char *app_name,
86                               struct ast_json *message);
87
88 /*!
89  * \brief Register a new Stasis application.
90  *
91  * If an application is already registered with the given name, the old
92  * application is sent a 'replaced' message and unregistered.
93  *
94  * \param app_name Name of this application.
95  * \param handler Callback for application messages.
96  * \param data Data blob to pass to the callback. Must be AO2 managed.
97  * \return 0 for success
98  * \return -1 for error.
99  */
100 int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data);
101
102 /*!
103  * \brief Unregister a Stasis application.
104  * \param app_name Name of the application to unregister.
105  */
106 void stasis_app_unregister(const char *app_name);
107
108 /*!
109  * \brief Send a message to the given Stasis application.
110  *
111  * The message given to the handler is a borrowed copy. If you want to keep a
112  * reference to it, you should use \c ao2_ref() to keep it around.
113  *
114  * \param app_name Name of the application to invoke.
115  * \param message Message to send (borrowed reference)
116  * \return 0 for success.
117  * \return -1 for error.
118  */
119 int stasis_app_send(const char *app_name, struct ast_json *message);
120
121 /*! @} */
122
123 /*! @{ */
124
125 /*! \brief Handler for controlling a channel that's in a Stasis application */
126 struct stasis_app_control;
127
128 /*!
129  * \brief Returns the handler for the given channel.
130  * \param chan Channel to handle.
131  * \return NULL channel not in Stasis application.
132  * \return Pointer to \c res_stasis handler.
133  */
134 struct stasis_app_control *stasis_app_control_find_by_channel(
135         const struct ast_channel *chan);
136
137 /*!
138  * \brief Returns the handler for the channel with the given id.
139  * \param channel_id Uniqueid of the channel.
140  * \return NULL channel not in Stasis application, or channel does not exist.
141  * \return Pointer to \c res_stasis handler.
142  */
143 struct stasis_app_control *stasis_app_control_find_by_channel_id(
144         const char *channel_id);
145
146 /*!
147  * \brief Exit \c res_stasis and continue execution in the dialplan.
148  *
149  * If the channel is no longer in \c res_stasis, this function does nothing.
150  *
151  * \param control Control for \c res_stasis
152  */
153 void stasis_app_control_continue(struct stasis_app_control *control);
154
155 /*!
156  * \brief Answer the channel associated with this control.
157  * \param control Control for \c res_stasis.
158  * \return 0 for success.
159  * \return -1 for error.
160  */
161 int stasis_app_control_answer(struct stasis_app_control *control);
162
163 /*! @} */
164
165 /*! @{ */
166
167 /*!
168  * \brief Build a JSON object from a \ref ast_channel_snapshot.
169  * \return JSON object representing channel snapshot.
170  * \return \c NULL on error
171  */
172 struct ast_json *ast_channel_snapshot_to_json(const struct ast_channel_snapshot *snapshot);
173
174 /*! @} */
175
176 #endif /* _ASTERISK_STASIS_APP_H */