Fix race condition that could result in ARI transfer messages not being sent.
[asterisk/asterisk.git] / include / asterisk / stasis_bridges.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013 Digium, Inc.
5  *
6  * Kinsey Moore <kmoore@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 _STASIS_BRIDGING_H
20 #define _STASIS_BRIDGING_H
21
22 #if defined(__cplusplus) || defined(c_plusplus)
23 extern "C" {
24 #endif
25
26 #include "asterisk/stringfields.h"
27 #include "asterisk/utils.h"
28 #include "asterisk/lock.h"
29 #include "asterisk/linkedlists.h"
30 #include "asterisk/channel.h"
31 #include "asterisk/bridge.h"
32 #include "asterisk/pbx.h"
33
34 /*!
35  * \brief Structure that contains a snapshot of information about a bridge
36  */
37 struct ast_bridge_snapshot {
38         AST_DECLARE_STRING_FIELDS(
39                 /*! Immutable bridge UUID. */
40                 AST_STRING_FIELD(uniqueid);
41                 /*! Bridge technology that is handling the bridge */
42                 AST_STRING_FIELD(technology);
43                 /*! Bridge subclass that is handling the bridge */
44                 AST_STRING_FIELD(subclass);
45                 /*! Creator of the bridge */
46                 AST_STRING_FIELD(creator);
47                 /*! Name given to the bridge by its creator */
48                 AST_STRING_FIELD(name);
49         );
50         /*! AO2 container of bare channel uniqueid strings participating in the bridge.
51          * Allocated from ast_str_container_alloc() */
52         struct ao2_container *channels;
53         /*! Bridge flags to tweak behavior */
54         struct ast_flags feature_flags;
55         /*! Bridge capabilities */
56         uint32_t capabilities;
57         /*! Number of channels participating in the bridge */
58         unsigned int num_channels;
59         /*! Number of active channels in the bridge. */
60         unsigned int num_active;
61 };
62
63 /*!
64  * \since 12
65  * \brief Generate a snapshot of the bridge state. This is an ao2 object, so
66  * ao2_cleanup() to deallocate.
67  *
68  * \pre Bridge is locked
69  *
70  * \param bridge The bridge from which to generate a snapshot
71  *
72  * \retval AO2 refcounted snapshot on success
73  * \retval NULL on error
74  */
75 struct ast_bridge_snapshot *ast_bridge_snapshot_create(struct ast_bridge *bridge);
76
77 /*!
78  * \since 12
79  * \brief Message type for \ref ast_bridge_snapshot.
80  *
81  * \retval Message type for \ref ast_bridge_snapshot.
82  */
83 struct stasis_message_type *ast_bridge_snapshot_type(void);
84
85 /*!
86  * \since 12
87  * \brief A topic which publishes the events for a particular bridge.
88  *
89  * If the given \a bridge is \c NULL, ast_bridge_topic_all() is returned.
90  *
91  * \param bridge Bridge for which to get a topic or \c NULL.
92  *
93  * \retval Topic for bridge's events.
94  * \retval ast_bridge_topic_all() if \a bridge is \c NULL.
95  */
96 struct stasis_topic *ast_bridge_topic(struct ast_bridge *bridge);
97
98 /*!
99  * \since 12
100  * \brief A topic which publishes the events for a particular bridge.
101  *
102  * \ref ast_bridge_snapshot messages are replaced with stasis_cache_update
103  * messages.
104  *
105  * If the given \a bridge is \c NULL, ast_bridge_topic_all_cached() is returned.
106  *
107  * \param bridge Bridge for which to get a topic or \c NULL.
108  *
109  * \retval Topic for bridge's events.
110  * \retval ast_bridge_topic_all() if \a bridge is \c NULL.
111  */
112 struct stasis_topic *ast_bridge_topic_cached(struct ast_bridge *bridge);
113
114 /*!
115  * \since 12
116  * \brief A topic which publishes the events for all bridges.
117  * \retval Topic for all bridge events.
118  */
119 struct stasis_topic *ast_bridge_topic_all(void);
120
121 /*!
122  * \since 12
123  * \brief A caching topic which caches \ref ast_bridge_snapshot messages from
124  * ast_bridge_events_all(void).
125  *
126  * \retval Caching topic for all bridge events.
127  */
128 struct stasis_topic *ast_bridge_topic_all_cached(void);
129
130 /*!
131  * \since 12
132  * \brief Backend cache for ast_bridge_topic_all_cached().
133  * \retval Cache of \ref ast_bridge_snapshot.
134  */
135 struct stasis_cache *ast_bridge_cache(void);
136
137 /*!
138  * \since 12
139  * \brief Publish the state of a bridge
140  *
141  * \pre Bridge is locked
142  *
143  * \param bridge The bridge for which to publish state
144  */
145 void ast_bridge_publish_state(struct ast_bridge *bridge);
146
147 /*! \brief Message representing the merge of two bridges */
148 struct ast_bridge_merge_message {
149         struct ast_bridge_snapshot *from;       /*!< Bridge from which channels will be removed during the merge */
150         struct ast_bridge_snapshot *to;         /*!< Bridge to which channels will be added during the merge */
151 };
152
153 /*!
154  * \since 12
155  * \brief Message type for \ref ast_bridge_merge_message.
156  *
157  * \retval Message type for \ref ast_bridge_merge_message.
158  */
159 struct stasis_message_type *ast_bridge_merge_message_type(void);
160
161 /*!
162  * \since 12
163  * \brief Publish a bridge merge
164  *
165  * \pre Bridges involved are locked
166  *
167  * \param to The bridge to which channels are being added
168  * \param from The bridge from which channels are being removed
169  */
170 void ast_bridge_publish_merge(struct ast_bridge *to, struct ast_bridge *from);
171
172 /*!
173  * \since 12
174  * \brief Blob of data associated with a bridge.
175  *
176  * The \c blob is actually a JSON object of structured data. It has a "type" field
177  * which contains the type string describing this blob.
178  */
179 struct ast_bridge_blob {
180         /*! Bridge blob is associated with (or NULL for global/all bridges) */
181         struct ast_bridge_snapshot *bridge;
182         /*! Channel blob is associated with (may be NULL for some messages) */
183         struct ast_channel_snapshot *channel;
184         /*! JSON blob of data */
185         struct ast_json *blob;
186 };
187
188 /*!
189  * \since 12
190  * \brief Message type for \ref channel enter bridge blob messages.
191  *
192  * \retval Message type for \ref channel enter bridge blob messages.
193  */
194 struct stasis_message_type *ast_channel_entered_bridge_type(void);
195
196 /*!
197  * \since 12
198  * \brief Message type for \ref channel leave bridge blob messages.
199  *
200  * \retval Message type for \ref channel leave bridge blob messages.
201  */
202 struct stasis_message_type *ast_channel_left_bridge_type(void);
203
204 /*!
205  * \since 12
206  * \brief Creates a \ref ast_bridge_blob message.
207  *
208  * The \a blob JSON object requires a \c "type" field describing the blob. It
209  * should also be treated as immutable and not modified after it is put into the
210  * message.
211  *
212  * \pre bridge is locked.
213  * \pre No channels are locked.
214  *
215  * \param bridge Channel blob is associated with, or NULL for global/all bridges.
216  * \param blob JSON object representing the data.
217  * \return \ref ast_bridge_blob message.
218  * \return \c NULL on error
219  */
220 struct stasis_message *ast_bridge_blob_create(struct stasis_message_type *type,
221         struct ast_bridge *bridge,
222         struct ast_channel *chan,
223         struct ast_json *blob);
224
225 /*!
226  * \since 12
227  * \brief Publish a bridge channel enter event
228  *
229  * \pre bridge is locked.
230  * \pre No channels are locked.
231  *
232  * \param bridge The bridge a channel entered
233  * \param chan The channel that entered the bridge
234  * \param swap The channel being swapped out of the bridge
235  */
236 void ast_bridge_publish_enter(struct ast_bridge *bridge, struct ast_channel *chan,
237                 struct ast_channel *swap);
238
239 /*!
240  * \since 12
241  * \brief Publish a bridge channel leave event
242  *
243  * \pre bridge is locked.
244  * \pre No channels are locked.
245  *
246  * \param bridge The bridge a channel left
247  * \param chan The channel that left the bridge
248  */
249 void ast_bridge_publish_leave(struct ast_bridge *bridge, struct ast_channel *chan);
250
251 /*!
252  * \brief Build a JSON object from a \ref ast_bridge_snapshot.
253  *
254  * \param snapshot The bridge snapshot to convert to JSON
255  * \param sanitize The message sanitizer to use on the snapshot
256  *
257  * \return JSON object representing bridge snapshot.
258  * \return \c NULL on error
259  */
260 struct ast_json *ast_bridge_snapshot_to_json(const struct ast_bridge_snapshot *snapshot,
261         const struct stasis_message_sanitizer *sanitize);
262
263 /*!
264  * \brief Pair showing a bridge snapshot and a specific channel snapshot belonging to the bridge
265  */
266 struct ast_bridge_channel_snapshot_pair {
267         struct ast_bridge_snapshot *bridge_snapshot;
268         struct ast_channel_snapshot *channel_snapshot;
269 };
270
271 /*!
272  * \since 12
273  * \brief Message type for \ref ast_blind_transfer_message.
274  *
275  * \retval Message type for \ref ast_blind_transfer_message.
276  */
277 struct stasis_message_type *ast_blind_transfer_type(void);
278
279 /*!
280  * \brief Message published during a blind transfer
281  */
282 struct ast_blind_transfer_message {
283         /*! Result of the transfer */
284         enum ast_transfer_result result;
285         /*! True if the transfer was initiated by an external source (i.e. not DTMF-initiated) */
286         int is_external;
287         /*! The transferring channel */
288         struct ast_channel_snapshot *transferer;
289         /*! The bridge between the transferer and the transferee */
290         struct ast_bridge_snapshot *bridge;
291         /*! Destination context */
292         char context[AST_MAX_CONTEXT];
293         /*! Destination extension */
294         char exten[AST_MAX_EXTENSION];
295         /*! Transferee channel. NULL if there were multiple transferee channels */
296         struct ast_channel_snapshot *transferee;
297         /*! The channel replacing the transferer when multiple parties are being transferred */
298         struct ast_channel_snapshot *replace_channel;
299 };
300
301 /*!
302  * \brief Create a blind transfer message to be published
303  *
304  * \param is_external Whether the blind transfer was initiated externally (e.g. via AMI or native protocol)
305  * \param transferer The transferer's channel that is bridged to the transferee
306  * \param bridge The bridge the transferer and transferee are in
307  * \param context The destination context for the blind transfer
308  * \param exten The destination extension for the blind transfer
309  *
310  * \retval NULL Failure to allocate or create snapshots
311  * \retval non-NULL The created blind transfer message
312  */
313 struct ast_blind_transfer_message *ast_blind_transfer_message_create(int is_external,
314                 struct ast_channel *transferer, const char *exten, const char *context);
315
316 /*!
317  * \brief Publish a blind transfer event
318  *
319  * \pre Bridges involved are locked. Channels involved are not locked.
320  *
321  * \param is_external Whether the blind transfer was initiated externally (e.g. via AMI or native protocol)
322  * \param result The success or failure of the transfer
323  * \param to_transferee The bridge between the transferer and transferee plus the transferer channel
324  * \param context The destination context for the blind transfer
325  * \param exten The destination extension for the blind transfer
326  * \param transferee_channel If a single channel is being transferred, this is it. If
327  *                           multiple parties are being transferred, this is NULL.
328  * \param replace_channel If multiple parties are being transferred or the transfer
329  *                        cannot reach across the bridge due to bridge flags, this is
330  *                        the channel connecting their bridge to the destination.
331  */
332 void ast_bridge_publish_blind_transfer(struct ast_blind_transfer_message *transfer_message);
333
334 enum ast_attended_transfer_dest_type {
335         /*! The transfer failed, so there is no appropriate final state */
336         AST_ATTENDED_TRANSFER_DEST_FAIL,
337         /*! The transfer results in a single bridge remaining due to a merge or swap */
338         AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE,
339         /*! The transfer results in a channel or bridge running an application */
340         AST_ATTENDED_TRANSFER_DEST_APP,
341         /*! The transfer results in a channel or bridge running an application via a local channel */
342         AST_ATTENDED_TRANSFER_DEST_LOCAL_APP,
343         /*! The transfer results in both bridges remaining with a local channel linking them */
344         AST_ATTENDED_TRANSFER_DEST_LINK,
345         /*! The transfer results in a threeway call between transferer, transferee, and transfer target */
346         AST_ATTENDED_TRANSFER_DEST_THREEWAY,
347 };
348
349 /*!
350  * \brief Message representing attended transfer
351  */
352 struct ast_attended_transfer_message {
353         /*! Result of the attended transfer */
354         enum ast_transfer_result result;
355         /*! Indicates if the transfer was initiated externally*/
356         int is_external;
357         /*! Bridge between transferer <-> transferee and the transferer channel in that bridge. May be NULL */
358         struct ast_bridge_channel_snapshot_pair to_transferee;
359         /*! Bridge between transferer <-> transfer target and the transferer channel in that bridge. May be NULL */
360         struct ast_bridge_channel_snapshot_pair to_transfer_target;
361         /*! Local channel connecting transferee bridge to application */
362         struct ast_channel_snapshot *replace_channel;
363         /*! Transferee channel. Will be NULL if there were multiple channels transferred. */
364         struct ast_channel_snapshot *transferee;
365         /*! Transfer target channel. Will be NULL if there were multiple channels targeted. */
366         struct ast_channel_snapshot *target;
367         /*! Indicates the final state of the transfer */
368         enum ast_attended_transfer_dest_type dest_type;
369         union {
370                 /*! ID of the surviving bridge. Applicable for AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE */
371                 char bridge[AST_UUID_STR_LEN];
372                 /*! Destination application of transfer. Applicable for AST_ATTENDED_TRANSFER_DEST_APP */
373                 char app[AST_MAX_APP];
374                 /*! Pair of local channels linking the bridges. Applicable for AST_ATTENDED_TRANSFER_DEST_LINK */
375                 struct ast_channel_snapshot *links[2];
376                 /*! Transferer channel and bridge that survived the transition to a threeway call. Applicable for AST_ATTENDED_TRANSFER_DEST_THREEWAY */
377                 struct ast_bridge_channel_snapshot_pair threeway;
378         } dest;
379 };
380
381 /*!
382  * \brief Create an Attended transfer message to be published.
383  *
384  * The parameters to this function are the basic necessities in order to create the
385  * initial attended transfer message.
386  *
387  * The transferee and transfer_target parameters are optional. If not provided, then this
388  * function will attempt to determine who the transferee and transfer target are based on
389  * the input transferer channels and bridges. You typically will not need to provide an
390  * explicit transferee and transfer target channel unless your attended transfer is implemented
391  * in a strange way.
392  *
393  * \param is_external Non-zero if the transfer was initiated by a native channel driver protocol.
394  * \param to_transferee The transferer channel that is bridged to the transferee channel.
395  * \param transferee_bridge The bridge between the transferer and transferee. May be NULL.
396  * \param to_transfer_target The transferer channel that is bridged to the transfer target.
397  * \param target_bridge The bridge between the transferer and transfer target. May be NULL.
398  * \param transferee The channel that is being transferred. Optional.
399  * \param transfer_target The channel that is being transferred to. Optional.
400  *
401  * \retval NULL Failure to allocate or create snapshots
402  * \retval non-NULL The created attended transfer message
403  */
404 struct ast_attended_transfer_message *ast_attended_transfer_message_create(
405                 int is_external, struct ast_channel *to_transferee, struct ast_bridge *transferee_bridge,
406                 struct ast_channel *to_transfer_target, struct ast_bridge *target_bridge,
407                 struct ast_channel *transferee, struct ast_channel *transfer_target);
408
409 /*!
410  * \brief Add details for a bridge merge to an attended transfer message.
411  *
412  * If the transfer is accomplished by a bridge merge (or swap optimization), then this should
413  * be called on the created attended transfer message to have the appropriate details added on.
414  *
415  * \param transfer_msg The transfer message to add details to
416  * \param final_bridge The bridge where the surviving parties reside
417  *
418  * \retval 0 Success
419  * \retval -1 Failure
420  */
421 int ast_attended_transfer_message_add_merge(struct ast_attended_transfer_message *transfer_msg,
422                 struct ast_bridge *final_bridge);
423
424 /*!
425  * \brief Add details for an attended transfer that was resolved as a three-way call
426  *
427  * If the transfer results in a three-way call between the transferer, the transferee, and the
428  * transfer target, then this should be called in order to add appropriate details to the
429  * transfer message to be published.
430  *
431  * \param transfer_msg The message to add details to
432  * \param survivor_channel The transferer channel that exists in the three-way call
433  * \param survivor_bridge The bridge where the three-way call takes place.
434  *
435  * \retval 0 Success
436  * \retval -1 Failure
437  */
438 int ast_attended_transfer_message_add_threeway(struct ast_attended_transfer_message *transfer_msg,
439                 struct ast_channel *survivor_channel, struct ast_bridge *survivor_bridge);
440
441 /*!
442  * \brief Add details for an attended transfer to an application
443  *
444  * If the transfer is sending one or more parties into an application, then this should be called
445  * to add appropriate details to the transfer message being published.
446  *
447  * \param transfer_msg The message to add details to
448  * \param app The name of the application that the parties are being transferred to
449  * \param replace_channel The local channel that is in the bridge and running the application
450  *
451  * \retval 0 Success
452  * \retval -1 Failure
453  */
454 int ast_attended_transfer_message_add_app(struct ast_attended_transfer_message *transfer_msg,
455                 const char *app, struct ast_channel *replace_channel);
456
457 /*!
458  * \brief Add details for an attended transfer that has a link between bridges.
459  *
460  * An attended transfer may be accomplished by linking two bridges together with local channels.
461  * If this is how the transfer is to be completed, call this function in order to fill in details
462  * about the transfer.
463  *
464  * \param transfer_msg The message to add details to.
465  * \param locals An array of local channel halves that each are in one of the involved bridges.
466  *
467  * \retval 0 Success
468  * \retval -1 Failure
469  */
470 int ast_attended_transfer_message_add_link(struct ast_attended_transfer_message *transfer_msg,
471                 struct ast_channel *locals[2]);
472
473 /*!
474  * \brief Publish an attended transfer
475  *
476  * \param transfer_msg The transfer message to publish
477  */
478 void ast_bridge_publish_attended_transfer(struct ast_attended_transfer_message *transfer_msg);
479
480 /*!
481  * \since 12
482  * \brief Message type for \ref ast_attended_transfer_message.
483  *
484  * \retval Message type for \ref ast_attended_transfer_message.
485  */
486 struct stasis_message_type *ast_attended_transfer_type(void);
487
488 /*!
489  * \brief Returns the most recent snapshot for the bridge.
490  *
491  * The returned pointer is AO2 managed, so ao2_cleanup() when you're done.
492  *
493  * \param bridge_id Uniqueid of the bridge for which to get the snapshot.
494  * \return Most recent snapshot. ao2_cleanup() when done.
495  * \return \c NULL if channel isn't in cache.
496  */
497 struct ast_bridge_snapshot *ast_bridge_snapshot_get_latest(
498         const char *bridge_id);
499
500 /*!
501  * \internal
502  * \brief Initialize the topics for a single bridge.
503  * \return 0 on success.
504  * \return Non-zero on error.
505  */
506 int bridge_topics_init(struct ast_bridge *bridge);
507
508 /*!
509  * \internal
510  * \brief Initialize the stasis bridging topic and message types
511  * \retval 0 on success
512  * \retval -1 on failure
513  */
514 int ast_stasis_bridging_init(void);
515
516 #if defined(__cplusplus) || defined(c_plusplus)
517 }
518 #endif
519
520 #endif  /* _STASIS_BRIDGING_H */