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