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