519a4b676e17c05715f1d0d1a7abcfead47c6fbe
[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(type);             /*!< Type of channel technology */
43                 AST_STRING_FIELD(accountcode);      /*!< Account code for billing */
44                 AST_STRING_FIELD(peeraccount);      /*!< Peer account code for billing */
45                 AST_STRING_FIELD(userfield);        /*!< Userfield for CEL billing */
46                 AST_STRING_FIELD(uniqueid);         /*!< Unique Channel Identifier */
47                 AST_STRING_FIELD(linkedid);         /*!< Linked Channel Identifier -- gets propagated by linkage */
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(caller_dnid);      /*!< Dialed ID Number */
56                 AST_STRING_FIELD(caller_ani);       /*!< Caller ID ANI Number */
57                 AST_STRING_FIELD(caller_rdnis);     /*!< Caller ID RDNIS Number */
58                 AST_STRING_FIELD(caller_subaddr);   /*!< Caller subaddress */
59                 AST_STRING_FIELD(dialed_subaddr);   /*!< Dialed subaddress */
60                 AST_STRING_FIELD(connected_name);   /*!< Connected Line Name */
61                 AST_STRING_FIELD(connected_number); /*!< Connected Line Number */
62                 AST_STRING_FIELD(effective_name);   /*!< Effective Connected Line Name */
63                 AST_STRING_FIELD(effective_number); /*!< Effective Connected Line Number */
64                 AST_STRING_FIELD(language);         /*!< The default spoken language for the channel */
65                 AST_STRING_FIELD(bridgeid);         /*!< Unique Bridge Identifier */
66                 AST_STRING_FIELD(nativeformats);    /*!< Native formats on the channel */
67                 AST_STRING_FIELD(readformat);       /*!< The current read format */
68                 AST_STRING_FIELD(writeformat);      /*!< The current write format */
69                 AST_STRING_FIELD(writetrans);       /*!< The current write translation path */
70                 AST_STRING_FIELD(readtrans);        /*!< The current read translation path */
71         );
72
73         char callid[AST_CALLID_BUFFER_LENGTH];  /*!< Callid for the channel */
74         struct timeval creationtime;            /*!< The time of channel creation */
75         struct timeval hanguptime;              /*!< When the channel should hang up */
76         enum ast_channel_state state;           /*!< State of line */
77         int priority;                           /*!< Dialplan: Current extension priority */
78         int amaflags;                           /*!< AMA flags for billing */
79         int hangupcause;                        /*!< Why is the channel hanged up. See causes.h */
80         int caller_pres;                        /*!< Caller ID presentation. */
81         struct ast_flags flags;                 /*!< channel flags of AST_FLAG_ type */
82         ast_group_t callgroup;                  /*!< Call group */
83         ast_group_t pickupgroup;                /*!< Pickup group */
84         struct ast_flags softhangup_flags;      /*!< softhangup channel flags */
85         struct varshead *manager_vars;          /*!< Variables to be appended to manager events */
86         struct varshead *channel_vars;          /*!< Variables set on the channel */
87         int tech_properties;                    /*!< Properties of the channel's technology */
88 };
89
90 /*!
91  * \since 12
92  * \brief Blob of data associated with a channel.
93  *
94  * This blob is actually shared amongst several \ref stasis_message_type's.
95  */
96 struct ast_channel_blob {
97         /*! Channel blob is associated with (or NULL for global/all channels) */
98         struct ast_channel_snapshot *snapshot;
99         /*! JSON blob of data */
100         struct ast_json *blob;
101 };
102
103 /*!
104  * \since 12
105  * \brief A set of channels with blob objects - see \ref ast_channel_blob
106  */
107 struct ast_multi_channel_blob;
108
109 struct stasis_cp_all *ast_channel_cache_all(void);
110
111 /*!
112  * \since 12
113  * \brief A topic which publishes the events for all channels.
114  * \retval Topic for all channel events.
115  */
116 struct stasis_topic *ast_channel_topic_all(void);
117
118 /*!
119  * \since 12
120  * \brief A caching topic which caches \ref ast_channel_snapshot messages from
121  * ast_channel_events_all(void).
122  *
123  * \retval Topic for all channel events.
124  */
125 struct stasis_topic *ast_channel_topic_all_cached(void);
126
127 /*!
128  * \since 12
129  * \brief Primary channel cache, indexed by Uniqueid.
130  *
131  * \retval Cache of \ref ast_channel_snapshot.
132  */
133 struct stasis_cache *ast_channel_cache(void);
134
135 /*!
136  * \since 12
137  * \brief Secondary channel cache, indexed by name.
138  *
139  * \retval Cache of \ref ast_channel_snapshot.
140  */
141 struct stasis_cache *ast_channel_cache_by_name(void);
142
143 /*!
144  * \since 12
145  * \brief Message type for \ref ast_channel_snapshot.
146  *
147  * \retval Message type for \ref ast_channel_snapshot.
148  */
149 struct stasis_message_type *ast_channel_snapshot_type(void);
150
151 /*!
152  * \since 12
153  * \brief Generate a snapshot of the channel state. This is an ao2 object, so
154  * ao2_cleanup() to deallocate.
155  *
156  * \param chan The channel from which to generate a snapshot
157  *
158  * \retval pointer on success (must be unreffed)
159  * \retval NULL on error
160  */
161 struct ast_channel_snapshot *ast_channel_snapshot_create(
162         struct ast_channel *chan);
163
164 /*!
165  * \since 12
166  * \brief Obtain the latest \ref ast_channel_snapshot from the \ref stasis cache. This is
167  * an ao2 object, so use \ref ao2_cleanup() to deallocate.
168  *
169  * \param unique_id The channel's unique ID
170  *
171  * \retval A \ref ast_channel_snapshot on success
172  * \retval NULL on error
173  */
174 struct ast_channel_snapshot *ast_channel_snapshot_get_latest(const char *uniqueid);
175
176 /*!
177  * \since 12
178  * \brief Obtain the latest \ref ast_channel_snapshot from the \ref stasis cache. This is
179  * an ao2 object, so use \ref ao2_cleanup() to deallocate.
180  *
181  * \param name The channel's name
182  *
183  * \retval A \ref ast_channel_snapshot on success
184  * \retval NULL on error
185  */
186 struct ast_channel_snapshot *ast_channel_snapshot_get_latest_by_name(const char *name);
187
188 /*!
189  * \since 12
190  * \brief Creates a \ref ast_channel_blob message.
191  *
192  * The given \a blob should be treated as immutable and not modified after it is
193  * put into the message.
194  *
195  * \param chan Channel blob is associated with, or \c NULL for global/all channels.
196  * \param type Message type for this blob.
197  * \param blob JSON object representing the data, or \c NULL for no data. If
198  *             \c NULL, ast_json_null() is put into the object.
199  *
200  * \return \ref ast_channel_blob message.
201  * \return \c NULL on error
202  */
203 struct stasis_message *ast_channel_blob_create(struct ast_channel *chan,
204         struct stasis_message_type *type, struct ast_json *blob);
205
206 /*!
207  * \since 12
208  * \brief Create a \ref ast_channel_blob message, pulling channel state from
209  *        the cache.
210  *
211  * \param uniqueid Uniqueid of the channel.
212  * \param type Message type for this blob.
213  * \param blob JSON object representing the data, or \c NULL for no data. If
214  *             \c NULL, ast_json_null() is put into the object.
215  *
216  * \return \ref ast_channel_blob message.
217  * \return \c NULL on error
218  */
219 struct stasis_message *ast_channel_blob_create_from_cache(
220         const char *uniqueid, struct stasis_message_type *type,
221         struct ast_json *blob);
222
223 /*!
224  * \since 12
225  * \brief Create a \ref ast_multi_channel_blob suitable for a \ref stasis_message.
226  *
227  * The given \a blob should be treated as immutable and not modified after it is
228  * put into the message.
229  *
230  * \param blob The JSON blob that defines the data of this \ref ast_multi_channel_blob
231  *
232  * \return \ref ast_multi_channel_blob object
233  * \return \c NULL on error
234 */
235 struct ast_multi_channel_blob *ast_multi_channel_blob_create(struct ast_json *blob);
236
237 /*!
238  * \since 12
239  * \brief Retrieve a channel snapshot associated with a specific role from a
240  * \ref ast_multi_channel_blob
241  *
242  * \note The reference count of the \ref ast_channel_snapshot returned from
243  * this function is not changed. The caller of this function does not own the
244  * reference to the snapshot.
245  *
246  * \param obj The \ref ast_multi_channel_blob containing the channel snapshot
247  * to retrieve
248  * \param role The role associated with the channel snapshot
249  *
250  * \retval \ref ast_channel_snapshot matching the role on success
251  * \retval NULL on error or not found for the role specified
252  */
253 struct ast_channel_snapshot *ast_multi_channel_blob_get_channel(
254         struct ast_multi_channel_blob *obj, const char *role);
255
256 /*!
257  * \since 12
258  * \brief Retrieve all channel snapshots associated with a specific role from
259  * a \ref ast_multi_channel_blob
260  *
261  * \note Because this function returns an ao2_container (hashed by channel name)
262  * of all channel snapshots that matched the passed in role, the reference of
263  * the snapshots is increased by this function. The caller of this function must
264  * release the reference to the snapshots by disposing of the container
265  * appropriately.
266  *
267  * \param obj The \ref ast_multi_channel_blob containing the channel snapshots to
268  * retrieve
269  * \param role The role associated with the channel snapshots
270  *
271  * \retval A container containing all \ref ast_channel_snapshot objects matching
272  * the role on success.
273  * \retval NULL on error or not found for the role specified
274  */
275 struct ao2_container *ast_multi_channel_blob_get_channels(
276         struct ast_multi_channel_blob *obj, const char *role);
277
278 /*!
279  * \since 12
280  * \brief Retrieve the JSON blob from a \ref ast_multi_channel_blob.
281  * Returned \ref ast_json is still owned by \a obj
282  *
283  * \param obj Channel blob object.
284  * \return Type field value from the blob.
285  * \return \c NULL on error.
286  */
287 struct ast_json *ast_multi_channel_blob_get_json(struct ast_multi_channel_blob *obj);
288
289 /*!
290  * \since 12
291  * \brief Add a \ref ast_channel_snapshot to a \ref ast_multi_channel_blob object
292  *
293  * \note This will increase the reference count by 1 for the channel snapshot. It is
294  * assumed that the \ref ast_multi_channel_blob will own a reference to the object.
295  *
296  * \param obj The \ref ast_multi_channel_blob object that will reference the snapshot
297  * \param role A \a role that the snapshot has in the multi channel relationship
298  * \param snapshot The \ref ast_channel_snapshot being added to the
299  * \ref ast_multi_channel_blob object
300  */
301 void ast_multi_channel_blob_add_channel(struct ast_multi_channel_blob *obj,
302         const char *role, struct ast_channel_snapshot *snapshot);
303
304 /*!
305  * \brief Publish a channel blob message.
306  * \since 12.0.0
307  *
308  * \param chan Channel publishing the blob.
309  * \param type Type of stasis message.
310  * \param blob The blob being published. (NULL if no blob)
311  *
312  * \return Nothing
313  */
314 void ast_channel_publish_blob(struct ast_channel *chan, struct stasis_message_type *type,
315         struct ast_json *blob);
316
317 /*!
318  * \since 12
319  * \brief Set flag to indicate channel snapshot is being staged.
320  *
321  * \param chan Channel being staged.
322  */
323 void ast_channel_stage_snapshot(struct ast_channel *chan);
324
325 /*!
326  * \since 12
327  * \brief Clear flag to indicate channel snapshot is being staged, and publish snapshot.
328  *
329  * \param chan Channel being staged.
330  */
331 void ast_channel_stage_snapshot_done(struct ast_channel *chan);
332
333 /*!
334  * \since 12
335  * \brief Publish a \ref ast_channel_snapshot for a channel.
336  *
337  * \param chan Channel to publish.
338  */
339 void ast_channel_publish_snapshot(struct ast_channel *chan);
340
341 /*!
342  * \since 12
343  * \brief Publish a \ref ast_channel_varset for a channel.
344  *
345  * \param chan Channel to publish the event for, or \c NULL for 'none'.
346  * \param variable Name of the variable being set
347  * \param value Value.
348  */
349 void ast_channel_publish_varset(struct ast_channel *chan,
350                                 const char *variable, const char *value);
351
352 /*!
353  * \since 12
354  * \brief Message type for when a channel dials another channel
355  *
356  * \retval A stasis message type
357  */
358 struct stasis_message_type *ast_channel_dial_type(void);
359
360 /*!
361  * \since 12
362  * \brief Message type for when a variable is set on a channel.
363  *
364  * \retval A stasis message type
365  */
366 struct stasis_message_type *ast_channel_varset_type(void);
367
368 /*!
369  * \since 12
370  * \brief Message type for when a custom user event is sent on a channel.
371  *
372  * \retval A stasis message type
373  */
374 struct stasis_message_type *ast_channel_user_event_type(void);
375
376 /*!
377  * \since 12
378  * \brief Message type for when a hangup is requested on a channel.
379  *
380  * \retval A stasis message type
381  */
382 struct stasis_message_type *ast_channel_hangup_request_type(void);
383
384 /*!
385  * \since 12
386  * \brief Message type for when DTMF begins on a channel.
387  *
388  * \retval A stasis message type
389  */
390 struct stasis_message_type *ast_channel_dtmf_begin_type(void);
391
392 /*!
393  * \since 12
394  * \brief Message type for when DTMF ends on a channel.
395  *
396  * \retval A stasis message type
397  */
398 struct stasis_message_type *ast_channel_dtmf_end_type(void);
399
400 /*!
401  * \since 12
402  * \brief Message type for when a channel is placed on hold.
403  *
404  * \retval A stasis message type
405  */
406 struct stasis_message_type *ast_channel_hold_type(void);
407
408 /*!
409  * \since 12
410  * \brief Message type for when a channel is removed from hold.
411  *
412  * \retval A stasis message type
413  */
414 struct stasis_message_type *ast_channel_unhold_type(void);
415
416 /*!
417  * \since 12
418  * \brief Message type for when a channel starts spying on another channel
419  *
420  * \retval A stasis message type
421  */
422 struct stasis_message_type *ast_channel_chanspy_start_type(void);
423
424 /*!
425  * \since 12
426  * \brief Message type for when a channel stops spying on another channel
427  *
428  * \retval A stasis message type
429  */
430 struct stasis_message_type *ast_channel_chanspy_stop_type(void);
431
432 /*!
433  * \since 12
434  * \brief Message type for a fax operation
435  *
436  * \retval A stasis message type
437  */
438 struct stasis_message_type *ast_channel_fax_type(void);
439
440 /*!
441  * \since 12
442  * \brief Message type for hangup handler related actions
443  *
444  * \retval A stasis message type
445  */
446 struct stasis_message_type *ast_channel_hangup_handler_type(void);
447
448 /*!
449  * \since 12
450  * \brief Message type for starting monitor on a channel
451  *
452  * \retval A stasis message type
453  */
454 struct stasis_message_type *ast_channel_monitor_start_type(void);
455
456 /*!
457  * \since 12
458  * \brief Message type for stopping monitor on a channel
459  *
460  * \retval A stasis message type
461  */
462 struct stasis_message_type *ast_channel_monitor_stop_type(void);
463
464 /*!
465  * \since 12.0.0
466  * \brief Message type for agent login on a channel
467  *
468  * \retval A stasis message type
469  */
470 struct stasis_message_type *ast_channel_agent_login_type(void);
471
472 /*!
473  * \since 12.0.0
474  * \brief Message type for agent logoff on a channel
475  *
476  * \retval A stasis message type
477  */
478 struct stasis_message_type *ast_channel_agent_logoff_type(void);
479
480 /*!
481  * \since 12
482  * \brief Message type for starting music on hold on a channel
483  *
484  * \retval A stasis message type
485  */
486 struct stasis_message_type *ast_channel_moh_start_type(void);
487
488 /*!
489  * \since 12
490  * \brief Message type for stopping music on hold on a channel
491  *
492  * \retval A stasis message type
493  */
494 struct stasis_message_type *ast_channel_moh_stop_type(void);
495
496 /*!
497  * \since 12
498  * \brief Publish in the \ref ast_channel_topic or \ref ast_channel_topic_all
499  * topics a stasis message for the channels involved in a dial operation.
500  *
501  * \param caller The channel performing the dial operation
502  * \param peer The channel being dialed
503  * \param dialstring When beginning a dial, the information passed to the
504  * dialing application
505  * \param dialstatus The current status of the dial operation (NULL if no
506  * status is known)
507  */
508 void ast_channel_publish_dial(struct ast_channel *caller,
509                 struct ast_channel *peer,
510                 const char *dialstring,
511                 const char *dialstatus);
512
513 /*!
514  * \since 12
515  * \brief Publish in the \ref ast_channel_topic or \ref ast_channel_topic_all
516  * topics a stasis message for the channels involved in a dial operation that
517  * is forwarded.
518  *
519  * \param caller The channel performing the dial operation
520  * \param peer The channel being dialed
521  * \param dialstring The information passed to the dialing application when beginning a dial
522  * \param dialstatus The current status of the dial operation
523  * \param forward The call forward string provided by the dialed channel
524  */
525 void ast_channel_publish_dial_forward(struct ast_channel *caller,
526                 struct ast_channel *peer,
527                 const char *dialstring,
528                 const char *dialstatus,
529                 const char *forward);
530
531 /*!
532  * \since 12
533  * \brief Publish in the \ref ast_channel_topic a \ref ast_channel_snapshot
534  * message indicating a change in channel state
535  *
536  * \param chan The channel whose state has changed
537  */
538 void ast_publish_channel_state(struct ast_channel *chan);
539
540 /*! @} */
541
542 /*!
543  * \brief Build a JSON object from a \ref ast_channel_snapshot.
544  *
545  * \param snapshot The snapshot to convert to JSON
546  * \param sanitize The message sanitizer to use on the snapshot
547  *
548  * \return JSON object representing channel snapshot.
549  * \return \c NULL on error
550  */
551 struct ast_json *ast_channel_snapshot_to_json(const struct ast_channel_snapshot *snapshot,
552         const struct stasis_message_sanitizer *sanitize);
553
554 /*!
555  * \brief Compares the context, exten and priority of two snapshots.
556  * \since 12
557  *
558  * \param old_snapshot Old snapshot
559  * \param new_snapshot New snapshot
560  *
561  * \return True (non-zero) if context, exten or priority are identical.
562  * \return False (zero) if context, exten and priority changed.
563  */
564 int ast_channel_snapshot_cep_equal(
565         const struct ast_channel_snapshot *old_snapshot,
566         const struct ast_channel_snapshot *new_snapshot);
567
568 /*!
569  * \brief Compares the callerid info of two snapshots.
570  * \since 12
571  *
572  * \param old_snapshot Old snapshot
573  * \param new_snapshot New snapshot
574  *
575  * \return True (non-zero) if callerid are identical.
576  * \return False (zero) if callerid changed.
577  */
578 int ast_channel_snapshot_caller_id_equal(
579         const struct ast_channel_snapshot *old_snapshot,
580         const struct ast_channel_snapshot *new_snapshot);
581
582 /*!
583  * \brief Initialize the stasis channel topic and message types
584  * \return 0 on success
585  * \return Non-zero on error
586  */
587 int ast_stasis_channels_init(void);
588
589 #endif /* STASIS_CHANNELS_H_ */