This patch adds a new message bus API to Asterisk.
[asterisk/asterisk.git] / include / asterisk / channel.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 /*! \file
20  * \brief General Asterisk PBX channel definitions.
21  * \par See also:
22  *  \arg \ref Def_Channel
23  *  \arg \ref channel_drivers
24  */
25
26 /*! \page Def_Channel Asterisk Channels
27         \par What is a Channel?
28         A phone call through Asterisk consists of an incoming
29         connection and an outbound connection. Each call comes
30         in through a channel driver that supports one technology,
31         like SIP, DAHDI, IAX2 etc.
32         \par
33         Each channel driver, technology, has it's own private
34         channel or dialog structure, that is technology-dependent.
35         Each private structure is "owned" by a generic Asterisk
36         channel structure, defined in channel.h and handled by
37         channel.c .
38         \par Call scenario
39         This happens when an incoming call arrives to Asterisk
40         -# Call arrives on a channel driver interface
41         -# Channel driver creates a PBX channel and starts a
42            pbx thread on the channel
43         -# The dial plan is executed
44         -# At this point at least two things can happen:
45                 -# The call is answered by Asterisk and
46                    Asterisk plays a media stream or reads media
47                 -# The dial plan forces Asterisk to create an outbound
48                    call somewhere with the dial (see \ref app_dial.c)
49                    application
50         .
51
52         \par Bridging channels
53         If Asterisk dials out this happens:
54         -# Dial creates an outbound PBX channel and asks one of the
55            channel drivers to create a call
56         -# When the call is answered, Asterisk bridges the media streams
57            so the caller on the first channel can speak with the callee
58            on the second, outbound channel
59         -# In some cases where we have the same technology on both
60            channels and compatible codecs, a native bridge is used.
61            In a native bridge, the channel driver handles forwarding
62            of incoming audio to the outbound stream internally, without
63            sending audio frames through the PBX.
64         -# In SIP, theres an "external native bridge" where Asterisk
65            redirects the endpoint, so audio flows directly between the
66            caller's phone and the callee's phone. Signalling stays in
67            Asterisk in order to be able to provide a proper CDR record
68            for the call.
69
70
71         \par Masquerading channels
72         In some cases, a channel can masquerade itself into another
73         channel. This happens frequently in call transfers, where
74         a new channel takes over a channel that is already involved
75         in a call. The new channel sneaks in and takes over the bridge
76         and the old channel, now a zombie, is hung up.
77
78         \par Reference
79         \arg channel.c - generic functions
80         \arg channel.h - declarations of functions, flags and structures
81         \arg translate.h - Transcoding support functions
82         \arg \ref channel_drivers - Implemented channel drivers
83         \arg \ref Def_Frame Asterisk Multimedia Frames
84         \arg \ref Def_Bridge
85
86 */
87 /*! \page Def_Bridge Asterisk Channel Bridges
88
89         In Asterisk, there's several media bridges.
90
91         The Core bridge handles two channels (a "phone call") and bridge
92         them together.
93
94         The conference bridge (meetme) handles several channels simultaneously
95         with the support of an external timer (DAHDI timer). This is used
96         not only by the Conference application (meetme) but also by the
97         page application and the SLA system introduced in 1.4.
98         The conference bridge does not handle video.
99
100         When two channels of the same type connect, the channel driver
101         or the media subsystem used by the channel driver (i.e. RTP)
102         can create a native bridge without sending media through the
103         core.
104
105         Native bridging can be disabled by a number of reasons,
106         like DTMF being needed by the core or codecs being incompatible
107         so a transcoding module is needed.
108
109 References:
110         \li \see ast_channel_early_bridge()
111         \li \see ast_channel_bridge()
112         \li \see app_meetme.c
113         \li \ref AstRTPbridge
114         \li \see ast_rtp_bridge()
115         \li \ref Def_Channel
116 */
117
118 /*! \page AstFileDesc File descriptors
119         Asterisk File descriptors are connected to each channel (see \ref Def_Channel)
120         in the \ref ast_channel structure.
121 */
122
123 #ifndef _ASTERISK_CHANNEL_H
124 #define _ASTERISK_CHANNEL_H
125
126 #include "asterisk/abstract_jb.h"
127 #include "asterisk/astobj2.h"
128 #include "asterisk/poll-compat.h"
129
130 #if defined(__cplusplus) || defined(c_plusplus)
131 extern "C" {
132 #endif
133
134 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
135 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
136 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
137 #define MAX_LANGUAGE            40      /*!< Max length of the language setting */
138 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
139
140 #include "asterisk/frame.h"
141 #include "asterisk/chanvars.h"
142 #include "asterisk/config.h"
143 #include "asterisk/lock.h"
144 #include "asterisk/cdr.h"
145 #include "asterisk/utils.h"
146 #include "asterisk/linkedlists.h"
147 #include "asterisk/stringfields.h"
148 #include "asterisk/datastore.h"
149 #include "asterisk/data.h"
150 #include "asterisk/channelstate.h"
151 #include "asterisk/ccss.h"
152 #include "asterisk/framehook.h"
153 #include "asterisk/stasis.h"
154
155 #define DATASTORE_INHERIT_FOREVER       INT_MAX
156
157 #define AST_MAX_FDS             11
158 /*
159  * We have AST_MAX_FDS file descriptors in a channel.
160  * Some of them have a fixed use:
161  */
162 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
163 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
164 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
165 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
166 #define AST_JITTERBUFFER_FD     (AST_MAX_FDS-5) /*!< used by generator */
167
168 enum ast_bridge_result {
169         AST_BRIDGE_COMPLETE = 0,
170         AST_BRIDGE_FAILED = -1,
171         AST_BRIDGE_FAILED_NOWARN = -2,
172         AST_BRIDGE_RETRY = -3,
173 };
174
175 typedef unsigned long long ast_group_t;
176
177 /*! \todo Add an explanation of an Asterisk generator
178 */
179 struct ast_generator {
180         void *(*alloc)(struct ast_channel *chan, void *params);
181         /*! Channel is locked during this function callback. */
182         void (*release)(struct ast_channel *chan, void *data);
183         /*! This function gets called with the channel unlocked, but is called in
184          *  the context of the channel thread so we know the channel is not going
185          *  to disappear.  This callback is responsible for locking the channel as
186          *  necessary. */
187         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
188         /*! This gets called when DTMF_END frames are read from the channel */
189         void (*digit)(struct ast_channel *chan, char digit);
190         /*! This gets called when the write format on a channel is changed while
191          * generating. The channel is locked during this callback. */
192         void (*write_format_change)(struct ast_channel *chan, void *data);
193 };
194
195 /*! Party name character set enumeration values (values from Q.SIG) */
196 enum AST_PARTY_CHAR_SET {
197         AST_PARTY_CHAR_SET_UNKNOWN = 0,
198         AST_PARTY_CHAR_SET_ISO8859_1 = 1,
199         AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
200         AST_PARTY_CHAR_SET_ISO8859_2 = 3,
201         AST_PARTY_CHAR_SET_ISO8859_3 = 4,
202         AST_PARTY_CHAR_SET_ISO8859_4 = 5,
203         AST_PARTY_CHAR_SET_ISO8859_5 = 6,
204         AST_PARTY_CHAR_SET_ISO8859_7 = 7,
205         AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
206         AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
207 };
208
209 /*!
210  * \since 1.8
211  * \brief Information needed to specify a name in a call.
212  * \note All string fields here are malloc'ed, so they need to be
213  * freed when the structure is deleted.
214  * \note NULL and "" must be considered equivalent.
215  */
216 struct ast_party_name {
217         /*! \brief Subscriber name (Malloced) */
218         char *str;
219         /*!
220          * \brief Character set the name is using.
221          * \see enum AST_PARTY_CHAR_SET
222          * \note
223          * Set to AST_PARTY_CHAR_SET_ISO8859_1 if unsure what to use.
224          * \todo Start using the party name character set value.  Not currently used.
225          */
226         int char_set;
227         /*!
228          * \brief Q.931 encoded presentation-indicator encoded field
229          * \note Must tolerate the Q.931 screening-indicator field values being present.
230          */
231         int presentation;
232         /*! \brief TRUE if the name information is valid/present */
233         unsigned char valid;
234 };
235
236 /*!
237  * \since 1.8
238  * \brief Information needed to specify a number in a call.
239  * \note All string fields here are malloc'ed, so they need to be
240  * freed when the structure is deleted.
241  * \note NULL and "" must be considered equivalent.
242  */
243 struct ast_party_number {
244         /*! \brief Subscriber phone number (Malloced) */
245         char *str;
246         /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
247         int plan;
248         /*! \brief Q.931 presentation-indicator and screening-indicator encoded fields */
249         int presentation;
250         /*! \brief TRUE if the number information is valid/present */
251         unsigned char valid;
252 };
253
254 /*!
255  * \since 1.8
256  * \brief Information needed to specify a subaddress in a call.
257  * \note All string fields here are malloc'ed, so they need to be
258  * freed when the structure is deleted.
259  * \note NULL and "" must be considered equivalent.
260  */
261 struct ast_party_subaddress {
262         /*!
263          * \brief Malloced subaddress string.
264          * \note If the subaddress type is user specified then the subaddress is
265          * a string of ASCII hex because the actual subaddress is likely BCD encoded.
266          */
267         char *str;
268         /*!
269          * \brief Q.931 subaddress type.
270          * \details
271          * nsap(0),
272          * user_specified(2)
273          */
274         int type;
275         /*!
276          * \brief TRUE if odd number of address signals
277          * \note The odd/even indicator is used when the type of subaddress is
278          * user_specified and the coding is BCD.
279          */
280         unsigned char odd_even_indicator;
281         /*! \brief TRUE if the subaddress information is valid/present */
282         unsigned char valid;
283 };
284
285 /*!
286  * \since 1.8
287  * \brief Information needed to identify an endpoint in a call.
288  * \note All string fields here are malloc'ed, so they need to be
289  * freed when the structure is deleted.
290  * \note NULL and "" must be considered equivalent.
291  */
292 struct ast_party_id {
293         /*! \brief Subscriber name */
294         struct ast_party_name name;
295         /*! \brief Subscriber phone number */
296         struct ast_party_number number;
297         /*! \brief Subscriber subaddress. */
298         struct ast_party_subaddress subaddress;
299
300         /*!
301          * \brief User-set "tag"
302          * \details
303          * A user-settable field used to help associate some extrinsic information
304          * about the channel or user of the channel to the party ID.  This information
305          * is normally not transmitted over the wire and so is only useful within an
306          * Asterisk environment.
307          */
308         char *tag;
309 };
310
311 /*!
312  * \since 1.8
313  * \brief Indicate what information in ast_party_id should be set.
314  */
315 struct ast_set_party_id {
316         /*! TRUE if the ast_party_name information should be set. */
317         unsigned char name;
318         /*! TRUE if the ast_party_number information should be set. */
319         unsigned char number;
320         /*! TRUE if the ast_party_subaddress information should be set. */
321         unsigned char subaddress;
322 };
323
324 /*!
325  * \since 1.8
326  * \brief Dialed/Called Party information.
327  * \note Dialed Number Identifier (DNID)
328  * \note All string fields here are malloc'ed, so they need to be
329  * freed when the structure is deleted.
330  * \note NULL and "" must be considered equivalent.
331  */
332 struct ast_party_dialed {
333         /*!
334          * \brief Dialed/Called number
335          * \note Done this way in case we ever really need to use ast_party_number.
336          * We currently do not need all of the ast_party_number fields.
337          */
338         struct {
339                 /*! \brief Subscriber phone number (Malloced) */
340                 char *str;
341                 /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
342                 int plan;
343         } number;
344         /*! \brief Dialed/Called subaddress */
345         struct ast_party_subaddress subaddress;
346         /*!
347          * \brief Transit Network Select
348          * \note Currently this value is just passed around the system.
349          * You can read it and set it but it is never used for anything.
350          */
351         int transit_network_select;
352 };
353
354 /*!
355  * \since 1.8
356  * \brief Caller Party information.
357  * \note All string fields here are malloc'ed, so they need to be
358  * freed when the structure is deleted.
359  * \note NULL and "" must be considered equivalent.
360  *
361  * \note SIP and IAX2 has UTF8 encoded Unicode Caller ID names.
362  * In some cases, we also have an alternative (RPID) E.164 number that can
363  * be used as Caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to
364  * PSTN gateway).
365  *
366  * \todo Implement settings for transliteration between UTF8 Caller ID names in
367  *       to ASCII Caller ID's (DAHDI). Östen Åsklund might be transliterated into
368  *       Osten Asklund or Oesten Aasklund depending upon language and person...
369  *       We need automatic routines for incoming calls and static settings for
370  *       our own accounts.
371  */
372 struct ast_party_caller {
373         /*! \brief Caller party ID */
374         struct ast_party_id id;
375
376         /*!
377          * \brief Automatic Number Identification (ANI)
378          * \note The name subcomponent is only likely to be used by SIP.
379          * \note The subaddress subcomponent is not likely to be used.
380          */
381         struct ast_party_id ani;
382
383         /*! \brief Private caller party ID */
384         struct ast_party_id priv;
385
386         /*! \brief Automatic Number Identification 2 (Info Digits) */
387         int ani2;
388 };
389
390 /*!
391  * \since 1.8
392  * \brief Indicate what information in ast_party_caller should be set.
393  */
394 struct ast_set_party_caller {
395         /*! What caller id information to set. */
396         struct ast_set_party_id id;
397         /*! What ANI id information to set. */
398         struct ast_set_party_id ani;
399         /*! What private caller id information to set. */
400         struct ast_set_party_id priv;
401 };
402
403 /*!
404  * \since 1.8
405  * \brief Connected Line/Party information.
406  * \note All string fields here are malloc'ed, so they need to be
407  * freed when the structure is deleted.
408  * \note NULL and "" must be considered equivalent.
409  */
410 struct ast_party_connected_line {
411         /*! \brief Connected party ID */
412         struct ast_party_id id;
413
414         /*!
415          * \brief Automatic Number Identification (ANI)
416          * \note Not really part of connected line data but needed to
417          * save the corresponding caller id value.
418          */
419         struct ast_party_id ani;
420
421         /*! \brief Private connected party ID */
422         struct ast_party_id priv;
423
424         /*!
425          * \brief Automatic Number Identification 2 (Info Digits)
426          * \note Not really part of connected line data but needed to
427          * save the corresponding caller id value.
428          */
429         int ani2;
430
431         /*!
432          * \brief Information about the source of an update.
433          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
434          * for Normal-Answer and Call-transfer.
435          */
436         int source;
437 };
438
439 /*!
440  * \since 1.8
441  * \brief Indicate what information in ast_party_connected_line should be set.
442  */
443 struct ast_set_party_connected_line {
444         /*! What connected line id information to set. */
445         struct ast_set_party_id id;
446         /*! What ANI id information to set. */
447         struct ast_set_party_id ani;
448         /*! What private connected line id information to set. */
449         struct ast_set_party_id priv;
450 };
451
452 /*!
453  * \brief Redirecting reason information
454  */
455 struct ast_party_redirecting_reason {
456         /*! \brief a string value for the redirecting reason
457          *
458          * Useful for cases where an endpoint has specified a redirecting reason
459          * that does not correspond to an enum AST_REDIRECTING_REASON
460          */
461         char *str;
462
463         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
464         int code;
465 };
466
467 /*!
468  * \since 1.8
469  * \brief Redirecting Line information.
470  * RDNIS (Redirecting Directory Number Information Service)
471  * Where a call diversion or transfer was invoked.
472  * \note All string fields here are malloc'ed, so they need to be
473  * freed when the structure is deleted.
474  * \note NULL and "" must be considered equivalent.
475  */
476 struct ast_party_redirecting {
477         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) */
478         struct ast_party_id orig;
479
480         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
481         struct ast_party_id from;
482
483         /*! \brief Call is redirecting to a new party (Sent to the caller) */
484         struct ast_party_id to;
485
486         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) - private representation */
487         struct ast_party_id priv_orig;
488
489         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) - private representation */
490         struct ast_party_id priv_from;
491
492         /*! \brief Call is redirecting to a new party (Sent to the caller)  - private representation */
493         struct ast_party_id priv_to;
494
495         /*! \brief Reason for the redirection */
496         struct ast_party_redirecting_reason reason;
497
498         /*! \brief Reason for the redirection by the original party */
499         struct ast_party_redirecting_reason orig_reason;
500
501         /*! \brief Number of times the call was redirected */
502         int count;
503 };
504
505 /*!
506  * \since 1.8
507  * \brief Indicate what information in ast_party_redirecting should be set.
508  */
509 struct ast_set_party_redirecting {
510         /*! What redirecting-orig id information to set. */
511         struct ast_set_party_id orig;
512         /*! What redirecting-from id information to set. */
513         struct ast_set_party_id from;
514         /*! What redirecting-to id information to set. */
515         struct ast_set_party_id to;
516         /*! What private redirecting-orig id information to set. */
517         struct ast_set_party_id priv_orig;
518         /*! What private redirecting-from id information to set. */
519         struct ast_set_party_id priv_from;
520         /*! What private redirecting-to id information to set. */
521         struct ast_set_party_id priv_to;
522 };
523
524 /*!
525  * \brief Typedef for a custom read function
526  * \note data should be treated as const char *.
527  */
528 typedef int (*ast_acf_read_fn_t)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
529
530 /*!
531  * \brief Typedef for a custom read2 function
532  * \note data should be treated as const char *.
533  */
534 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len);
535
536 /*!
537  * \brief Typedef for a custom write function
538  * \note data should be treated as const char *.
539  */
540 typedef int (*ast_acf_write_fn_t)(struct ast_channel *chan, const char *function, char *data, const char *value);
541
542 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
543 typedef struct {
544         /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
545         #define AST_CHAN_WRITE_INFO_T_VERSION 1
546         uint32_t version;
547         ast_acf_write_fn_t write_fn;
548         struct ast_channel *chan;
549         const char *function;
550         char *data;
551         const char *value;
552 } ast_chan_write_info_t;
553
554 /*!
555  * \brief
556  * Structure to describe a channel "technology", ie a channel driver
557  * See for examples:
558  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
559  * \arg chan_sip.c - The SIP channel driver
560  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
561  *
562  * \details
563  * If you develop your own channel driver, this is where you
564  * tell the PBX at registration of your driver what properties
565  * this driver supports and where different callbacks are
566  * implemented.
567  */
568 struct ast_channel_tech {
569         const char * const type;
570         const char * const description;
571
572         struct ast_format_cap *capabilities;  /*!< format capabilities this channel can handle */
573
574         int properties;         /*!< Technology Properties */
575
576         /*!
577          * \brief Requester - to set up call data structures (pvt's)
578          *
579          * \param type type of channel to request
580          * \param cap Format capabilities for requested channel
581          * \param requestor channel asking for data
582          * \param addr destination of the call
583          * \param cause Cause of failure
584          *
585          * \details
586          * Request a channel of a given type, with addr as optional information used
587          * by the low level module
588          *
589          * \retval NULL failure
590          * \retval non-NULL channel on success
591          */
592         struct ast_channel *(* const requester)(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr, int *cause);
593
594         int (* const devicestate)(const char *device_number);   /*!< Devicestate call back */
595
596         /*!
597          * \brief Start sending a literal DTMF digit
598          *
599          * \note The channel is not locked when this function gets called.
600          */
601         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
602
603         /*!
604          * \brief Stop sending a literal DTMF digit
605          *
606          * \note The channel is not locked when this function gets called.
607          */
608         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
609
610         /*!
611          * \brief Make a call
612          * \note The channel is locked when called.
613          * \param chan which channel to make the call on
614          * \param addr destination of the call
615          * \param timeout time to wait on for connect (Doesn't seem to be used.)
616          * \retval 0 on success
617          * \retval -1 on failure
618          */
619         int (* const call)(struct ast_channel *chan, const char *addr, int timeout);
620
621         /*! \brief Hangup (and possibly destroy) the channel */
622         int (* const hangup)(struct ast_channel *chan);
623
624         /*! \brief Answer the channel */
625         int (* const answer)(struct ast_channel *chan);
626
627         /*! \brief Read a frame, in standard format (see frame.h) */
628         struct ast_frame * (* const read)(struct ast_channel *chan);
629
630         /*! \brief Write a frame, in standard format (see frame.h) */
631         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
632
633         /*! \brief Display or transmit text */
634         int (* const send_text)(struct ast_channel *chan, const char *text);
635
636         /*! \brief Display or send an image */
637         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
638
639         /*! \brief Send HTML data */
640         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
641
642         /*! \brief Handle an exception, reading a frame */
643         struct ast_frame * (* const exception)(struct ast_channel *chan);
644
645         /*! \brief Bridge two channels of the same type together */
646         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
647                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
648
649         /*! \brief Bridge two channels of the same type together (early) */
650         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
651
652         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
653         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
654
655         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
656         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
657
658         /*! \brief Set a given option. Called with chan locked */
659         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
660
661         /*! \brief Query a given option. Called with chan locked */
662         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
663
664         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
665         int (* const transfer)(struct ast_channel *chan, const char *newdest);
666
667         /*! \brief Write a frame, in standard format */
668         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
669
670         /*! \brief Write a text frame, in standard format */
671         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
672
673         /*! \brief Find bridged channel */
674         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
675
676         /*!
677          * \brief Provide additional read items for CHANNEL() dialplan function
678          * \note data should be treated as a const char *.
679          */
680         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
681
682         /*!
683          * \brief Provide additional write items for CHANNEL() dialplan function
684          * \note data should be treated as a const char *.
685          */
686         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
687
688         /*! \brief Retrieve base channel (agent and local) */
689         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
690
691         /*! \brief Set base channel (agent and local) */
692         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
693
694         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
695         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
696
697         /*! \brief Call a function with cc parameters as a function parameter
698          *
699          * \details
700          * This is a highly specialized callback that is not likely to be needed in many
701          * channel drivers. When dealing with a busy channel, for instance, most channel
702          * drivers will successfully return a channel to the requester. Once called, the channel
703          * can then queue a busy frame when it receives an appropriate message from the far end.
704          * In such a case, the channel driver has the opportunity to also queue a CC frame.
705          * The parameters for the CC channel can be retrieved from the channel structure.
706          *
707          * For other channel drivers, notably those that deal with "dumb" phones, the channel
708          * driver will not return a channel when one is requested. In such a scenario, there is never
709          * an opportunity for the channel driver to queue a CC frame since the channel is never
710          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
711          * for the desired channel because no channel is ever allocated or returned to the
712          * requester. In such a case, call completion may still be a viable option. What we do is
713          * pass the same string that the requester used originally to request the channel to the
714          * channel driver. The channel driver can then find any potential channels/devices that
715          * match the input and return call the designated callback with the device's call completion
716          * parameters as a parameter.
717          */
718         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
719
720         /*!
721          * \brief Execute a Gosub call on the channel in a technology specific way before a call is placed.
722          * \since 11.0
723          *
724          * \param chan Channel to execute Gosub in a tech specific way.
725          * \param sub_args Gosub application parameter string.
726          *
727          * \note The chan is locked before calling.
728          *
729          * \retval 0 on success.
730          * \retval -1 on error.
731          */
732         int (*pre_call)(struct ast_channel *chan, const char *sub_args);
733 };
734
735 /*! Kill the channel channel driver technology descriptor. */
736 extern const struct ast_channel_tech ast_kill_tech;
737
738 struct ast_epoll_data;
739
740 /*!
741  * The high bit of the frame count is used as a debug marker, so
742  * increments of the counters must be done with care.
743  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
744  */
745 #define DEBUGCHAN_FLAG  0x80000000
746
747 /* XXX not ideal to evaluate x twice... */
748 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
749
750 /*!
751  * The current value of the debug flags is stored in the two
752  * variables global_fin and global_fout (declared in main/channel.c)
753  */
754 extern unsigned long global_fin, global_fout;
755
756 enum ast_channel_adsicpe {
757         AST_ADSI_UNKNOWN,
758         AST_ADSI_AVAILABLE,
759         AST_ADSI_UNAVAILABLE,
760         AST_ADSI_OFFHOOKONLY,
761 };
762
763 /*!
764  * \brief Possible T38 states on channels
765  */
766 enum ast_t38_state {
767         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
768         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
769         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
770         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
771         T38_STATE_NEGOTIATED,   /*!< T38 established */
772 };
773
774 /*! Hangup handler instance node. */
775 struct ast_hangup_handler {
776         /*! Next hangup handler node. */
777         AST_LIST_ENTRY(ast_hangup_handler) node;
778         /*! Hangup handler arg string passed to the Gosub application */
779         char args[0];
780 };
781
782 AST_LIST_HEAD_NOLOCK(ast_hangup_handler_list, ast_hangup_handler);
783 AST_LIST_HEAD_NOLOCK(ast_datastore_list, ast_datastore);
784 AST_LIST_HEAD_NOLOCK(ast_autochan_list, ast_autochan);
785 AST_LIST_HEAD_NOLOCK(ast_readq_list, ast_frame);
786
787 typedef int(*ast_timing_func_t)(const void *data);
788 /*!
789  * \page AstChannel ast_channel locking and reference tracking
790  *
791  * \par Creating Channels
792  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
793  * automatically inserted into the main channels hash table that keeps track of all
794  * active channels in the system.  The hash key is based on the channel name.  Because
795  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
796  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
797  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
798  *
799  * \par Channel Locking
800  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
801  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
802  *
803  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
804  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
805  * did not disappear out from under you if you were working with a channel outside of the channel
806  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
807  * You simply must hold a reference to the channel to ensure it does not go away.
808  *
809  * The channel must be locked if you need to ensure that data that you reading from the channel
810  * does not change while you access it.  Further, you must hold the channel lock if you are
811  * making a non-atomic change to channel data.
812  *
813  * \par Channel References
814  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
815  * to a channel after creating it.  The other ways involve using the channel search or the channel
816  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
817  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
818  * not go away.  So, the channel should only get locked as needed for data access or modification.
819  * But, make sure that the reference gets released when you are done with it!
820  *
821  * There are different things you can do when you are done with a reference to a channel.  The first
822  * is to simply release the reference using ast_channel_unref().  The other option is to call
823  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
824  * the past.  The release function releases a reference as well as ensures that the channel is no
825  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
826  * other pending references get released.
827  *
828  * \par Exceptions to the rules
829  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
830  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
831  * The only places where this happens should be places where because of how the code works, we
832  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
833  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
834  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
835  * that this pointer to the channel will be removed in time, because the channel's hangup callback
836  * gets called before the channel goes away.
837  */
838
839 struct ast_channel;
840
841 /*! \brief ast_channel_tech Properties */
842 enum {
843         /*!
844      * \brief Channels have this property if they can accept input with jitter;
845          * i.e. most VoIP channels
846          */
847         AST_CHAN_TP_WANTSJITTER = (1 << 0),
848         /*!
849      * \brief Channels have this property if they can create jitter;
850          * i.e. most VoIP channels
851          */
852         AST_CHAN_TP_CREATESJITTER = (1 << 1),
853 };
854
855 /*! \brief ast_channel flags */
856 enum {
857         /*! Queue incoming DTMF, to be released when this flag is turned off */
858         AST_FLAG_DEFER_DTMF =    (1 << 1),
859         /*! write should be interrupt generator */
860         AST_FLAG_WRITE_INT =     (1 << 2),
861         /*! a thread is blocking on this channel */
862         AST_FLAG_BLOCKING =      (1 << 3),
863         /*! This is a zombie channel */
864         AST_FLAG_ZOMBIE =        (1 << 4),
865         /*! There is an exception pending */
866         AST_FLAG_EXCEPTION =     (1 << 5),
867         /*! Listening to moh XXX anthm promises me this will disappear XXX */
868         AST_FLAG_MOH =           (1 << 6),
869         /*! This channel is spying on another channel */
870         AST_FLAG_SPYING =        (1 << 7),
871         /*! This channel is in a native bridge */
872         AST_FLAG_NBRIDGE =       (1 << 8),
873         /*! the channel is in an auto-incrementing dialplan processor,
874          *  so when ->priority is set, it will get incremented before
875          *  finding the next priority to run */
876         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
877         /*! This is an outgoing call */
878         AST_FLAG_OUTGOING =      (1 << 10),
879         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
880         AST_FLAG_IN_DTMF =       (1 << 12),
881         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
882          *  currently being emulated */
883         AST_FLAG_EMULATE_DTMF =  (1 << 13),
884         /*! This is set to tell the channel not to generate DTMF begin frames, and
885          *  to instead only generate END frames. */
886         AST_FLAG_END_DTMF_ONLY = (1 << 14),
887         /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
888         Flag to show channels that this call is hangup due to the fact that the call
889             was indeed answered, but in another channel */
890         /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
891         /*! This flag indicates that on a masquerade, an active stream should not
892          *  be carried over */
893         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
894         /*! This flag indicates that the hangup exten was run when the bridge terminated,
895          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
896          *  level */
897         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
898         /*! This flag indicates that the hangup exten should NOT be run when the
899          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
900          *  */
901         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
902         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
903          *  some non-traditional dialplans (like AGI) to continue to function.
904          */
905         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
906         /*!
907          * Disable device state event caching.  This allows channel
908          * drivers to selectively prevent device state events from being
909          * cached by certain channels such as anonymous calls which have
910          * no persistent represenatation that can be tracked.
911          */
912         AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
913         /*!
914          * This flag indicates that a dual channel redirect is in
915          * progress.  The bridge needs to wait until the flag is cleared
916          * to continue.
917          */
918         AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
919 };
920
921 /*! \brief ast_bridge_config flags */
922 enum {
923         AST_FEATURE_PLAY_WARNING = (1 << 0),
924         AST_FEATURE_REDIRECT =     (1 << 1),
925         AST_FEATURE_DISCONNECT =   (1 << 2),
926         AST_FEATURE_ATXFER =       (1 << 3),
927         AST_FEATURE_AUTOMON =      (1 << 4),
928         AST_FEATURE_PARKCALL =     (1 << 5),
929         AST_FEATURE_AUTOMIXMON =   (1 << 6),
930         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
931         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
932 };
933
934 /*! \brief bridge configuration */
935 struct ast_bridge_config {
936         struct ast_flags features_caller;
937         struct ast_flags features_callee;
938         struct timeval start_time;
939         struct timeval nexteventts;
940         struct timeval feature_start_time;
941         long feature_timer;
942         long timelimit;
943         long play_warning;
944         long warning_freq;
945         const char *warning_sound;
946         const char *end_sound;
947         const char *start_sound;
948         unsigned int flags;
949         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
950         void *end_bridge_callback_data;         /*!< Data passed to the callback */
951         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
952          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
953          */
954         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
955 };
956
957 struct chanmon;
958
959 struct outgoing_helper {
960         const char *context;
961         const char *exten;
962         int priority;
963         int connect_on_early_media;     /* If set, treat session progress as answer */
964         const char *cid_num;
965         const char *cid_name;
966         const char *account;
967         struct ast_variable *vars;
968         struct ast_channel *parent_channel;
969 };
970
971 enum {
972         /*!
973          * Soft hangup requested by device or other internal reason.
974          * Actual hangup needed.
975          */
976         AST_SOFTHANGUP_DEV =       (1 << 0),
977         /*!
978          * Used to break the normal frame flow so an async goto can be
979          * done instead of actually hanging up.
980          */
981         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
982         /*!
983          * Soft hangup requested by system shutdown.  Actual hangup
984          * needed.
985          */
986         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
987         /*!
988          * Used to break the normal frame flow after a timeout so an
989          * implicit async goto can be done to the 'T' exten if it exists
990          * instead of actually hanging up.  If the exten does not exist
991          * then actually hangup.
992          */
993         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
994         /*!
995          * Soft hangup requested by application/channel-driver being
996          * unloaded.  Actual hangup needed.
997          */
998         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
999         /*!
1000          * Soft hangup requested by non-associated party.  Actual hangup
1001          * needed.
1002          */
1003         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
1004         /*!
1005          * Used to break a bridge so the channel can be spied upon
1006          * instead of actually hanging up.
1007          */
1008         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
1009
1010
1011         /*!
1012          * \brief All softhangup flags.
1013          *
1014          * This can be used as an argument to ast_channel_clear_softhangup()
1015          * to clear all softhangup flags from a channel.
1016          */
1017         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
1018 };
1019
1020
1021 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
1022 enum channelreloadreason {
1023         CHANNEL_MODULE_LOAD,
1024         CHANNEL_MODULE_RELOAD,
1025         CHANNEL_CLI_RELOAD,
1026         CHANNEL_MANAGER_RELOAD,
1027         CHANNEL_ACL_RELOAD,
1028 };
1029
1030 /*!
1031  * \note None of the datastore API calls lock the ast_channel they are using.
1032  *       So, the channel should be locked before calling the functions that
1033  *       take a channel argument.
1034  */
1035
1036 /*!
1037  * \brief Create a channel data store object
1038  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1039  * \version 1.6.1 deprecated
1040  */
1041 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1042         __attribute__((deprecated));
1043
1044 /*!
1045  * \brief Free a channel data store object
1046  * \deprecated You should use the ast_datastore_free() generic function instead.
1047  * \version 1.6.1 deprecated
1048  */
1049 int ast_channel_datastore_free(struct ast_datastore *datastore)
1050         __attribute__((deprecated));
1051
1052 /*! \brief Inherit datastores from a parent to a child. */
1053 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1054
1055 /*!
1056  * \brief Add a datastore to a channel
1057  *
1058  * \note The channel should be locked before calling this function.
1059  *
1060  * \retval 0 success
1061  * \retval non-zero failure
1062  */
1063 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1064
1065 /*!
1066  * \brief Remove a datastore from a channel
1067  *
1068  * \note The channel should be locked before calling this function.
1069  *
1070  * \retval 0 success
1071  * \retval non-zero failure
1072  */
1073 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1074
1075 /*!
1076  * \brief Find a datastore on a channel
1077  *
1078  * \note The channel should be locked before calling this function.
1079  *
1080  * \note The datastore returned from this function must not be used if the
1081  *       reference to the channel is released.
1082  *
1083  * \retval pointer to the datastore if found
1084  * \retval NULL if not found
1085  */
1086 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1087
1088 /*!
1089  * \brief Create a channel structure
1090  * \since 1.8
1091  *
1092  * \retval NULL failure
1093  * \retval non-NULL successfully allocated channel
1094  *
1095  * \note Absolutely _NO_ channel locks should be held before calling this function.
1096  * \note By default, new channels are set to the "s" extension
1097  *       and "default" context.
1098  */
1099 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
1100         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1101                             const char *cid_name, const char *acctcode,
1102                             const char *exten, const char *context,
1103                             const char *linkedid, const int amaflag,
1104                             const char *file, int line, const char *function,
1105                             const char *name_fmt, ...);
1106
1107 /*!
1108  * \brief Create a channel structure
1109  *
1110  * \retval NULL failure
1111  * \retval non-NULL successfully allocated channel
1112  *
1113  * \note Absolutely _NO_ channel locks should be held before calling this function.
1114  * \note By default, new channels are set to the "s" extension
1115  *       and "default" context.
1116  */
1117 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
1118         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
1119                             __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1120
1121 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1122 /*!
1123  * \brief Create a fake channel structure
1124  *
1125  * \retval NULL failure
1126  * \retval non-NULL successfully allocated channel
1127  *
1128  * \note This function should ONLY be used to create a fake channel
1129  *       that can then be populated with data for use in variable
1130  *       substitution when a real channel does not exist.
1131  *
1132  * \note The created dummy channel should be destroyed by
1133  * ast_channel_unref().  Using ast_channel_release() needlessly
1134  * grabs the channel container lock and can cause a deadlock as
1135  * a result.  Also grabbing the channel container lock reduces
1136  * system performance.
1137  */
1138 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1139 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1140 #else
1141 /*!
1142  * \brief Create a fake channel structure
1143  *
1144  * \retval NULL failure
1145  * \retval non-NULL successfully allocated channel
1146  *
1147  * \note This function should ONLY be used to create a fake channel
1148  *       that can then be populated with data for use in variable
1149  *       substitution when a real channel does not exist.
1150  *
1151  * \note The created dummy channel should be destroyed by
1152  * ast_channel_unref().  Using ast_channel_release() needlessly
1153  * grabs the channel container lock and can cause a deadlock as
1154  * a result.  Also grabbing the channel container lock reduces
1155  * system performance.
1156  */
1157 struct ast_channel *ast_dummy_channel_alloc(void);
1158 #endif
1159
1160 /*!
1161  * \brief Queue one or more frames to a channel's frame queue
1162  *
1163  * \param chan the channel to queue the frame(s) on
1164  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1165  *        by this function.  It is the responsibility of the caller to handle
1166  *        freeing the memory associated with the frame(s) being passed if
1167  *        necessary.
1168  *
1169  * \retval 0 success
1170  * \retval non-zero failure
1171  */
1172 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1173
1174 /*!
1175  * \brief Queue one or more frames to the head of a channel's frame queue
1176  *
1177  * \param chan the channel to queue the frame(s) on
1178  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1179  *        by this function.  It is the responsibility of the caller to handle
1180  *        freeing the memory associated with the frame(s) being passed if
1181  *        necessary.
1182  *
1183  * \retval 0 success
1184  * \retval non-zero failure
1185  */
1186 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1187
1188 /*!
1189  * \brief Queue a hangup frame
1190  *
1191  * \note The channel does not need to be locked before calling this function.
1192  */
1193 int ast_queue_hangup(struct ast_channel *chan);
1194
1195 /*!
1196  * \brief Queue a hangup frame with hangupcause set
1197  *
1198  * \note The channel does not need to be locked before calling this function.
1199  * \param[in] chan channel to queue frame onto
1200  * \param[in] cause the hangup cause
1201  * \return 0 on success, -1 on error
1202  * \since 1.6.1
1203  */
1204 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1205
1206 /*!
1207  * \brief Queue a control frame with payload
1208  *
1209  * \param chan channel to queue frame onto
1210  * \param control type of control frame
1211  *
1212  * \note The channel does not need to be locked before calling this function.
1213  *
1214  * \retval zero on success
1215  * \retval non-zero on failure
1216  */
1217 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1218
1219 /*!
1220  * \brief Queue a control frame with payload
1221  *
1222  * \param chan channel to queue frame onto
1223  * \param control type of control frame
1224  * \param data pointer to payload data to be included in frame
1225  * \param datalen number of bytes of payload data
1226  *
1227  * \retval 0 success
1228  * \retval non-zero failure
1229  *
1230  * \details
1231  * The supplied payload data is copied into the frame, so the caller's copy
1232  * is not modified nor freed, and the resulting frame will retain a copy of
1233  * the data even if the caller frees their local copy.
1234  *
1235  * \note This method should be treated as a 'network transport'; in other
1236  * words, your frames may be transferred across an IAX2 channel to another
1237  * system, which may be a different endianness than yours. Because of this,
1238  * you should ensure that either your frames will never be expected to work
1239  * across systems, or that you always put your payload data into 'network byte
1240  * order' before calling this function.
1241  *
1242  * \note The channel does not need to be locked before calling this function.
1243  */
1244 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1245                            const void *data, size_t datalen);
1246
1247 /*!
1248  * \brief Change channel name
1249  *
1250  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1251  *
1252  * \param chan the channel to change the name of
1253  * \param newname the name to change to
1254  *
1255  * \return nothing
1256  *
1257  * \note this function must _NEVER_ be used when any channels are locked
1258  * regardless if it is the channel who's name is being changed or not because
1259  * it invalidates our channel container locking order... lock container first,
1260  * then the individual channels, never the other way around.
1261  */
1262 void ast_change_name(struct ast_channel *chan, const char *newname);
1263
1264 /*!
1265  * \brief Unlink and release reference to a channel
1266  *
1267  * This function will unlink the channel from the global channels container
1268  * if it is still there and also release the current reference to the channel.
1269  *
1270  * \return NULL, convenient for clearing invalid pointers
1271  * \note Absolutely _NO_ channel locks should be held before calling this function.
1272  *
1273  * \since 1.8
1274  */
1275 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1276
1277 /*!
1278  * \brief Requests a channel
1279  *
1280  * \param type type of channel to request
1281  * \param request_cap Format capabilities for requested channel
1282  * \param requestor channel asking for data
1283  * \param addr destination of the call
1284  * \param cause Cause of failure
1285  *
1286  * \details
1287  * Request a channel of a given type, with addr as optional information used
1288  * by the low level module
1289  *
1290  * \retval NULL failure
1291  * \retval non-NULL channel on success
1292  */
1293 struct ast_channel *ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_channel *requestor, const char *addr, int *cause);
1294
1295 /*!
1296  * \brief Request a channel of a given type, with data as optional information used
1297  *        by the low level module and attempt to place a call on it
1298  *
1299  * \param type type of channel to request
1300  * \param cap format capabilities for requested channel
1301  * \param requestor channel asking for data
1302  * \param addr destination of the call
1303  * \param timeout maximum amount of time to wait for an answer
1304  * \param reason why unsuccessful (if unsuccessful)
1305  * \param cid_num Caller-ID Number
1306  * \param cid_name Caller-ID Name (ascii)
1307  *
1308  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1309  * to know if the call was answered or not.
1310  */
1311 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1312         int timeout, int *reason, const char *cid_num, const char *cid_name);
1313
1314 /*!
1315  * \brief Request a channel of a given type, with data as optional information used
1316  * by the low level module and attempt to place a call on it
1317  * \param type type of channel to request
1318  * \param cap format capabilities for requested channel
1319  * \param requestor channel requesting data
1320  * \param addr destination of the call
1321  * \param timeout maximum amount of time to wait for an answer
1322  * \param reason why unsuccessful (if unsuccessful)
1323  * \param cid_num Caller-ID Number
1324  * \param cid_name Caller-ID Name (ascii)
1325  * \param oh Outgoing helper
1326  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1327  * to know if the call was answered or not.
1328  */
1329 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1330         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1331
1332 /*!
1333  * \brief Forwards a call to a new channel specified by the original channel's call_forward str.  If possible, the new forwarded channel is created and returned while the original one is terminated.
1334  * \param caller in channel that requested orig
1335  * \param orig channel being replaced by the call forward channel
1336  * \param timeout maximum amount of time to wait for setup of new forward channel
1337  * \param cap format capabilities for requested channel
1338  * \param oh outgoing helper used with original channel
1339  * \param outstate reason why unsuccessful (if uncuccessful)
1340  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1341  */
1342 struct ast_channel *ast_call_forward(struct ast_channel *caller, struct ast_channel *orig, int *timeout, struct ast_format_cap *cap, struct outgoing_helper *oh, int *outstate);
1343
1344 /*!
1345  * \brief Register a channel technology (a new channel driver)
1346  * Called by a channel module to register the kind of channels it supports.
1347  * \param tech Structure defining channel technology or "type"
1348  * \return Returns 0 on success, -1 on failure.
1349  */
1350 int ast_channel_register(const struct ast_channel_tech *tech);
1351
1352 /*!
1353  * \brief Unregister a channel technology
1354  * \param tech Structure defining channel technology or "type" that was previously registered
1355  * \return No return value.
1356  */
1357 void ast_channel_unregister(const struct ast_channel_tech *tech);
1358
1359 /*!
1360  * \brief Get a channel technology structure by name
1361  * \param name name of technology to find
1362  * \return a pointer to the structure, or NULL if no matching technology found
1363  */
1364 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1365
1366 #ifdef CHANNEL_TRACE
1367 /*!
1368  * \brief Update the context backtrace if tracing is enabled
1369  * \return Returns 0 on success, -1 on failure
1370  */
1371 int ast_channel_trace_update(struct ast_channel *chan);
1372
1373 /*!
1374  * \brief Enable context tracing in the channel
1375  * \return Returns 0 on success, -1 on failure
1376  */
1377 int ast_channel_trace_enable(struct ast_channel *chan);
1378
1379 /*!
1380  * \brief Disable context tracing in the channel.
1381  * \note Does not remove current trace entries
1382  * \return Returns 0 on success, -1 on failure
1383  */
1384 int ast_channel_trace_disable(struct ast_channel *chan);
1385
1386 /*!
1387  * \brief Whether or not context tracing is enabled
1388  * \return Returns -1 when the trace is enabled. 0 if not.
1389  */
1390 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1391
1392 /*!
1393  * \brief Put the channel backtrace in a string
1394  * \return Returns the amount of lines in the backtrace. -1 on error.
1395  */
1396 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1397 #endif
1398
1399 /*!
1400  * \brief Hang up a channel
1401  * \note Absolutely _NO_ channel locks should be held before calling this function.
1402  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1403  * performs all stream stopping, etc, on the channel that needs to end.
1404  * chan is no longer valid after this call.
1405  * \param chan channel to hang up
1406  * \return Returns 0 on success, -1 on failure.
1407  */
1408 int ast_hangup(struct ast_channel *chan);
1409
1410 /*!
1411  * \brief Softly hangup up a channel
1412  *
1413  * \param chan channel to be soft-hung-up
1414  * \param reason an AST_SOFTHANGUP_* reason code
1415  *
1416  * \details
1417  * Call the protocol layer, but don't destroy the channel structure
1418  * (use this if you are trying to
1419  * safely hangup a channel managed by another thread.
1420  *
1421  * \note The channel passed to this function does not need to be locked.
1422  *
1423  * \return Returns 0 regardless
1424  */
1425 int ast_softhangup(struct ast_channel *chan, int reason);
1426
1427 /*!
1428  * \brief Softly hangup up a channel (no channel lock)
1429  * \param chan channel to be soft-hung-up
1430  * \param reason an AST_SOFTHANGUP_* reason code
1431  */
1432 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1433
1434 /*!
1435  * \brief Clear a set of softhangup flags from a channel
1436  *
1437  * Never clear a softhangup flag from a channel directly.  Instead,
1438  * use this function.  This ensures that all aspects of the softhangup
1439  * process are aborted.
1440  *
1441  * \param chan the channel to clear the flag on
1442  * \param flag the flag or flags to clear
1443  *
1444  * \return Nothing.
1445  */
1446 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1447
1448 /*!
1449  * \brief Set the source of the hangup in this channel and it's bridge
1450  *
1451  * \param chan channel to set the field on
1452  * \param source a string describing the source of the hangup for this channel
1453  * \param force
1454  *
1455  * \note Absolutely _NO_ channel locks should be held before calling this function.
1456  *
1457  * \since 1.8
1458  *
1459  * Hangupsource is generally the channel name that caused the bridge to be
1460  * hung up, but it can also be other things such as "dialplan/agi"
1461  * This can then be logged in the CDR or CEL
1462  */
1463 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1464
1465 /*! \brief Check to see if a channel is needing hang up
1466  * \param chan channel on which to check for hang up
1467  * This function determines if the channel is being requested to be hung up.
1468  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1469  */
1470 int ast_check_hangup(struct ast_channel *chan);
1471
1472 int ast_check_hangup_locked(struct ast_channel *chan);
1473
1474 /*!
1475  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1476  * \param chan channel on which to hang up
1477  * \param causecode cause code to use (Zero if don't use cause code)
1478  * \return Nothing
1479  */
1480 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1481
1482 /*!
1483  * \brief Compare a offset with the settings of when to hang a channel up
1484  * \param chan channel on which to check for hang up
1485  * \param offset offset in seconds from current time
1486  * \return 1, 0, or -1
1487  * \details
1488  * This function compares a offset from current time with the absolute time
1489  * out on a channel (when to hang up). If the absolute time out on a channel
1490  * is earlier than current time plus the offset, it returns 1, if the two
1491  * time values are equal, it return 0, otherwise, it return -1.
1492  * \sa ast_channel_cmpwhentohangup_tv()
1493  * \version 1.6.1 deprecated function (only had seconds precision)
1494  */
1495 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1496
1497 /*!
1498  * \brief Compare a offset with the settings of when to hang a channel up
1499  * \param chan channel on which to check for hangup
1500  * \param offset offset in seconds and microseconds from current time
1501  * \return 1, 0, or -1
1502  * This function compares a offset from current time with the absolute time
1503  * out on a channel (when to hang up). If the absolute time out on a channel
1504  * is earlier than current time plus the offset, it returns 1, if the two
1505  * time values are equal, it return 0, otherwise, it return -1.
1506  * \since 1.6.1
1507  */
1508 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1509
1510 /*!
1511  * \brief Set when to hang a channel up
1512  *
1513  * \param chan channel on which to check for hang up
1514  * \param offset offset in seconds relative to the current time of when to hang up
1515  *
1516  * \details
1517  * This function sets the absolute time out on a channel (when to hang up).
1518  *
1519  * \note This function does not require that the channel is locked before
1520  *       calling it.
1521  *
1522  * \return Nothing
1523  * \sa ast_channel_setwhentohangup_tv()
1524  * \version 1.6.1 deprecated function (only had seconds precision)
1525  */
1526 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1527
1528 /*!
1529  * \brief Set when to hang a channel up
1530  *
1531  * \param chan channel on which to check for hang up
1532  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1533  *
1534  * This function sets the absolute time out on a channel (when to hang up).
1535  *
1536  * \note This function does not require that the channel is locked before
1537  * calling it.
1538  *
1539  * \return Nothing
1540  * \since 1.6.1
1541  */
1542 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1543
1544 /*!
1545  * \brief Answer a channel
1546  *
1547  * \param chan channel to answer
1548  *
1549  * \details
1550  * This function answers a channel and handles all necessary call
1551  * setup functions.
1552  *
1553  * \note The channel passed does not need to be locked, but is locked
1554  * by the function when needed.
1555  *
1556  * \note This function will wait up to 500 milliseconds for media to
1557  * arrive on the channel before returning to the caller, so that the
1558  * caller can properly assume the channel is 'ready' for media flow.
1559  *
1560  * \retval 0 on success
1561  * \retval non-zero on failure
1562  */
1563 int ast_answer(struct ast_channel *chan);
1564
1565 /*!
1566  * \brief Answer a channel
1567  *
1568  * \param chan channel to answer
1569  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1570  *
1571  * This function answers a channel and handles all necessary call
1572  * setup functions.
1573  *
1574  * \note The channel passed does not need to be locked, but is locked
1575  * by the function when needed.
1576  *
1577  * \note Unlike ast_answer(), this function will not wait for media
1578  * flow to begin. The caller should be careful before sending media
1579  * to the channel before incoming media arrives, as the outgoing
1580  * media may be lost.
1581  *
1582  * \retval 0 on success
1583  * \retval non-zero on failure
1584  */
1585 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1586
1587 /*!
1588  * \brief Answer a channel, with a selectable delay before returning
1589  *
1590  * \param chan channel to answer
1591  * \param delay maximum amount of time to wait for incoming media
1592  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1593  *
1594  * This function answers a channel and handles all necessary call
1595  * setup functions.
1596  *
1597  * \note The channel passed does not need to be locked, but is locked
1598  * by the function when needed.
1599  *
1600  * \note This function will wait up to 'delay' milliseconds for media to
1601  * arrive on the channel before returning to the caller, so that the
1602  * caller can properly assume the channel is 'ready' for media flow. If
1603  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1604  *
1605  * \retval 0 on success
1606  * \retval non-zero on failure
1607  */
1608 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1609
1610 /*!
1611  * \brief Execute a Gosub call on the channel before a call is placed.
1612  * \since 11.0
1613  *
1614  * \details
1615  * This is called between ast_request() and ast_call() to
1616  * execute a predial routine on the newly created channel.
1617  *
1618  * \param chan Channel to execute Gosub.
1619  * \param sub_args Gosub application parameter string.
1620  *
1621  * \note Absolutely _NO_ channel locks should be held before calling this function.
1622  *
1623  * \retval 0 on success.
1624  * \retval -1 on error.
1625  */
1626 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1627
1628 /*!
1629  * \brief Make a call
1630  * \note Absolutely _NO_ channel locks should be held before calling this function.
1631  * \param chan which channel to make the call on
1632  * \param addr destination of the call
1633  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1634  * \details
1635  * Place a call, take no longer than timeout ms.
1636  * \retval 0 on success
1637  * \retval -1 on failure
1638  */
1639 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1640
1641 /*!
1642  * \brief Indicates condition of channel
1643  * \note Absolutely _NO_ channel locks should be held before calling this function.
1644  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1645  * \param chan channel to change the indication
1646  * \param condition which condition to indicate on the channel
1647  * \return Returns 0 on success, -1 on failure
1648  */
1649 int ast_indicate(struct ast_channel *chan, int condition);
1650
1651 /*!
1652  * \brief Indicates condition of channel, with payload
1653  * \note Absolutely _NO_ channel locks should be held before calling this function.
1654  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1655  * \param chan channel to change the indication
1656  * \param condition which condition to indicate on the channel
1657  * \param data pointer to payload data
1658  * \param datalen size of payload data
1659  * \return Returns 0 on success, -1 on failure
1660  */
1661 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1662
1663 /* Misc stuff ------------------------------------------------ */
1664
1665 /*!
1666  * \brief Wait for input on a channel
1667  * \param chan channel to wait on
1668  * \param ms length of time to wait on the channel
1669  * \details
1670  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1671  * \retval < 0 on failure
1672  * \retval 0 if nothing ever arrived
1673  * \retval the # of ms remaining otherwise
1674  */
1675 int ast_waitfor(struct ast_channel *chan, int ms);
1676
1677 /*!
1678  * \brief Should we keep this frame for later?
1679  *
1680  * There are functions such as ast_safe_sleep which will
1681  * service a channel to ensure that it does not have a
1682  * large backlog of queued frames. When this happens,
1683  * we want to hold on to specific frame types and just drop
1684  * others. This function will tell if the frame we just
1685  * read should be held onto.
1686  *
1687  * \param frame The frame we just read
1688  * \retval 1 frame should be kept
1689  * \retval 0 frame should be dropped
1690  */
1691 int ast_is_deferrable_frame(const struct ast_frame *frame);
1692
1693 /*!
1694  * \brief Wait for a specified amount of time, looking for hangups
1695  * \param chan channel to wait for
1696  * \param ms length of time in milliseconds to sleep. This should never be less than zero.
1697  * \details
1698  * Waits for a specified amount of time, servicing the channel as required.
1699  * \return returns -1 on hangup, otherwise 0.
1700  */
1701 int ast_safe_sleep(struct ast_channel *chan, int ms);
1702
1703 /*!
1704  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1705  * \param chan channel to wait for
1706  * \param ms length of time in milliseconds to sleep.
1707  * \param cond a function pointer for testing continue condition
1708  * \param data argument to be passed to the condition test function
1709  * \return returns -1 on hangup, otherwise 0.
1710  * \details
1711  * Waits for a specified amount of time, servicing the channel as required. If cond
1712  * returns 0, this function returns.
1713  */
1714 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1715
1716 /*!
1717  * \brief Waits for activity on a group of channels
1718  * \param chan an array of pointers to channels
1719  * \param n number of channels that are to be waited upon
1720  * \param fds an array of fds to wait upon
1721  * \param nfds the number of fds to wait upon
1722  * \param exception exception flag
1723  * \param outfd fd that had activity on it
1724  * \param ms how long the wait was
1725  * \details
1726  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1727  * file descriptors.
1728  * \return Returns the channel with activity, or NULL on error or if an FD
1729  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1730  * will be -1
1731  */
1732 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1733         int *fds, int nfds, int *exception, int *outfd, int *ms);
1734
1735 /*!
1736  * \brief Waits for input on a group of channels
1737  * Wait for input on an array of channels for a given # of milliseconds.
1738  * \return Return channel with activity, or NULL if none has activity.
1739  * \param chan an array of pointers to channels
1740  * \param n number of channels that are to be waited upon
1741  * \param ms time "ms" is modified in-place, if applicable
1742  */
1743 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1744
1745 /*!
1746  * \brief Waits for input on an fd
1747  * \note This version works on fd's only.  Be careful with it.
1748  */
1749 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1750
1751
1752 /*!
1753  * \brief Reads a frame
1754  * \param chan channel to read a frame from
1755  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1756  * best just stop reading frames and assume the channel has been
1757  * disconnected.
1758  */
1759 struct ast_frame *ast_read(struct ast_channel *chan);
1760
1761 /*!
1762  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1763  * \param chan channel to read a frame from
1764  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1765  * best just stop reading frames and assume the channel has been
1766  * disconnected.
1767  * \note Audio is replaced with AST_FRAME_NULL to avoid
1768  * transcode when the resulting audio is not necessary.
1769  */
1770 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1771
1772 /*!
1773  * \brief Write a frame to a channel
1774  * This function writes the given frame to the indicated channel.
1775  * \param chan destination channel of the frame
1776  * \param frame frame that will be written
1777  * \return It returns 0 on success, -1 on failure.
1778  */
1779 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1780
1781 /*!
1782  * \brief Write video frame to a channel
1783  * This function writes the given frame to the indicated channel.
1784  * \param chan destination channel of the frame
1785  * \param frame frame that will be written
1786  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1787  */
1788 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1789
1790 /*!
1791  * \brief Write text frame to a channel
1792  * This function writes the given frame to the indicated channel.
1793  * \param chan destination channel of the frame
1794  * \param frame frame that will be written
1795  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1796  */
1797 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1798
1799 /*! \brief Send empty audio to prime a channel driver */
1800 int ast_prod(struct ast_channel *chan);
1801
1802 /*!
1803  * \brief Sets read format on channel chan from capabilities
1804  * Set read format for channel to whichever component of "format" is best.
1805  * \param chan channel to change
1806  * \param formats new formats to pick from for reading
1807  * \return Returns 0 on success, -1 on failure
1808  */
1809 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1810
1811 /*!
1812  * \brief Sets read format on channel chan
1813  * \param chan channel to change
1814  * \param format format to set for reading
1815  * \return Returns 0 on success, -1 on failure
1816  */
1817 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1818
1819 /*!
1820  * \brief Sets read format on channel chan by id
1821  * \param chan channel to change
1822  * \param id format id to set for reading, only used for formats without attributes
1823  * \return Returns 0 on success, -1 on failure
1824  */
1825 int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1826
1827 /*!
1828  * \brief Sets write format on channel chan
1829  * Set write format for channel to whichever component of "format" is best.
1830  * \param chan channel to change
1831  * \param formats new formats to pick from for writing
1832  * \return Returns 0 on success, -1 on failure
1833  */
1834 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1835
1836 /*!
1837  * \brief Sets write format on channel chan
1838  * \param chan channel to change
1839  * \param format format to set for writing
1840  * \return Returns 0 on success, -1 on failure
1841  */
1842 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1843
1844 /*!
1845  * \brief Sets write format on channel chan
1846  * \param chan channel to change
1847  * \param id format id to set for writing, only used for formats without attributes
1848  * \return Returns 0 on success, -1 on failure
1849  */
1850 int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1851
1852 /*!
1853  * \brief Sends text to a channel
1854  *
1855  * \param chan channel to act upon
1856  * \param text string of text to send on the channel
1857  *
1858  * \details
1859  * Write text to a display on a channel
1860  *
1861  * \note The channel does not need to be locked before calling this function.
1862  *
1863  * \retval 0 on success
1864  * \retval -1 on failure
1865  */
1866 int ast_sendtext(struct ast_channel *chan, const char *text);
1867
1868 /*!
1869  * \brief Receives a text character from a channel
1870  * \param chan channel to act upon
1871  * \param timeout timeout in milliseconds (0 for infinite wait)
1872  * \details
1873  * Read a char of text from a channel
1874  * \return 0 on success, -1 on failure
1875  */
1876 int ast_recvchar(struct ast_channel *chan, int timeout);
1877
1878 /*!
1879  * \brief Send a DTMF digit to a channel.
1880  * \param chan channel to act upon
1881  * \param digit the DTMF digit to send, encoded in ASCII
1882  * \param duration the duration of the digit ending in ms
1883  * \return 0 on success, -1 on failure
1884  */
1885 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1886
1887 /*!
1888  * \brief Send a DTMF digit to a channel.
1889  * \param chan channel to act upon
1890  * \param digit the DTMF digit to send, encoded in ASCII
1891  * \return 0 on success, -1 on failure
1892  */
1893 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1894
1895 /*!
1896  * \brief Send a DTMF digit to a channel.
1897  * \param chan channel to act upon
1898  * \param digit the DTMF digit to send, encoded in ASCII
1899  * \param duration the duration of the digit ending in ms
1900  * \return Returns 0 on success, -1 on failure
1901  */
1902 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1903
1904 /*!
1905  * \brief Receives a text string from a channel
1906  * Read a string of text from a channel
1907  * \param chan channel to act upon
1908  * \param timeout timeout in milliseconds (0 for infinite wait)
1909  * \return the received text, or NULL to signify failure.
1910  */
1911 char *ast_recvtext(struct ast_channel *chan, int timeout);
1912
1913 /*!
1914  * \brief Waits for a digit
1915  * \param c channel to wait for a digit on
1916  * \param ms how many milliseconds to wait (<0 for indefinite).
1917  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1918  */
1919 int ast_waitfordigit(struct ast_channel *c, int ms);
1920
1921 /*!
1922  * \brief Wait for a digit
1923  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1924  * \param c channel to wait for a digit on
1925  * \param ms how many milliseconds to wait (<0 for indefinite).
1926  * \param audiofd audio file descriptor to write to if audio frames are received
1927  * \param ctrlfd control file descriptor to monitor for reading
1928  * \return Returns 1 if ctrlfd becomes available
1929  */
1930 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1931
1932 /*!
1933  * \brief Reads multiple digits
1934  * \param c channel to read from
1935  * \param s string to read in to.  Must be at least the size of your length
1936  * \param len how many digits to read (maximum)
1937  * \param timeout how long to timeout between digits
1938  * \param rtimeout timeout to wait on the first digit
1939  * \param enders digits to end the string
1940  * \details
1941  * Read in a digit string "s", max length "len", maximum timeout between
1942  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1943  * for the first digit.
1944  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1945  * a timeout, any digits that were read before the timeout will still be available in s.
1946  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1947  */
1948 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1949 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1950
1951 /*! \brief Report DTMF on channel 0 */
1952 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1953 /*! \brief Report DTMF on channel 1 */
1954 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1955 /*! \brief Return all voice frames on channel 0 */
1956 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1957 /*! \brief Return all voice frames on channel 1 */
1958 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1959 /*! \brief Ignore all signal frames except NULL */
1960 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1961
1962
1963 /*!
1964  * \brief Makes two channel formats compatible
1965  * \param c0 first channel to make compatible
1966  * \param c1 other channel to make compatible
1967  * \details
1968  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1969  * \return Returns 0 on success and -1 if it could not be done
1970  */
1971 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1972
1973 /*!
1974  * \brief Bridge two channels together (early)
1975  * \param c0 first channel to bridge
1976  * \param c1 second channel to bridge
1977  * \details
1978  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1979  * \return Returns 0 on success and -1 if it could not be done
1980  */
1981 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1982
1983 /*!
1984  * \brief Bridge two channels together
1985  * \param c0 first channel to bridge
1986  * \param c1 second channel to bridge
1987  * \param config config for the channels
1988  * \param fo destination frame(?)
1989  * \param rc destination channel(?)
1990  * \details
1991  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1992  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1993  */
1994 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1995 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1996         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1997
1998 /*!
1999  * \brief Weird function made for call transfers
2000  *
2001  * \param original channel to make a copy of
2002  * \param clone copy of the original channel
2003  *
2004  * \details
2005  * This is a very strange and freaky function used primarily for transfer.  Suppose that
2006  * "original" and "clone" are two channels in random situations.  This function takes
2007  * the guts out of "clone" and puts them into the "original" channel, then alerts the
2008  * channel driver of the change, asking it to fixup any private information (like the
2009  * p->owner pointer) that is affected by the change.  The physical layer of the original
2010  * channel is hung up.
2011  *
2012  * \note Neither channel passed here should be locked before
2013  * calling this function.  This function performs deadlock
2014  * avoidance involving these two channels.
2015  */
2016 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
2017
2018 /*!
2019  * \brief Setup a masquerade to transfer a call.
2020  * \since 1.8
2021  *
2022  * \param target_chan Target of the call transfer.  (Masquerade original channel)
2023  * \param target_id New connected line information for the target channel.
2024  * \param target_held TRUE if the target call is on hold.
2025  * \param transferee_chan Transferee of the call transfer. (Masquerade clone channel)
2026  * \param transferee_id New connected line information for the transferee channel.
2027  * \param transferee_held TRUE if the transferee call is on hold.
2028  *
2029  * \details
2030  * Party A - Transferee
2031  * Party B - Transferer
2032  * Party C - Target of transfer
2033  *
2034  * Party B transfers A to C.
2035  *
2036  * Party A is connected to bridged channel B1.
2037  * Party B is connected to channels C1 and C2.
2038  * Party C is connected to bridged channel B2.
2039  *
2040  * Party B -- C1 == B1 -- Party A
2041  *               __/
2042  *              /
2043  * Party B -- C2 == B2 -- Party C
2044  *
2045  * Bridged channel B1 is masqueraded into channel C2.  Where B1
2046  * is the masquerade clone channel and C2 is the masquerade
2047  * original channel.
2048  *
2049  * \see ast_channel_masquerade()
2050  *
2051  * \note Has the same locking requirements as ast_channel_masquerade().
2052  *
2053  * \retval 0 on success.
2054  * \retval -1 on error.
2055  */
2056 int ast_channel_transfer_masquerade(
2057         struct ast_channel *target_chan,
2058         const struct ast_party_connected_line *target_id,
2059         int target_held,
2060         struct ast_channel *transferee_chan,
2061         const struct ast_party_connected_line *transferee_id,
2062         int transferee_held);
2063
2064 /*!
2065  * \brief Gives the string form of a given cause code.
2066  *
2067  * \param state cause to get the description of
2068  * \return the text form of the binary cause code given
2069  */
2070 const char *ast_cause2str(int state) attribute_pure;
2071
2072 /*!
2073  * \brief Convert the string form of a cause code to a number
2074  *
2075  * \param name string form of the cause
2076  * \return the cause code
2077  */
2078 int ast_str2cause(const char *name) attribute_pure;
2079
2080 /*!
2081  * \brief Gives the string form of a given channel state
2082  *
2083  * \param ast_channel_state state to get the name of
2084  * \return the text form of the binary state given
2085  */
2086 const char *ast_state2str(enum ast_channel_state);
2087
2088 /*!
2089  * \brief Gives the string form of a given transfer capability
2090  *
2091  * \param transfercapability transfer capability to get the name of
2092  * \return the text form of the binary transfer capability
2093  */
2094 char *ast_transfercapability2str(int transfercapability) attribute_const;
2095
2096 /*
2097  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2098  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2099  * none or a subset of those features, and you should not count on this if you want your
2100  * asterisk application to be portable.  They're mainly useful for tweaking performance
2101  */
2102
2103 /*!
2104  * \brief Sets an option on a channel
2105  *
2106  * \param channel channel to set options on
2107  * \param option option to change
2108  * \param data data specific to option
2109  * \param datalen length of the data
2110  * \param block blocking or not
2111  * \details
2112  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2113  * \return 0 on success and -1 on failure
2114  */
2115 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2116
2117 /*!
2118  * \brief Pick the best codec
2119  *
2120  * \param cap capabilities to pick best codec out of
2121  * \param result stucture to store the best codec in.
2122  * \retval on success, pointer to result structure
2123  * \retval on failure, NULL
2124  */
2125 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result);
2126
2127
2128 /*!
2129  * \brief Checks the value of an option
2130  *
2131  * Query the value of an option
2132  * Works similarly to setoption except only reads the options.
2133  */
2134 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2135
2136 /*!
2137  * \brief Checks for HTML support on a channel
2138  * \return 0 if channel does not support HTML or non-zero if it does
2139  */
2140 int ast_channel_supports_html(struct ast_channel *channel);
2141
2142 /*!
2143  * \brief Sends HTML on given channel
2144  * Send HTML or URL on link.
2145  * \return 0 on success or -1 on failure
2146  */
2147 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2148
2149 /*!
2150  * \brief Sends a URL on a given link
2151  * Send URL on link.
2152  * \return 0 on success or -1 on failure
2153  */
2154 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2155
2156 /*!
2157  * \brief Defers DTMF so that you only read things like hangups and audio.
2158  * \return non-zero if channel was already DTMF-deferred or
2159  * 0 if channel is just now being DTMF-deferred
2160  */
2161 int ast_channel_defer_dtmf(struct ast_channel *chan);
2162
2163 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2164 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2165
2166 /*! Initiate system shutdown -- prevents new channels from being allocated.
2167  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
2168  *  hangups */
2169 void ast_begin_shutdown(int hangup);
2170
2171 /*! Cancels an existing shutdown and returns to normal operation */
2172 void ast_cancel_shutdown(void);
2173
2174 /*! \return number of channels available for lookup */
2175 int ast_active_channels(void);
2176
2177 /*! \return the number of channels not yet destroyed */
2178 int ast_undestroyed_channels(void);
2179
2180 /*! \return non-zero if Asterisk is being shut down */
2181 int ast_shutting_down(void);
2182
2183 /*! Activate a given generator */
2184 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2185
2186 /*! Deactivate an active generator */
2187 void ast_deactivate_generator(struct ast_channel *chan);
2188
2189 /*!
2190  * \brief Set caller ID number, name and ANI and generate AMI event.
2191  *
2192  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2193  * \note The channel does not need to be locked before calling this function.
2194  */
2195 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2196
2197 /*!
2198  * \brief Set the caller id information in the Asterisk channel
2199  * \since 1.8
2200  *
2201  * \param chan Asterisk channel to set caller id information
2202  * \param caller Caller id information
2203  * \param update What caller information to update.  NULL if all.
2204  *
2205  * \return Nothing
2206  *
2207  * \note The channel does not need to be locked before calling this function.
2208  */
2209 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2210
2211 /*!
2212  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2213  * if the caller id name or number changed.
2214  * \since 1.8
2215  *
2216  * \param chan Asterisk channel to set caller id information
2217  * \param caller Caller id information
2218  * \param update What caller information to update.  NULL if all.
2219  *
2220  * \return Nothing
2221  *
2222  * \note The channel does not need to be locked before calling this function.
2223  */
2224 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2225
2226 /*! Set the file descriptor on the channel */
2227 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2228
2229 /*! Add a channel to an optimized waitfor */
2230 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2231
2232 /*! Delete a channel from an optimized waitfor */
2233 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2234
2235 /*! Start a tone going */
2236 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2237 /*! Stop a tone from playing */
2238 void ast_tonepair_stop(struct ast_channel *chan);
2239 /*! Play a tone pair for a given amount of time */
2240 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2241
2242 /*!
2243  * \brief Automatically service a channel for us...
2244  *
2245  * \retval 0 success
2246  * \retval -1 failure, or the channel is already being autoserviced
2247  */
2248 int ast_autoservice_start(struct ast_channel *chan);
2249
2250 /*!
2251  * \brief Stop servicing a channel for us...
2252  *
2253  * \note if chan is locked prior to calling ast_autoservice_stop, it
2254  * is likely that there will be a deadlock between the thread that calls
2255  * ast_autoservice_stop and the autoservice thread. It is important
2256  * that chan is not locked prior to this call
2257  *
2258  * \param chan
2259  * \retval 0 success
2260  * \retval -1 error, or the channel has been hungup
2261  */
2262 int ast_autoservice_stop(struct ast_channel *chan);
2263
2264 /*!
2265  * \brief Put chan into autoservice while hanging up peer.
2266  * \since 11.0
2267  *
2268  * \param chan Chan to put into autoservice.
2269  * \param peer Chan to run hangup handlers and hangup.
2270  *
2271  * \return Nothing
2272  */
2273 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2274
2275 /*!
2276  * \brief Ignore certain frame types
2277  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2278  * while a channel is in autoservice and queue them up when taken out of
2279  * autoservice.  When this is not desireable, this API may be used to
2280  * cause the channel to ignore those frametypes after the channel is put
2281  * into autoservice, but before autoservice is stopped.
2282  * \retval 0 success
2283  * \retval -1 channel is not in autoservice
2284  */
2285 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2286
2287 /*!
2288  * \brief Enable or disable timer ticks for a channel
2289  *
2290  * \param c channel
2291  * \param rate number of timer ticks per second
2292  * \param func callback function
2293  * \param data
2294  *
2295  * \details
2296  * If timers are supported, force a scheduled expiration on the
2297  * timer fd, at which point we call the callback function / data
2298  *
2299  * \note Call this function with a rate of 0 to turn off the timer ticks
2300  *
2301  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2302  */
2303 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2304
2305 /*!
2306  * \brief Transfer a channel (if supported).
2307  * \retval -1 on error
2308  * \retval 0 if not supported
2309  * \retval 1 if supported and requested
2310  * \param chan current channel
2311  * \param dest destination extension for transfer
2312  */
2313 int ast_transfer(struct ast_channel *chan, char *dest);
2314
2315 /*!
2316  * \brief Start masquerading a channel
2317  * \note absolutely _NO_ channel locks should be held before calling this function.
2318  * \details
2319  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
2320  *     the clone channel into the original channel.  Start by killing off the original
2321  *     channel's backend.   I'm not sure we're going to keep this function, because
2322  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
2323  * \param chan Channel to masquerade
2324  */
2325 void ast_do_masquerade(struct ast_channel *chan);
2326
2327 /*!
2328  * \brief Find bridged channel
2329  *
2330  * \note This function does _not_ return a reference to the bridged channel.
2331  * The reason for this is mostly historical.  It _should_ return a reference,
2332  * but it will take a lot of work to make the code base account for that.
2333  * So, for now, the old rules still apply for how to handle this function.
2334  * If this function is being used from the channel thread that owns the channel,
2335  * then a reference is already held, and channel locking is not required to
2336  * guarantee that the channel will stay around.  If this function is used
2337  * outside of the associated channel thread, the channel parameter 'chan'
2338  * MUST be locked before calling this function.  Also, 'chan' must remain locked
2339  * for the entire time that the result of this function is being used.
2340  *
2341  * \param chan Current channel
2342  *
2343  * \return A pointer to the bridged channel
2344 */
2345 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
2346
2347 /*!
2348  * \brief Inherits channel variable from parent to child channel
2349  * \param parent Parent channel
2350  * \param child Child channel
2351  *
2352  * \details
2353  * Scans all channel variables in the parent channel, looking for those
2354  * that should be copied into the child channel.
2355  * Variables whose names begin with a single '_' are copied into the
2356  * child channel with the prefix removed.
2357  * Variables whose names begin with '__' are copied into the child
2358  * channel with their names unchanged.
2359  */
2360 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2361
2362 /*!
2363  * \brief adds a list of channel variables to a channel
2364  * \param chan the channel
2365  * \param vars a linked list of variables
2366  *
2367  * \details
2368  * Variable names can be for a regular channel variable or a dialplan function
2369  * that has the ability to be written to.
2370  */
2371 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2372
2373 /*!
2374  * \brief An opaque 'object' structure use by silence generators on channels.
2375  */
2376 struct ast_silence_generator;
2377
2378 /*!
2379  * \brief Starts a silence generator on the given channel.
2380  * \param chan The channel to generate silence on
2381  * \return An ast_silence_generator pointer, or NULL if an error occurs
2382  *
2383  * \details
2384  * This function will cause SLINEAR silence to be generated on the supplied
2385  * channel until it is disabled; if the channel cannot be put into SLINEAR
2386  * mode then the function will fail.
2387  *
2388  * \note
2389  * The pointer returned by this function must be preserved and passed to
2390  * ast_channel_stop_silence_generator when you wish to stop the silence
2391  * generation.
2392  */
2393 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2394
2395 /*!
2396  * \brief Stops a previously-started silence generator on the given channel.
2397  * \param chan The channel to operate on
2398  * \param state The ast_silence_generator pointer return by a previous call to
2399  * ast_channel_start_silence_generator.
2400  * \return nothing
2401  *
2402  * \details
2403  * This function will stop the operating silence generator and return the channel
2404  * to its previous write format.
2405  */
2406 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2407
2408 /*!
2409  * \brief Check if the channel can run in internal timing mode.
2410  * \param chan The channel to check
2411  * \return boolean
2412  *
2413  * \details
2414  * This function will return 1 if internal timing is enabled and the timing
2415  * device is available.
2416  */
2417 int ast_internal_timing_enabled(struct ast_channel *chan);
2418
2419 /* Misc. functions below */
2420
2421 /*!
2422  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2423  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2424  * return value to the index into the array)
2425  */
2426 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2427 {
2428         pfd->fd = fd;
2429         pfd->events = POLLIN | POLLPRI;
2430         return fd >= 0;
2431 }
2432
2433 /*! \brief Helper function for migrating select to poll */
2434 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2435 {
2436         int x;
2437         int dummy = 0;
2438
2439         if (fd < 0)
2440                 return 0;
2441         if (!start)
2442                 start = &dummy;
2443         for (x = *start; x < maximum; x++)
2444                 if (pfds[x].fd == fd) {
2445                         if (x == *start)
2446                                 (*start)++;
2447                         return pfds[x].revents;
2448                 }
2449         return 0;
2450 }
2451
2452 /*! \brief Retrieves the current T38 state of a channel */
2453 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2454 {
2455         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2456         int datalen = sizeof(state);
2457
2458         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2459
2460         return state;
2461 }
2462
2463 #define CHECK_BLOCKING(c) do {   \
2464         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2465                 ast_debug(1, "Thread %p is blocking '%s', already blocked by thread %p in procedure %s\n", \
2466                         (void *) pthread_self(), ast_channel_name(c), (void *) ast_channel_blocker(c), ast_channel_blockproc(c)); \
2467         } else { \
2468                 ast_channel_blocker_set((c), pthread_self()); \
2469                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2470                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2471         } } while (0)
2472
2473 ast_group_t ast_get_group(const char *s);
2474
2475 /*! \brief Print call and pickup groups into buffer */
2476 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2477
2478 /*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2479 struct ast_namedgroups;
2480
2481 /*! \brief Create an ast_namedgroups set with group names from comma separated string */
2482 struct ast_namedgroups *ast_get_namedgroups(const char *s);
2483 struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2484 struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2485 /*! \brief Return TRUE if group a and b contain at least one common groupname */
2486 int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2487
2488 /*! \brief Print named call groups and named pickup groups */
2489 char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2490
2491 /*!
2492  * \brief Convert enum channelreloadreason to text string for manager event
2493  * \param reason The reason for reload (manager, cli, start etc)
2494  */
2495 const char *channelreloadreason2txt(enum channelreloadreason reason);
2496
2497 /*! \brief return an ast_variable list of channeltypes */
2498 struct ast_variable *ast_channeltype_list(void);
2499
2500 /*!
2501  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2502  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2503  * \return char pointer explaining the code
2504  */
2505 const char *ast_channel_reason2str(int reason);
2506
2507 /*! \brief channel group info */
2508 struct ast_group_info {
2509         struct ast_channel *chan;
2510         char *category;
2511         char *group;
2512         AST_LIST_ENTRY(ast_group_info) group_list;
2513 };
2514
2515 #define ast_channel_lock(chan) ao2_lock(chan)
2516 #define ast_channel_unlock(chan) ao2_unlock(chan)
2517 #define ast_channel_trylock(chan) ao2_trylock(chan)
2518
2519 /*!
2520  * \brief Lock two channels.
2521  */
2522 #define ast_channel_lock_both(chan1, chan2) do { \
2523                 ast_channel_lock(chan1); \
2524                 while (ast_channel_trylock(chan2)) { \
2525                         ast_channel_unlock(chan1); \
2526                         sched_yield(); \
2527                         ast_channel_lock(chan1); \
2528                 } \
2529         } while (0)
2530
2531 /*!
2532  * \brief Increase channel reference count
2533  *
2534  * \param c the channel
2535  *
2536  * \retval c always
2537  *
2538  * \since 1.8
2539  */
2540 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2541
2542 /*!
2543  * \brief Decrease channel reference count
2544  *
2545  * \param c the channel
2546  *
2547  * \retval NULL always
2548  *
2549  * \since 1.8
2550  */
2551 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2552
2553 /*! Channel Iterating @{ */
2554
2555 /*!
2556  * \brief A channel iterator
2557  *
2558  * This is an opaque type.
2559  */
2560 struct ast_channel_iterator;
2561
2562 /*!
2563  * \brief Destroy a channel iterator
2564  *
2565  * \param i the itereator to destroy
2566  *
2567  * \details
2568  * This function is used to destroy a channel iterator that was retrieved by
2569  * using one of the channel_iterator_xxx_new() functions.
2570  *
2571  * \return NULL, for convenience to clear out the pointer to the iterator that
2572  * was just destroyed.
2573  *
2574  * \since 1.8
2575  */
2576 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2577
2578 /*!
2579  * \brief Create a new channel iterator based on extension
2580  *
2581  * \param exten The extension that channels must be in
2582  * \param context The context that channels must be in
2583  *
2584  * \details
2585  * After creating an iterator using this function, the ast_channel_iterator_next()
2586  * function can be used to iterate through all channels that are currently
2587  * in the specified context and extension.
2588  *
2589  * \note You must call ast_channel_iterator_destroy() when done.
2590  *
2591  * \retval NULL on failure
2592  * \retval a new channel iterator based on the specified parameters
2593  *
2594  * \since 1.8
2595  */
2596 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2597
2598 /*!
2599  * \brief Create a new channel iterator based on name
2600  *
2601  * \param name channel name or channel uniqueid to match
2602  * \param name_len number of characters in the channel name to match on.  This
2603  *      would be used to match based on name prefix.  If matching on the full
2604  *      channel name is desired, then this parameter should be 0.
2605  *
2606  * \details
2607  * After creating an iterator using this function, the ast_channel_iterator_next()
2608  * function can be used to iterate through all channels that exist that have
2609  * the specified name or name prefix.
2610  *
2611  * \note You must call ast_channel_iterator_destroy() when done.
2612  *
2613  * \retval NULL on failure
2614  * \retval a new channel iterator based on the specified parameters
2615  *
2616  * \since 1.8
2617  */
2618 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2619
2620 /*!
2621  * \brief Create a new channel iterator
2622  *
2623  * \details
2624  * After creating an iterator using this function, the ast_channel_iterator_next()
2625  * function can be used to iterate through all channels that exist.
2626  *
2627  * \note You must call ast_channel_iterator_destroy() when done.
2628  *
2629  * \retval NULL on failure
2630  * \retval a new channel iterator
2631  *
2632  * \since 1.8
2633  */
2634 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2635
2636 /*!
2637  * \brief Get the next channel for a channel iterator
2638  *
2639  * \param i the channel iterator that was created using one of the
2640  *  channel_iterator_xxx_new() functions.
2641  *
2642  * \details
2643  * This function should be used to iterate through all channels that match a
2644  * specified set of parameters that were provided when the iterator was created.
2645  *
2646  * \retval the next channel that matches the parameters used when the iterator
2647  *         was created.
2648  * \retval NULL, if no more channels match the iterator parameters.
2649  *
2650  * \since 1.8
2651  */
2652 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2653
2654 /*! @} End channel iterator definitions. */
2655
2656 /*!
2657  * \brief Call a function with every active channel
2658  *
2659  * \details
2660  * This function executes a callback one time for each active channel on the
2661  * system.  The channel is provided as an argument to the function.
2662  *
2663  * \note Absolutely _NO_ channel locks should be held before calling this function.
2664  * \since 1.8
2665  */
2666 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2667                 void *data, int ao2_flags);
2668
2669 /*! @{ Channel search functions */
2670
2671 /*!
2672  * \brief Find a channel by name
2673  *
2674  * \param name the name or uniqueid of the channel to search for
2675  *
2676  * \details
2677  * Find a channel that has the same name as the provided argument.
2678  *
2679  * \retval a channel with the name specified by the argument
2680  * \retval NULL if no channel was found
2681  *
2682  * \since 1.8
2683  */
2684 struct ast_channel *ast_channel_get_by_name(const char *name);
2685
2686 /*!
2687  * \brief Find a channel by a name prefix
2688  *
2689  * \param name The channel name or uniqueid prefix to search for
2690  * \param name_len Only search for up to this many characters from the name
2691  *
2692  * \details
2693  * Find a channel that has the same name prefix as specified by the arguments.
2694  *
2695  * \retval a channel with the name prefix specified by the arguments
2696  * \retval NULL if no channel was found
2697  *
2698  * \since 1.8
2699  */
2700 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2701
2702 /*!
2703  * \brief Find a channel by extension and context
2704  *
2705  * \param exten the extension to search for
2706  * \param context the context to search for
2707  *
2708  * \details
2709  * Return a channel that is currently at the specified extension and context.
2710  *
2711  * \retval a channel that is at the specified extension and context
2712  * \retval NULL if no channel was found
2713  *
2714  * \since 1.8
2715  */
2716 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2717
2718 /*! @} End channel search functions. */
2719
2720 /*!
2721   \brief propagate the linked id between chan and peer
2722  */
2723 void ast_channel_set_linkgroup(struct ast_channel *chan, struct ast_channel *peer);
2724
2725
2726 /*!
2727  * \brief Initialize the given name structure.
2728  * \since 1.8
2729  *
2730  * \param init Name structure to initialize.
2731  *
2732  * \return Nothing
2733  */
2734 void ast_party_name_init(struct ast_party_name *init);
2735
2736 /*!
2737  * \brief Copy the source party name information to the destination party name.
2738  * \since 1.8
2739  *
2740  * \param dest Destination party name
2741  * \param src Source party name
2742  *
2743  * \return Nothing
2744  */
2745 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2746
2747 /*!
2748  * \brief Initialize the given party name structure using the given guide
2749  * for a set update operation.
2750  * \since 1.8
2751  *
2752  * \details
2753  * The initialization is needed to allow a set operation to know if a
2754  * value needs to be updated.  Simple integers need the guide's original
2755  * value in case the set operation is not trying to set a new value.
2756  * String values are simply set to NULL pointers if they are not going
2757  * to be updated.
2758  *
2759  * \param init Party name structure to initialize.
2760  * \param guide Source party name to use as a guide in initializing.
2761  *
2762  * \return Nothing
2763  */
2764 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2765
2766 /*!
2767  * \brief Set the source party name information into the destination party name.
2768  * \since 1.8
2769  *
2770  * \param dest The name one wishes to update
2771  * \param src The new name values to update the dest
2772  *
2773  * \return Nothing
2774  */
2775 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2776
2777 /*!
2778  * \brief Destroy the party name contents
2779  * \since 1.8
2780  *
2781  * \param doomed The party name to destroy.
2782  *
2783  * \return Nothing
2784  */
2785 void ast_party_name_free(struct ast_party_name *doomed);
2786
2787 /*!
2788  * \brief Initialize the given number structure.
2789  * \since 1.8
2790  *
2791  * \param init Number structure to initialize.
2792  *
2793  * \return Nothing
2794  */
2795 void ast_party_number_init(struct ast_party_number *init);
2796
2797 /*!
2798  * \brief Copy the source party number information to the destination party number.
2799  * \since 1.8
2800  *
2801  * \param dest Destination party number
2802  * \param src Source party number
2803  *
2804  * \return Nothing
2805  */
2806 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2807
2808 /*!
2809  * \brief Initialize the given party number structure using the given guide
2810  * for a set update operation.
2811  * \since 1.8
2812  *
2813  * \details
2814  * The initialization is needed to allow a set operation to know if a
2815  * value needs to be updated.  Simple integers need the guide's original
2816  * value in case the set operation is not trying to set a new value.
2817  * String values are simply set to NULL pointers if they are not going
2818  * to be updated.
2819  *
2820  * \param init Party number structure to initialize.
2821  * \param guide Source party number to use as a guide in initializing.
2822  *
2823  * \return Nothing
2824  */
2825 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2826
2827 /*!
2828  * \brief Set the source party number information into the destination party number.
2829  * \since 1.8
2830  *
2831  * \param dest The number one wishes to update
2832  * \param src The new number values to update the dest
2833  *
2834  * \return Nothing
2835  */
2836 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2837
2838 /*!
2839  * \brief Destroy the party number contents
2840  * \since 1.8
2841  *
2842  * \param doomed The party number to destroy.
2843  *
2844  * \return Nothing
2845  */
2846 void ast_party_number_free(struct ast_party_number *doomed);
2847
2848 /*!
2849  * \since 1.8
2850  * \brief Initialize the given subaddress structure.
2851  *
2852  * \param init Subaddress structure to initialize.
2853  *
2854  * \return Nothing
2855  */
2856 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2857
2858 /*!
2859  * \since 1.8
2860  * \brief Copy the source party subaddress information to the destination party subaddress.
2861  *
2862  * \param dest Destination party subaddress
2863  * \param src Source party subaddress
2864  *
2865  * \return Nothing
2866  */
2867 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2868
2869 /*!
2870  * \since 1.8
2871  * \brief Initialize the given party subaddress structure using the given guide
2872  * for a set update operation.
2873  *
2874  * \details
2875  * The initialization is needed to allow a set operation to know if a
2876  * value needs to be updated.  Simple integers need the guide's original
2877  * value in case the set operation is not trying to set a new value.
2878  * String values are simply set to NULL pointers if they are not going
2879  * to be updated.
2880  *
2881  * \param init Party subaddress structure to initialize.
2882  * \param guide Source party subaddress to use as a guide in initializing.
2883  *
2884  * \return Nothing
2885  */
2886 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2887
2888 /*!
2889  * \since 1.8
2890  * \brief Set the source party subaddress information into the destination party subaddress.
2891  *
2892  * \param dest The subaddress one wishes to update
2893  * \param src The new subaddress values to update the dest
2894  *
2895  * \return Nothing
2896  */
2897 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2898
2899 /*!
2900  * \since 1.8
2901  * \brief Destroy the party subaddress contents
2902  *
2903  * \param doomed The party subaddress to destroy.
2904  *
2905  * \return Nothing
2906  */
2907 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2908
2909 /*!
2910  * \brief Set the update marker to update all information of a corresponding party id.
2911  * \since 11.0
2912  *
2913  * \param update_id The update marker for a corresponding party id.
2914  *
2915  * \return Nothing
2916  */
2917 void ast_set_party_id_all(struct ast_set_party_id *update_id);
2918
2919 /*!
2920  * \brief Initialize the given party id structure.
2921  * \since 1.8
2922  *
2923  * \param init Party id structure to initialize.
2924  *
2925  * \return Nothing
2926  */
2927 void ast_party_id_init(struct ast_party_id *init);
2928
2929 /*!
2930  * \brief Copy the source party id information to the destination party id.
2931  * \since 1.8
2932  *
2933  * \param dest Destination party id
2934  * \param src Source party id
2935  *
2936  * \return Nothing
2937  */
2938 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
2939
2940 /*!
2941  * \brief Initialize the given party id structure using the given guide
2942  * for a set update operation.
2943  * \since 1.8
2944  *
2945  * \details
2946  * The initialization is needed to allow a set operation to know if a
2947  * value needs to be updated.  Simple integers need the guide's original
2948  * value in case the set operation is not trying to set a new value.
2949  * String values are simply set to NULL pointers if they are not going
2950  * to be updated.
2951  *
2952  * \param init Party id structure to initialize.
2953  * \param guide Source party id to use as a guide in initializing.
2954  *
2955  * \return Nothing
2956  */
2957 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
2958
2959 /*!
2960  * \brief Set the source party id information into the destination party id.
2961  * \since 1.8
2962  *
2963  * \param dest The id one wishes to update
2964  * \param src The new id values to update the dest
2965  * \param update What id information to update.  NULL if all.
2966  *
2967  * \return Nothing
2968  */
2969 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
2970
2971 /*!
2972  * \brief Destroy the party id contents
2973  * \since 1.8
2974  *
2975  * \param doomed The party id to destroy.
2976  *
2977  * \return Nothing
2978  */
2979 void ast_party_id_free(struct ast_party_id *doomed);
2980
2981 /*!
2982  * \brief Determine the overall presentation value for the given party.
2983  * \since 1.8
2984  *
2985  * \param id Party to determine the overall presentation value.
2986  *
2987  * \return Overall presentation value for the given party.
2988  */
2989 int ast_party_id_presentation(const struct ast_party_id *id);
2990
2991 /*!
2992  * \brief Invalidate all components of the given party id.
2993  * \since 11.0
2994  *
2995  * \param id The party id to invalidate.
2996  *
2997  * \return Nothing
2998  */
2999 void ast_party_id_invalidate(struct ast_party_id *id);
3000
3001 /*!
3002  * \brief Destroy and initialize the given party id structure.
3003  * \since 11.0
3004  *
3005  * \param id The party id to reset.
3006  *
3007  * \return Nothing
3008  */
3009 void ast_party_id_reset(struct ast_party_id *id);
3010
3011 /*!
3012  * \brief Merge a given party id into another given party id.
3013  * \since 11.0
3014  *
3015  * \details
3016  * This function will generate an effective party id.
3017  * 
3018  * Each party id component of the party id 'base' is overwritten
3019  * by components of the party id 'overlay' if the overlay
3020  * component is marked as valid.  However the component 'tag' of
3021  * the base party id remains untouched.
3022  *
3023  * \param base The party id which is merged.
3024  * \param overlay The party id which is used to merge into.
3025  *
3026  * \return The merged party id as a struct, not as a pointer.
3027  * \note The merged party id returned is a shallow copy and must not be freed.
3028  */
3029 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3030
3031 /*!
3032  * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3033  * \since 11.0
3034  *
3035  * \details
3036  * Each party id component of the party id 'base' is overwritten by components
3037  * of the party id 'overlay' if the 'overlay' component is marked as valid.
3038  * However the component 'tag' of the 'base' party id remains untouched.
3039  * The result is copied into the given party id 'dest'.
3040  *
3041  * \note The resulting merged party id is a real copy and has to be freed.
3042  *
3043  * \param dest The resulting merged party id.
3044  * \param base The party id which is merged.
3045  * \param overlay The party id which is used to merge into.
3046  *
3047  * \return Nothing
3048  */
3049 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3050
3051 /*!
3052  * \brief Initialize the given dialed structure.
3053  * \since 1.8
3054  *
3055  * \param init Dialed structure to initialize.
3056  *
3057  * \return Nothing
3058  */
3059 void ast_party_dialed_init(struct ast_party_dialed *init);
3060
3061 /*!
3062  * \brief Copy the source dialed party information to the destination dialed party.
3063  * \since 1.8
3064  *
3065  * \param dest Destination dialed party
3066  * \param src Source dialed party
3067  *
3068  * \return Nothing
3069  */
3070 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3071
3072 /*!
3073  * \brief Initialize the given dialed structure using the given
3074  * guide for a set update operation.
3075  * \since 1.8
3076  *
3077  * \details
3078  * The initialization is needed to allow a set operation to know if a
3079  * value needs to be updated.  Simple integers need the guide's original
3080  * value in case the set operation is not trying to set a new value.
3081  * String values are simply set to NULL pointers if they are not going
3082  * to be updated.
3083  *
3084  * \param init Caller structure to initialize.
3085  * \param guide Source dialed to use as a guide in initializing.
3086  *
3087  * \return Nothing
3088  */
3089 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3090
3091 /*!
3092  * \brief Set the dialed information based on another dialed source
3093  * \since 1.8
3094  *
3095  * This is similar to ast_party_dialed_copy, except that NULL values for
3096  * strings in the src parameter indicate not to update the corresponding dest values.
3097  *
3098  * \param dest The dialed one wishes to update
3099  * \param src The new dialed values to update the dest
3100  *
3101  * \return Nada
3102  */
3103 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3104
3105 /*!
3106  * \brief Destroy the dialed party contents
3107  * \since 1.8
3108  *
3109  * \param doomed The dialed party to destroy.
3110  *
3111  * \return Nothing
3112  */
3113 void ast_party_dialed_free(struct ast_party_dialed *doomed);
3114
3115 /*!
3116  * \since 1.8
3117  * \brief Initialize the given caller structure.
3118  *
3119  * \param init Caller structure to initialize.
3120  *
3121  * \return Nothing
3122  */
3123 void ast_party_caller_init(struct ast_party_caller *init);
3124
3125 /*!
3126  * \since 1.8
3127  * \brief Copy the source caller information to the destination caller.
3128  *
3129  * \param dest Destination caller
3130  * \param src Source caller
3131  *
3132  * \return Nothing
3133  */
3134 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3135
3136 /*!
3137  * \brief Initialize the given caller structure using the given
3138  * guide for a set update operation.
3139  * \since 1.8
3140  *
3141  * \details
3142  * The initialization is needed to allow a set operation to know if a
3143  * value needs to be updated.  Simple integers need the guide's original
3144  * value in case the set operation is not trying to set a new value.
3145  * String values are simply set to NULL pointers if they are not going
3146  * to be updated.
3147  *
3148  * \param init Caller structure to initialize.
3149  * \param guide Source caller to use as a guide in initializing.
3150  *
3151  * \return Nothing
3152  */
3153 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3154
3155 /*!
3156  * \brief Set the caller information based on another caller source
3157  * \since 1.8
3158  *
3159  * This is similar to ast_party_caller_copy, except that NULL values for
3160  * strings in the src parameter indicate not to update the corresponding dest values.
3161  *
3162  * \param dest The caller one wishes to update
3163  * \param src The new caller values to update the dest
3164  * \param update What caller information to update.  NULL if all.
3165  *
3166  * \return Nada
3167  */
3168 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3169
3170 /*!
3171  * \brief Destroy the caller party contents
3172  * \since 1.8
3173  *
3174  * \param doomed The caller party to destroy.
3175  *
3176  * \return Nothing
3177  */
3178 void ast_party_caller_free(struct ast_party_caller *doomed);
3179
3180 /*!
3181  * \since 1.8
3182  * \brief Initialize the given connected line structure.
3183  *
3184  * \param init Connected line structure to initialize.
3185  *
3186  * \return Nothing
3187  */
3188 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3189
3190 /*!
3191  * \since 1.8
3192  * \brief Copy the source connected line information to the destination connected line.
3193  *
3194  * \param dest Destination connected line
3195  * \param src Source connected line
3196  *
3197  * \return Nothing
3198  */
3199 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3200
3201 /*!
3202  * \since 1.8
3203  * \brief Initialize the given connected line structure using the given
3204  * guide for a set update operation.
3205  *
3206  * \details
3207  * The initialization is needed to allow a set operation to know if a
3208  * value needs to be updated.  Simple integers need the guide's original
3209  * value in case the set operation is not trying to set a new value.
3210  * String values are simply set to NULL pointers if they are not going
3211  * to be updated.
3212  *
3213  * \param init Connected line structure to initialize.
3214  * \param guide Source connected line to use as a guide in initializing.
3215  *
3216  * \return Nothing
3217  */
3218 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3219
3220 /*!
3221  * \since 1.8
3222  * \brief Set the connected line information based on another connected line source
3223  *
3224  * This is similar to ast_party_connected_line_copy, except that NULL values for
3225  * strings in the src parameter indicate not to update the corresponding dest values.
3226  *
3227  * \param dest The connected line one wishes to update
3228  * \param src The new connected line values to update the dest
3229  * \param update What connected line information to update.  NULL if all.
3230  *
3231  * \return Nothing
3232  */
3233 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update);
3234
3235 /*!
3236  * \since 1.8
3237  * \brief Collect the caller party information into a connected line structure.
3238  *
3239  * \param connected Collected caller information for the connected line
3240  * \param caller Caller information.
3241  *
3242  * \return Nothing
3243  *
3244  * \warning This is a shallow copy.
3245  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3246  * connected line structure!
3247  */
3248 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3249
3250 /*!
3251  * \since 1.8
3252  * \brief Destroy the connected line information contents
3253  *
3254  * \param doomed The connected line information to destroy.
3255  *
3256  * \return Nothing
3257  */
3258 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3259
3260 /*!
3261  * \brief Initialize the given redirecting reason structure
3262  *
3263  * \param init Redirecting reason structure to initialize
3264  *
3265  * \return Nothing
3266  */
3267 void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init);
3268
3269 /*!
3270  * \brief Copy the source redirecting reason information to the destination redirecting reason.
3271  *
3272  * \param dest Destination redirecting reason
3273  * \param src Source redirecting reason
3274  *
3275  * \return Nothing
3276  */
3277 void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest,
3278                 const struct ast_party_redirecting_reason *src);
3279
3280 /*!
3281  * \brief Initialize the given redirecting reason structure using the given guide
3282  * for a set update operation.
3283  *
3284  * \details
3285  * The initialization is needed to allow a set operation to know if a
3286  * value needs to be updated.  Simple integers need the guide's original
3287  * value in case the set operation is not trying to set a new value.
3288  * String values are simply set to NULL pointers if they are not going
3289  * to be updated.
3290  *
3291  * \param init Redirecting reason structure to initialize.
3292  * \param guide Source redirecting reason to use as a guide in initializing.
3293  *
3294  * \return Nothing
3295  */
3296 void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init,
3297                 const struct ast_party_redirecting_reason *guide);
3298
3299 /*!
3300  * \brief Set the redirecting reason information based on another redirecting reason source
3301  *
3302  * This is similar to ast_party_redirecting_reason_copy, except that NULL values for
3303  * strings in the src parameter indicate not to update the corresponding dest values.
3304  *
3305  * \param dest The redirecting reason one wishes to update
3306  * \param src The new redirecting reason values to update the dest
3307  *
3308  * \return Nothing
3309  */
3310 void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest,
3311                 const struct ast_party_redirecting_reason *src);
3312
3313 /*!
3314  * \brief Destroy the redirecting reason contents
3315  *
3316  * \param doomed The redirecting reason to destroy.
3317  *
3318  * \return Nothing
3319  */
3320 void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed);
3321
3322 /*!
3323  * \brief Initialize the given redirecting structure.
3324  * \since 1.8
3325  *
3326  * \param init Redirecting structure to initialize.
3327  *
3328  * \return Nothing
3329  */
3330 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3331
3332 /*!
3333  * \since 1.8
3334  * \brief Copy the source redirecting information to the destination redirecting.
3335  *
3336  * \param dest Destination redirecting
3337  * \param src Source redirecting
3338  *
3339  * \return Nothing
3340  */
3341 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3342
3343 /*!
3344  * \since 1.8
3345  * \brief Initialize the given redirecting id structure using the given guide
3346  * for a set update operation.
3347  *
3348  * \details
3349  * The initialization is needed to allow a set operation to know if a
3350  * value needs to be updated.  Simple integers need the guide's original
3351  * value in case the set operation is not trying to set a new value.
3352  * String values are simply set to NULL pointers if they are not going
3353  * to be updated.
3354  *
3355  * \param init Redirecting id structure to initialize.
3356  * \param guide Source redirecting id to use as a guide in initializing.
3357  *
3358  * \return Nothing
3359  */
3360 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3361
3362 /*!
3363  * \brief Set the redirecting information based on another redirecting source
3364  * \since 1.8
3365  *
3366  * This is similar to ast_party_redirecting_copy, except that NULL values for
3367  * strings in the src parameter indicate not to update the corresponding dest values.
3368  *
3369  * \param dest The redirecting one wishes to update
3370  * \param src The new redirecting values to update the dest
3371  * \param update What redirecting information to update.  NULL if all.
3372  *
3373  * \return Nothing
3374  */
3375 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3376
3377 /*!
3378  * \since 1.8
3379  * \brief Destroy the redirecting information contents
3380  *
3381  * \param doomed The redirecting information to destroy.
3382  *
3383  * \return Nothing
3384  */
3385 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3386
3387 /*!
3388  * \since 1.8
3389  * \brief Copy the caller information to the connected line information.
3390  *
3391  * \param dest Destination connected line information
3392  * \param src Source caller information
3393  *
3394  * \return Nothing
3395  *
3396  * \note Assumes locks are already acquired
3397  */
3398 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3399
3400 /*!
3401  * \since 1.8
3402  * \brief Copy the connected line information to the caller information.
3403  *
3404  * \param dest Destination caller information
3405  * \param src Source connected line information
3406  *
3407  * \return Nothing
3408  *
3409  * \note Assumes locks are already acquired
3410  */
3411 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3412
3413 /*!
3414  * \since 1.8
3415  * \brief Set the connected line information in the Asterisk channel
3416  *
3417  * \param chan Asterisk channel to set connected line information
3418  * \param connected Connected line information
3419  * \param update What connected line information to update.  NULL if all.
3420  *
3421  * \return Nothing
3422  *
3423  * \note The channel does not need to be locked before calling this function.
3424  */
3425 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3426
3427 /*!
3428  * \since 1.8
3429  * \brief Build the connected line information data frame.
3430  *
3431  * \param data Buffer to fill with the frame data
3432  * \param datalen Size of the buffer to fill
3433  * \param connected Connected line information
3434  * \param update What connected line information to build.  NULL if all.
3435  *
3436  * \retval -1 if error
3437  * \retval Amount of data buffer used
3438  */
3439 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3440
3441 /*!
3442  * \since 1.8
3443  * \brief Parse connected line indication frame data
3444  *
3445  * \param data Buffer with the frame data to parse
3446  * \param datalen Size of the buffer
3447  * \param connected Extracted connected line information
3448  *
3449  * \retval 0 on success.
3450  * \retval -1 on error.
3451  *
3452  * \note The filled in connected line structure needs to be initialized by
3453  * ast_party_connected_line_set_init() before calling.  If defaults are not
3454  * required use ast_party_connected_line_init().
3455  * \note The filled in connected line structure needs to be destroyed by
3456  * ast_party_connected_line_free() when it is no longer needed.
3457  */
3458 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3459
3460 /*!
3461  * \since 1.8
3462  * \brief Indicate that the connected line information has changed
3463  *
3464  * \param chan Asterisk channel to indicate connected line information
3465  * \param connected Connected line information
3466  * \param update What connected line information to update.  NULL if all.
3467  *
3468  * \return Nothing
3469  */
3470 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast