This patch implements the REST API's for POST /channels/{channelId}/play
[asterisk/asterisk.git] / include / asterisk / stasis_channels.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Matt Jordan <mjordan@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
20 #ifndef STASIS_CHANNELS_H_
21 #define STASIS_CHANNELS_H_
22
23 #include "asterisk/stringfields.h"
24 #include "asterisk/stasis.h"
25 #include "asterisk/json.h"
26 #include "asterisk/channel.h"
27
28 /*! \addtogroup StasisTopicsAndMessages
29  * @{
30  */
31
32 /*!
33  * \since 12
34  * \brief Structure representing a snapshot of channel state.
35  *
36  * While not enforced programmatically, this object is shared across multiple
37  * threads, and should be treated as an immutable object.
38  */
39 struct ast_channel_snapshot {
40         AST_DECLARE_STRING_FIELDS(
41                 AST_STRING_FIELD(name);                 /*!< ASCII unique channel name */
42                 AST_STRING_FIELD(accountcode);          /*!< Account code for billing */
43                 AST_STRING_FIELD(peeraccount);          /*!< Peer account code for billing */
44                 AST_STRING_FIELD(userfield);            /*!< Userfield for CEL billing */
45                 AST_STRING_FIELD(uniqueid);             /*!< Unique Channel Identifier */
46                 AST_STRING_FIELD(linkedid);             /*!< Linked Channel Identifier -- gets propagated by linkage */
47                 AST_STRING_FIELD(parkinglot);           /*!< Default parking lot, if empty, default parking lot */
48                 AST_STRING_FIELD(hangupsource);         /*!< Who is responsible for hanging up this channel */
49                 AST_STRING_FIELD(appl);                 /*!< Current application */
50                 AST_STRING_FIELD(data);                 /*!< Data passed to current application */
51                 AST_STRING_FIELD(context);              /*!< Dialplan: Current extension context */
52                 AST_STRING_FIELD(exten);                /*!< Dialplan: Current extension number */
53                 AST_STRING_FIELD(caller_name);          /*!< Caller ID Name */
54                 AST_STRING_FIELD(caller_number);        /*!< Caller ID Number */
55                 AST_STRING_FIELD(connected_name);       /*!< Connected Line Name */
56                 AST_STRING_FIELD(connected_number);     /*!< Connected Line Number */
57                 AST_STRING_FIELD(language);             /*!< The default spoken language for the channel */
58         );
59
60         struct timeval creationtime;    /*!< The time of channel creation */
61         enum ast_channel_state state;   /*!< State of line */
62         int priority;                   /*!< Dialplan: Current extension priority */
63         int amaflags;                   /*!< AMA flags for billing */
64         int hangupcause;                /*!< Why is the channel hanged up. See causes.h */
65         int caller_pres;                /*!< Caller ID presentation. */
66         struct ast_flags flags;         /*!< channel flags of AST_FLAG_ type */
67         struct varshead *manager_vars;  /*!< Variables to be appended to manager events */
68 };
69
70 /*!
71  * \since 12
72  * \brief Blob of data associated with a channel.
73  *
74  * This blob is actually shared amongst several \ref stasis_message_type's.
75  */
76 struct ast_channel_blob {
77         /*! Channel blob is associated with (or NULL for global/all channels) */
78         struct ast_channel_snapshot *snapshot;
79         /*! JSON blob of data */
80         struct ast_json *blob;
81 };
82
83 /*!
84  * \since 12
85  * \brief A set of channels with blob objects - see \ref ast_channel_blob
86  */
87 struct ast_multi_channel_blob;
88
89 /*!
90  * \since 12
91  * \brief A topic which publishes the events for all channels.
92  * \retval Topic for all channel events.
93  */
94 struct stasis_topic *ast_channel_topic_all(void);
95
96 /*!
97  * \since 12
98  * \brief A caching topic which caches \ref ast_channel_snapshot messages from
99  * ast_channel_events_all(void).
100  *
101  * \retval Topic for all channel events.
102  */
103 struct stasis_caching_topic *ast_channel_topic_all_cached(void);
104
105 /*!
106  * \since 12
107  * \brief Message type for \ref ast_channel_snapshot.
108  *
109  * \retval Message type for \ref ast_channel_snapshot.
110  */
111 struct stasis_message_type *ast_channel_snapshot_type(void);
112
113 /*!
114  * \since 12
115  * \brief Generate a snapshot of the channel state. This is an ao2 object, so
116  * ao2_cleanup() to deallocate.
117  *
118  * \param chan The channel from which to generate a snapshot
119  *
120  * \retval pointer on success (must be ast_freed)
121  * \retval NULL on error
122  */
123 struct ast_channel_snapshot *ast_channel_snapshot_create(
124         struct ast_channel *chan);
125
126 /*!
127  * \since 12
128  * \brief Get the most recent snapshot for channel with the given \a uniqueid.
129  *
130  * \param uniqueid Uniqueid of the snapshot to fetch.
131  * \return Most recent channel snapshot
132  * \return \c NULL on error
133  */
134 struct ast_channel_snapshot *ast_channel_snapshot_get_latest(
135         const char *uniqueid);
136
137 /*!
138  * \since 12
139  * \brief Creates a \ref ast_channel_blob message.
140  *
141  * The given \a blob should be treated as immutable and not modified after it is
142  * put into the message.
143  *
144  * \param chan Channel blob is associated with, or \c NULL for global/all channels.
145  * \param type Message type for this blob.
146  * \param blob JSON object representing the data, or \c NULL for no data. If
147  *             \c NULL, ast_json_null() is put into the object.
148  *
149  * \return \ref ast_channel_blob message.
150  * \return \c NULL on error
151  */
152 struct stasis_message *ast_channel_blob_create(struct ast_channel *chan,
153         struct stasis_message_type *type, struct ast_json *blob);
154
155 /*!
156  * \since 12
157  * \brief Create a \ref ast_channel_blob message, pulling channel state from
158  *        the cache.
159  *
160  * \param uniqueid Uniqueid of the channel.
161  * \param type Message type for this blob.
162  * \param blob JSON object representing the data, or \c NULL for no data. If
163  *             \c NULL, ast_json_null() is put into the object.
164  *
165  * \return \ref ast_channel_blob message.
166  * \return \c NULL on error
167  */
168 struct stasis_message *ast_channel_blob_create_from_cache(
169         const char *uniqueid, struct stasis_message_type *type,
170         struct ast_json *blob);
171
172 /*!
173  * \since 12
174  * \brief Create a \ref ast_multi_channel_blob suitable for a \ref stasis_message.
175  *
176  * The given \a blob should be treated as immutable and not modified after it is
177  * put into the message.
178  *
179  * \param blob The JSON blob that defines the data of this \ref ast_multi_channel_blob
180  *
181  * \return \ref ast_multi_channel_blob object
182  * \return \c NULL on error
183 */
184 struct ast_multi_channel_blob *ast_multi_channel_blob_create(struct ast_json *blob);
185
186 /*!
187  * \since 12
188  * \brief Retrieve a channel snapshot associated with a specific role from a
189  * \ref ast_multi_channel_blob
190  *
191  * \note The reference count of the \ref ast_channel_snapshot returned from
192  * this function is not changed. The caller of this function does not own the
193  * reference to the snapshot.
194  *
195  * \param obj The \ref ast_multi_channel_blob containing the channel snapshot
196  * to retrieve
197  * \param role The role associated with the channel snapshot
198  *
199  * \retval \ref ast_channel_snapshot matching the role on success
200  * \retval NULL on error or not found for the role specified
201  */
202 struct ast_channel_snapshot *ast_multi_channel_blob_get_channel(
203         struct ast_multi_channel_blob *obj, const char *role);
204
205 /*!
206  * \since 12
207  * \brief Retrieve all channel snapshots associated with a specific role from
208  * a \ref ast_multi_channel_blob
209  *
210  * \note Because this function returns an ao2_container (hashed by channel name)
211  * of all channel snapshots that matched the passed in role, the reference of
212  * the snapshots is increased by this function. The caller of this function must
213  * release the reference to the snapshots by disposing of the container
214  * appropriately.
215  *
216  * \param obj The \ref ast_multi_channel_blob containing the channel snapshots to
217  * retrieve
218  * \param role The role associated with the channel snapshots
219  *
220  * \retval A container containing all \ref ast_channel_snapshot objects matching
221  * the role on success.
222  * \retval NULL on error or not found for the role specified
223  */
224 struct ao2_container *ast_multi_channel_blob_get_channels(
225         struct ast_multi_channel_blob *obj, const char *role);
226
227 /*!
228  * \since 12
229  * \brief Retrieve the JSON blob from a \ref ast_multi_channel_blob.
230  * Returned \ref ast_json is still owned by \a obj
231  *
232  * \param obj Channel blob object.
233  * \return Type field value from the blob.
234  * \return \c NULL on error.
235  */
236 struct ast_json *ast_multi_channel_blob_get_json(struct ast_multi_channel_blob *obj);
237
238 /*!
239  * \since 12
240  * \brief Add a \ref ast_channel_snapshot to a \ref ast_multi_channel_blob object
241  *
242  * \note This will increase the reference count by 1 for the channel snapshot. It is
243  * assumed that the \ref ast_multi_channel_blob will own a reference to the object.
244  *
245  * \param obj The \ref ast_multi_channel_blob object that will reference the snapshot
246  * \param role A \a role that the snapshot has in the multi channel relationship
247  * \param snapshot The \ref ast_channel_snapshot being added to the
248  * \ref ast_multi_channel_blob object
249  */
250 void ast_multi_channel_blob_add_channel(struct ast_multi_channel_blob *obj,
251         const char *role, struct ast_channel_snapshot *snapshot);
252
253 /*!
254  * \since 12
255  * \brief Publish a \ref ast_channel_snapshot for a channel.
256  *
257  * \param chan Channel to publish.
258  */
259 void ast_channel_publish_snapshot(struct ast_channel *chan);
260
261 /*!
262  * \since 12
263  * \brief Publish a \ref ast_channel_varset for a channel.
264  *
265  * \param chan Channel to pulish the event for, or \c NULL for 'none'.
266  * \param variable Name of the variable being set
267  * \param value Value.
268  */
269 void ast_channel_publish_varset(struct ast_channel *chan,
270                                 const char *variable, const char *value);
271
272 /*!
273  * \since 12
274  * \brief Message type for when a channel dials another channel
275  *
276  * \retval A stasis message type
277  */
278 struct stasis_message_type *ast_channel_dial_type(void);
279
280 /*!
281  * \since 12
282  * \brief Message type for when a variable is set on a channel.
283  *
284  * \retval A stasis message type
285  */
286 struct stasis_message_type *ast_channel_varset_type(void);
287
288 /*!
289  * \since 12
290  * \brief Message type for when a custom user event is sent on a channel.
291  *
292  * \retval A stasis message type
293  */
294 struct stasis_message_type *ast_channel_user_event_type(void);
295
296 /*!
297  * \since 12
298  * \brief Message type for when a hangup is requested on a channel.
299  *
300  * \retval A stasis message type
301  */
302 struct stasis_message_type *ast_channel_hangup_request_type(void);
303
304 /*!
305  * \since 12
306  * \brief Message type for when DTMF begins on a channel.
307  *
308  * \retval A stasis message type
309  */
310 struct stasis_message_type *ast_channel_dtmf_begin_type(void);
311
312 /*!
313  * \since 12
314  * \brief Message type for when DTMF ends on a channel.
315  *
316  * \retval A stasis message type
317  */
318 struct stasis_message_type *ast_channel_dtmf_end_type(void);
319
320 /*!
321  * \since 12
322  * \brief Publish in the \ref ast_channel_topic or \ref ast_channel_topic_all
323  * topics a stasis message for the channels involved in a dial operation.
324  *
325  * \param caller The channel performing the dial operation
326  * \param peer The channel being dialed
327  * \param dialstring When beginning a dial, the information passed to the
328  * dialing application
329  * \param dialstatus The current status of the dial operation (NULL if no
330  * status is known)
331  */
332 void ast_channel_publish_dial(struct ast_channel *caller,
333                 struct ast_channel *peer,
334                 const char *dialstring,
335                 const char *dialstatus);
336
337 /*!
338  * \since 12
339  * \brief Publish in the \ref ast_channel_topic a \ref ast_channel_snapshot
340  * message indicating a change in channel state
341  *
342  * \param chan The channel whose state has changed
343  */
344 void ast_publish_channel_state(struct ast_channel *chan);
345
346 /*! @} */
347
348 /*!
349  * \brief Build a JSON object from a \ref ast_channel_snapshot.
350  * \return JSON object representing channel snapshot.
351  * \return \c NULL on error
352  */
353 struct ast_json *ast_channel_snapshot_to_json(const struct ast_channel_snapshot *snapshot);
354
355 /*!
356  * \brief Compares the context, exten and priority of two snapshots.
357  * \since 12
358  *
359  * \param old_snapshot Old snapshot
360  * \param new_snapshot New snapshot
361  *
362  * \return True (non-zero) if context, exten or priority are identical.
363  * \return False (zero) if context, exten and priority changed.
364  */
365 int ast_channel_snapshot_cep_equal(
366         const struct ast_channel_snapshot *old_snapshot,
367         const struct ast_channel_snapshot *new_snapshot);
368
369 /*!
370  * \brief Compares the callerid info of two snapshots.
371  * \since 12
372  *
373  * \param old_snapshot Old snapshot
374  * \param new_snapshot New snapshot
375  *
376  * \return True (non-zero) if callerid are identical.
377  * \return False (zero) if callerid changed.
378  */
379 int ast_channel_snapshot_caller_id_equal(
380         const struct ast_channel_snapshot *old_snapshot,
381         const struct ast_channel_snapshot *new_snapshot);
382
383 /*!
384  * \brief Dispose of the stasis channel topics and message types
385  */
386 void ast_stasis_channels_shutdown(void);
387
388 /*!
389  * \brief Initialize the stasis channel topic and message types
390  */
391 void ast_stasis_channels_init(void);
392
393 #endif /* STASIS_CHANNELS_H_ */