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