1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2012 - 2013, Digium, Inc.
*
* David M. Lee, II <dlee@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
#ifndef _ASTERISK_STASIS_APP_H
#define _ASTERISK_STASIS_APP_H
/*! \file
*
* \brief Stasis Application API. See \ref res_stasis "Stasis Application API"
* for detailed documentation.
*
* \author David M. Lee, II <dlee@digium.com>
* \since 12
*
* \page res_stasis Stasis Application API
*
* This is the API that binds the Stasis dialplan application to external
* Stasis applications, such as \c res_stasis_websocket.
*
* The associated \c res_stasis module registers a dialplan function named \c
* Stasis, which uses \c res_stasis to put a channel into the named Stasis
* app. As a channel enters and leaves the Stasis diaplan application, the
* Stasis app receives a \c 'stasis-start' and \c 'stasis-end' events.
*
* Stasis apps register themselves using the \ref stasis_app_register and
* stasis_app_unregister functions. Messages are sent to an appliction using
* \ref stasis_app_send.
*
* Finally, Stasis apps control channels through the use of the \ref
* stasis_app_control object, and the family of \c stasis_app_control_*
* functions.
*
* Since module unload order is based on reference counting, any module that
* uses the API defined in this file must call stasis_app_ref() when loaded,
* and stasis_app_unref() when unloaded.
*/
#include "asterisk/channel.h"
#include "asterisk/json.h"
/*! @{ */
/*!
* \brief Callback for Stasis application handler.
*
* The message given to the handler is a borrowed copy. If you want to keep a
* reference to it, you should use \c ao2_ref() to keep it around.
*
* \param data Data ptr given when registered.
* \param app_name Name of the application being dispatched to.
* \param message Message to handle. (borrowed copy)
*/
typedef void (*stasis_app_cb)(void *data, const char *app_name,
struct ast_json *message);
/*!
* \brief Register a new Stasis application.
*
* If an application is already registered with the given name, the old
* application is sent a 'replaced' message and unregistered.
*
* \param app_name Name of this application.
* \param handler Callback for application messages.
* \param data Data blob to pass to the callback. Must be AO2 managed.
* \return 0 for success
* \return -1 for error.
*/
int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data);
/*!
* \brief Unregister a Stasis application.
* \param app_name Name of the application to unregister.
*/
void stasis_app_unregister(const char *app_name);
/*!
* \brief Send a message to the given Stasis application.
*
* The message given to the handler is a borrowed copy. If you want to keep a
* reference to it, you should use \c ao2_ref() to keep it around.
*
* \param app_name Name of the application to invoke.
* \param message Message to send (borrowed reference)
* \return 0 for success.
* \return -1 for error.
*/
int stasis_app_send(const char *app_name, struct ast_json *message);
/*! @} */
/*! @{ */
/*! \brief Handler for controlling a channel that's in a Stasis application */
struct stasis_app_control;
/*!
* \brief Returns the handler for the given channel.
* \param chan Channel to handle.
* \return NULL channel not in Stasis application.
* \return Pointer to \c res_stasis handler.
*/
struct stasis_app_control *stasis_app_control_find_by_channel(
const struct ast_channel *chan);
/*!
* \brief Returns the handler for the channel with the given id.
* \param channel_id Uniqueid of the channel.
* \return NULL channel not in Stasis application, or channel does not exist.
* \return Pointer to \c res_stasis handler.
*/
struct stasis_app_control *stasis_app_control_find_by_channel_id(
const char *channel_id);
/*!
* \brief Returns the uniqueid of the channel associated with this control
*
* \param control Control object.
* \return Uniqueid of the associate channel.
* \return \c NULL if \a control is \c NULL.
*/
const char *stasis_app_control_get_channel_id(
const struct stasis_app_control *control);
/*!
* \brief Exit \c res_stasis and continue execution in the dialplan.
*
* If the channel is no longer in \c res_stasis, this function does nothing.
*
* \param control Control for \c res_stasis
*/
void stasis_app_control_continue(struct stasis_app_control *control);
/*!
* \brief Answer the channel associated with this control.
* \param control Control for \c res_stasis.
* \return 0 for success.
* \return Non-zero for error.
*/
int stasis_app_control_answer(struct stasis_app_control *control);
/*!
* \brief Returns the most recent snapshot for the associated channel.
*
* The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
*
* \param control Control for \c res_stasis.
* \return Most recent snapshot. ao2_cleanup() when done.
* \return \c NULL if channel isn't in cache.
*/
struct ast_channel_snapshot *stasis_app_control_get_snapshot(
const struct stasis_app_control *control);
/*!
* \brief Publish a message to the \a control's channel's topic.
*
* \param control Control to publish to
* \param message Message to publish
*/
void stasis_app_control_publish(
struct stasis_app_control *control, struct stasis_message *message);
/*!
* \brief Queue a control frame without payload.
*
* \param control Control to publish to.
* \param frame_type type of control frame.
*
* \return zero on success
* \return non-zero on failure
*/
int stasis_app_control_queue_control(struct stasis_app_control *control,
enum ast_control_frame_type frame_type);
/*!
* \brief Increment the res_stasis reference count.
*
* This ensures graceful shutdown happens in the proper order.
*/
void stasis_app_ref(void);
/*!
* \brief Decrement the res_stasis reference count.
*
* This ensures graceful shutdown happens in the proper order.
*/
void stasis_app_unref(void);
/*! @} */
#endif /* _ASTERISK_STASIS_APP_H */
|
