major dialplan functions update
[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, ZAP, 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 \ref channel_drivers - Implemented channel drivers
82         \arg \ref Def_Frame Asterisk Multimedia Frames
83
84 */
85
86 #ifndef _ASTERISK_CHANNEL_H
87 #define _ASTERISK_CHANNEL_H
88
89 #include <unistd.h>
90 #ifdef POLLCOMPAT 
91 #include "asterisk/poll-compat.h"
92 #else
93 #include <sys/poll.h>
94 #endif
95
96 #if defined(__cplusplus) || defined(c_plusplus)
97 extern "C" {
98 #endif
99
100 /*! Max length of an extension */
101 #define AST_MAX_EXTENSION       80
102
103 #define AST_MAX_CONTEXT         80
104
105 #define AST_CHANNEL_NAME        80
106
107 #include "asterisk/compat.h"
108 #include "asterisk/frame.h"
109 #include "asterisk/sched.h"
110 #include "asterisk/chanvars.h"
111 #include "asterisk/config.h"
112 #include "asterisk/lock.h"
113 #include "asterisk/cdr.h"
114 #include "asterisk/utils.h"
115 #include "asterisk/linkedlists.h"
116 #include "asterisk/stringfields.h"
117
118 #define MAX_LANGUAGE            20
119
120 #define MAX_MUSICCLASS          20
121
122 #define AST_MAX_FDS             8
123 /*
124  * We have AST_MAX_FDS file descriptors in a channel.
125  * Some of them have a fixed use:
126  */
127 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /* used for alertpipe */
128 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /* used for timingfd */
129 #define AST_AGENT_FD    (AST_MAX_FDS-3) /* used by agents for pass thru */
130 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /* used by generator */
131
132 enum ast_bridge_result {
133         AST_BRIDGE_COMPLETE = 0,
134         AST_BRIDGE_FAILED = -1,
135         AST_BRIDGE_FAILED_NOWARN = -2,
136         AST_BRIDGE_RETRY = -3,
137 };
138
139 typedef unsigned long long ast_group_t;
140
141 struct ast_generator {
142         void *(*alloc)(struct ast_channel *chan, void *params);
143         void (*release)(struct ast_channel *chan, void *data);
144         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
145 };
146
147 /*! Structure for all kinds of caller ID identifications */
148 struct ast_callerid {
149         /*! Malloc'd Dialed Number Identifier */
150         char *cid_dnid;                         
151         /*! Malloc'd Caller Number */
152         char *cid_num;
153         /*! Malloc'd Caller Name */
154         char *cid_name;
155         /*! Malloc'd ANI */
156         char *cid_ani;                  
157         /*! Malloc'd RDNIS */
158         char *cid_rdnis;
159         /*! Callerid presentation/screening */
160         int cid_pres;
161         /*! Callerid ANI 2 (Info digits) */
162         int cid_ani2;
163         /*! Callerid Type of Number */
164         int cid_ton;
165         /*! Callerid Transit Network Select */
166         int cid_tns;
167 };
168
169 /*! Structure to describe a channel "technology", ie a channel driver 
170         See
171         \arg chan_iax2.c - The Inter-Asterisk exchange protocol
172         \arg chan_sip.c - The SIP channel driver
173         \arg chan_zap.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
174
175         If you develop your own channel driver, this is where you
176         tell the PBX at registration of your driver what properties
177         this driver supports and where different callbacks are 
178         implemented.
179 */
180         
181
182 struct ast_channel_tech {
183         const char * const type;
184         const char * const description;
185
186         /*! Bitmap of formats this channel can handle */
187         int capabilities;
188
189         /*! Technology Properties */
190         int properties;
191
192         /*! Requester - to set up call data structures (pvt's) */
193         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
194
195         /*! Devicestate call back */
196         int (* const devicestate)(void *data);
197
198         /*! Send a literal DTMF digit */
199         int (* const send_digit)(struct ast_channel *chan, char digit);
200
201         /*! Start sending a literal DTMF digit */
202         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
203
204         /*! Stop sending the last literal DTMF digit */
205         int (* const send_digit_end)(struct ast_channel *chan);
206
207         /*! Call a given phone number (address, etc), but don't
208            take longer than timeout seconds to do so.  */
209         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
210
211         /*! Hangup (and possibly destroy) the channel */
212         int (* const hangup)(struct ast_channel *chan);
213
214         /*! Answer the channel */
215         int (* const answer)(struct ast_channel *chan);
216
217         /*! Read a frame, in standard format (see frame.h) */
218         struct ast_frame * (* const read)(struct ast_channel *chan);
219
220         /*! Write a frame, in standard format (see frame.h) */
221         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
222
223         /*! Display or transmit text */
224         int (* const send_text)(struct ast_channel *chan, const char *text);
225
226         /*! Display or send an image */
227         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
228
229         /*! Send HTML data */
230         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
231
232         /*! Handle an exception, reading a frame */
233         struct ast_frame * (* const exception)(struct ast_channel *chan);
234
235         /*! Bridge two channels of the same type together */
236         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
237                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
238
239         /*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
240         int (* const indicate)(struct ast_channel *c, int condition);
241
242         /*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
243         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
244
245         /*! Set a given option */
246         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
247
248         /*! Query a given option */
249         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
250
251         /*! Blind transfer other side (see app_transfer.c and ast_transfer() */
252         int (* const transfer)(struct ast_channel *chan, const char *newdest);
253
254         /*! Write a frame, in standard format */
255         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
256
257         /*! Find bridged channel */
258         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
259
260         /*! Provide additional items for CHANNEL() dialplan function */
261         int (* func_channel_read)(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
262         int (* func_channel_write)(struct ast_channel *chan, char *function, char *data, const char *value);
263 };
264
265 struct ast_channel_spy_list;
266
267 /*! Main Channel structure associated with a channel. 
268  * This is the side of it mostly used by the pbx and call management.
269  *
270  * \note XXX It is important to remember to increment .cleancount each time
271  *       this structure is changed. XXX
272  */
273 struct ast_channel {
274         /*! Technology (point to channel driver) */
275         const struct ast_channel_tech *tech;
276
277         /*! Private data used by the technology driver */
278         void *tech_pvt;
279
280         AST_DECLARE_STRING_FIELDS(
281                 AST_STRING_FIELD(name);                 /*! ASCII unique channel name */
282                 AST_STRING_FIELD(language);             /*! Language requested for voice prompts */
283                 AST_STRING_FIELD(musicclass);           /*! Default music class */
284                 AST_STRING_FIELD(accountcode);          /*! Account code for billing */
285                 AST_STRING_FIELD(call_forward);         /*! Where to forward to if asked to dial on this interface */
286         );
287         
288         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
289         int fds[AST_MAX_FDS];                   
290
291         /*! Music State*/
292         void *music_state;
293         /*! Current generator data if there is any */
294         void *generatordata;
295         /*! Current active data generator */
296         struct ast_generator *generator;
297
298         /*! Who are we bridged to, if we're bridged  Do not access directly,
299             use ast_bridged_channel(chan) */
300         struct ast_channel *_bridge;
301         /*! Channel that will masquerade as us */
302         struct ast_channel *masq;               
303         /*! Who we are masquerading as */
304         struct ast_channel *masqr;              
305         /*! Call Detail Record Flags */
306         int cdrflags;                                                                              
307         /*! Whether or not we have been hung up...  Do not set this value
308             directly, use ast_softhangup */
309         int _softhangup;
310         /*! Non-zero, set to actual time when channel is to be hung up */
311         time_t  whentohangup;
312         /*! If anyone is blocking, this is them */
313         pthread_t blocker;                      
314         /*! Lock, can be used to lock a channel for some operations */
315         ast_mutex_t lock;                       
316         /*! Procedure causing blocking */
317         const char *blockproc;                  
318
319         /*! Current application */
320         char *appl;                             
321         /*! Data passed to current application */
322         char *data;                             
323         
324         /*! Which fd had an event detected on */
325         int fdno;                               
326         /*! Schedule context */
327         struct sched_context *sched;            
328         /*! For streaming playback, the schedule ID */
329         int streamid;                           
330         /*! Stream itself. */
331         struct ast_filestream *stream;          
332         /*! For streaming video playback, the schedule ID */
333         int vstreamid;                          
334         /*! Video Stream itself. */
335         struct ast_filestream *vstream;         
336         /*! Original writer format */
337         int oldwriteformat;                     
338         
339         /*! Timing fd */
340         int timingfd;
341         int (*timingfunc)(void *data);
342         void *timingdata;
343
344         /*! State of line -- Don't write directly, use ast_setstate */
345         int _state;                             
346         /*! Number of rings so far */
347         int rings;                              
348
349         /*! Kinds of data this channel can natively handle */
350         int nativeformats;                      
351         /*! Requested read format */
352         int readformat;                         
353         /*! Requested write format */
354         int writeformat;                        
355
356         struct ast_callerid cid;
357                 
358         /*! Current extension context */
359         char context[AST_MAX_CONTEXT];
360         /*! Current non-macro context */
361         char macrocontext[AST_MAX_CONTEXT];     
362         /*! Current non-macro extension */
363         char macroexten[AST_MAX_EXTENSION];
364         /*! Current non-macro priority */
365         int macropriority;
366         /*! Current extension number */
367         char exten[AST_MAX_EXTENSION];          
368         /* Current extension priority */
369         int priority;                                           
370         /*! Any/all queued DTMF characters */
371         char dtmfq[AST_MAX_EXTENSION];          
372         /*! DTMF frame */
373         struct ast_frame dtmff;                 
374
375         /*! PBX private structure */
376         struct ast_pbx *pbx;
377         /*! Set BEFORE PBX is started to determine AMA flags */
378         int amaflags;                   
379         /*! Call Detail Record */
380         struct ast_cdr *cdr;                    
381         /*! Whether or not ADSI is detected on CPE */
382         int adsicpe;
383
384         /*! Tone zone as set in indications.conf */
385         struct tone_zone *zone;
386
387         /* Channel monitoring */
388         struct ast_channel_monitor *monitor;
389
390         /*! Track the read/written samples for monitor use */
391         unsigned long insmpl;
392         unsigned long outsmpl;
393
394         /* Frames in/out counters */
395         unsigned int fin;
396         unsigned int fout;
397
398         /* Unique Channel Identifier */
399         char uniqueid[32];
400
401         /* Why is the channel hanged up */
402         int hangupcause;
403         
404         /* A linked list for variables */
405         struct varshead varshead;
406
407         unsigned int callgroup;
408         unsigned int pickupgroup;
409
410         /*! channel flags of AST_FLAG_ type */
411         unsigned int flags;
412         
413         /*! ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
414         unsigned short transfercapability;
415
416         struct ast_frame *readq;
417         int alertpipe[2];
418         /*! Write translation path */
419         struct ast_trans_pvt *writetrans;
420         /*! Read translation path */
421         struct ast_trans_pvt *readtrans;
422         /*! Raw read format */
423         int rawreadformat;
424         /*! Raw write format */
425         int rawwriteformat;
426
427         /*! Chan Spy stuff */
428         struct ast_channel_spy_list *spies;
429
430         /*! For easy linking */
431         AST_LIST_ENTRY(ast_channel) list;
432 };
433
434 /* \defgroup chanprop Channel tech properties:
435         \brief Channels have this property if they can accept input with jitter; i.e. most VoIP channels */
436 /* @{ */
437 #define AST_CHAN_TP_WANTSJITTER (1 << 0)        
438
439 /* This flag has been deprecated by the transfercapbilty data member in struct ast_channel */
440 /* #define AST_FLAG_DIGITAL     (1 << 0) */     /* if the call is a digital ISDN call */
441 #define AST_FLAG_DEFER_DTMF     (1 << 1)        /*!< if dtmf should be deferred */
442 #define AST_FLAG_WRITE_INT      (1 << 2)        /*!< if write should be interrupt generator */
443 #define AST_FLAG_BLOCKING       (1 << 3)        /*!< if we are blocking */
444 #define AST_FLAG_ZOMBIE         (1 << 4)        /*!< if we are a zombie */
445 #define AST_FLAG_EXCEPTION      (1 << 5)        /*!< if there is a pending exception */
446 #define AST_FLAG_MOH            (1 << 6)        /*!< XXX anthm promises me this will disappear XXX listening to moh */
447 #define AST_FLAG_SPYING         (1 << 7)        /*!< XXX might also go away XXX is spying on someone */
448 #define AST_FLAG_NBRIDGE        (1 << 8)        /*!< is it in a native bridge */
449 #define AST_FLAG_IN_AUTOLOOP    (1 << 9)        /*!< the channel is in an auto-incrementing dialplan processor,
450                                                    so when ->priority is set, it will get incremented before
451                                                    finding the next priority to run
452                                                 */
453 /* @} */
454
455 #define AST_FEATURE_PLAY_WARNING        (1 << 0)
456 #define AST_FEATURE_REDIRECT            (1 << 1)
457 #define AST_FEATURE_DISCONNECT          (1 << 2)
458 #define AST_FEATURE_ATXFER              (1 << 3)
459 #define AST_FEATURE_AUTOMON             (1 << 4)
460
461 #define AST_FEATURE_FLAG_NEEDSDTMF      (1 << 0)
462 #define AST_FEATURE_FLAG_CALLEE         (1 << 1)
463 #define AST_FEATURE_FLAG_CALLER         (1 << 2)
464
465 struct ast_bridge_config {
466         struct ast_flags features_caller;
467         struct ast_flags features_callee;
468         struct timeval start_time;
469         long feature_timer;
470         long timelimit;
471         long play_warning;
472         long warning_freq;
473         const char *warning_sound;
474         const char *end_sound;
475         const char *start_sound;
476         int firstpass;
477         unsigned int flags;
478 };
479
480 struct chanmon;
481
482 #define LOAD_OH(oh) {   \
483         oh.context = context; \
484         oh.exten = exten; \
485         oh.priority = priority; \
486         oh.cid_num = cid_num; \
487         oh.cid_name = cid_name; \
488         oh.account = account; \
489         oh.vars = vars; \
490         oh.parent_channel = NULL; \
491
492
493 struct outgoing_helper {
494         const char *context;
495         const char *exten;
496         int priority;
497         const char *cid_num;
498         const char *cid_name;
499         const char *account;
500         struct ast_variable *vars;
501         struct ast_channel *parent_channel;
502 };
503
504 #define AST_CDR_TRANSFER        (1 << 0)
505 #define AST_CDR_FORWARD         (1 << 1)
506 #define AST_CDR_CALLWAIT        (1 << 2)
507 #define AST_CDR_CONFERENCE      (1 << 3)
508
509 #define AST_ADSI_UNKNOWN        (0)
510 #define AST_ADSI_AVAILABLE      (1)
511 #define AST_ADSI_UNAVAILABLE    (2)
512 #define AST_ADSI_OFFHOOKONLY    (3)
513
514 #define AST_SOFTHANGUP_DEV              (1 << 0)        /*!< Soft hangup by device */
515 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /*!< Soft hangup for async goto */
516 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
517 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
518 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
519 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
520 #define AST_SOFTHANGUP_UNBRIDGE     (1 << 6)
521
522
523 /*! \defgroup ChanState Channel states
524 \brief Bits 0-15 of state are reserved for the state (up/down) of the line */
525 /*! @{ */
526 /*! Channel is down and available */
527 #define AST_STATE_DOWN          0               
528 /*! Channel is down, but reserved */
529 #define AST_STATE_RESERVED      1               
530 /*! Channel is off hook */
531 #define AST_STATE_OFFHOOK       2               
532 /*! Digits (or equivalent) have been dialed */
533 #define AST_STATE_DIALING       3               
534 /*! Line is ringing */
535 #define AST_STATE_RING          4               
536 /*! Remote end is ringing */
537 #define AST_STATE_RINGING       5               
538 /*! Line is up */
539 #define AST_STATE_UP            6               
540 /*! Line is busy */
541 #define AST_STATE_BUSY          7               
542 /*! Digits (or equivalent) have been dialed while offhook */
543 #define AST_STATE_DIALING_OFFHOOK       8
544 /*! Channel has detected an incoming call and is waiting for ring */
545 #define AST_STATE_PRERING       9
546
547 /* Bits 16-32 of state are reserved for flags (See \ref ChanState ) */
548 /*! Do not transmit voice data */
549 #define AST_STATE_MUTE          (1 << 16)       
550 /*! @} */
551
552 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
553 enum channelreloadreason {
554         CHANNEL_MODULE_LOAD,
555         CHANNEL_MODULE_RELOAD,
556         CHANNEL_CLI_RELOAD,
557         CHANNEL_MANAGER_RELOAD,
558 };
559
560 /*! \brief Change the state of a channel */
561 int ast_setstate(struct ast_channel *chan, int state);
562
563 /*! \brief Create a channel structure 
564     \return Returns NULL on failure to allocate.
565         \note New channels are 
566         by default set to the "default" context and
567         extension "s"
568  */
569 struct ast_channel *ast_channel_alloc(int needalertpipe);
570
571 /*! \brief Queue an outgoing frame */
572 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
573
574 /*! \brief Queue a hangup frame */
575 int ast_queue_hangup(struct ast_channel *chan);
576
577 /*! \brief Queue a control frame */
578 int ast_queue_control(struct ast_channel *chan, int control);
579
580
581 /*! \brief Change channel name */
582 void ast_change_name(struct ast_channel *chan, char *newname);
583
584 /*! \brief Free a channel structure */
585 void  ast_channel_free(struct ast_channel *);
586
587 /*! \brief Requests a channel 
588  * \param type type of channel to request
589  * \param format requested channel format
590  * \param data data to pass to the channel requester
591  * \param status status
592  * Request a channel of a given type, with data as optional information used 
593  * by the low level module
594  * \return Returns an ast_channel on success, NULL on failure.
595  */
596 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
597
598 /*!
599  * \brief Request a channel of a given type, with data as optional information used 
600  * by the low level module and attempt to place a call on it
601  * \param type type of channel to request
602  * \param format requested channel format
603  * \param data data to pass to the channel requester
604  * \param timeout maximum amount of time to wait for an answer
605  * \param reason why unsuccessful (if unsuceessful)
606  * \param cidnum Caller-ID Number
607  * \param cidname Caller-ID Name
608  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
609  * to know if the call was answered or not.
610  */
611 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname);
612
613 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname, struct outgoing_helper *oh);
614
615 /*!\brief Register a channel technology (a new channel driver)
616  * Called by a channel module to register the kind of channels it supports.
617  * \param tech Structure defining channel technology or "type"
618  * \return Returns 0 on success, -1 on failure.
619  */
620 int ast_channel_register(const struct ast_channel_tech *tech);
621
622 /*! \brief Unregister a channel technology 
623  * \param tech Structure defining channel technology or "type" that was previously registered
624  * \return No return value.
625  */
626 void ast_channel_unregister(const struct ast_channel_tech *tech);
627
628 /*! \brief Get a channel technology structure by name
629  * \param name name of technology to find
630  * \return a pointer to the structure, or NULL if no matching technology found
631  */
632 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
633
634 /*! \brief Hang up a channel  
635  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
636  * performs all stream stopping, etc, on the channel that needs to end.
637  * chan is no longer valid after this call.
638  * \param chan channel to hang up
639  * \return Returns 0 on success, -1 on failure.
640  */
641 int ast_hangup(struct ast_channel *chan);
642
643 /*! \brief Softly hangup up a channel 
644  * \param chan channel to be soft-hung-up
645  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
646  * safely hangup a channel managed by another thread.
647  * \param cause Ast hangupcause for hangup
648  * \return Returns 0 regardless
649  */
650 int ast_softhangup(struct ast_channel *chan, int cause);
651
652 /*! \brief Softly hangup up a channel (no channel lock) 
653  * \param chan channel to be soft-hung-up
654  * \param cause Ast hangupcause for hangup (see cause.h) */
655 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
656
657 /*! \brief Check to see if a channel is needing hang up 
658  * \param chan channel on which to check for hang up
659  * This function determines if the channel is being requested to be hung up.
660  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
661  */
662 int ast_check_hangup(struct ast_channel *chan);
663
664 /*! \brief Compare a offset with the settings of when to hang a channel up 
665  * \param chan channel on which to check for hang up
666  * \param offset offset in seconds from current time
667  * \return 1, 0, or -1
668  * This function compares a offset from current time with the absolute time 
669  * out on a channel (when to hang up). If the absolute time out on a channel
670  * is earlier than current time plus the offset, it returns 1, if the two
671  * time values are equal, it return 0, otherwise, it retturn -1.
672  */
673 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset);
674
675 /*! \brief Set when to hang a channel up 
676  * \param chan channel on which to check for hang up
677  * \param offset offset in seconds from current time of when to hang up
678  * This function sets the absolute time out on a channel (when to hang up).
679  */
680 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
681
682 /*! \brief Answer a ringing call 
683  * \param chan channel to answer
684  * This function answers a channel and handles all necessary call
685  * setup functions.
686  * \return Returns 0 on success, -1 on failure
687  */
688 int ast_answer(struct ast_channel *chan);
689
690 /*! \brief Make a call 
691  * \param chan which channel to make the call on
692  * \param addr destination of the call
693  * \param timeout time to wait on for connect
694  * Place a call, take no longer than timeout ms. 
695    \return Returns -1 on failure, 0 on not enough time 
696    (does not automatically stop ringing), and  
697    the number of seconds the connect took otherwise.
698    */
699 int ast_call(struct ast_channel *chan, char *addr, int timeout);
700
701 /*! \brief Indicates condition of channel 
702  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
703  * \param chan channel to change the indication
704  * \param condition which condition to indicate on the channel
705  * \return Returns 0 on success, -1 on failure
706  */
707 int ast_indicate(struct ast_channel *chan, int condition);
708
709 /* Misc stuff ------------------------------------------------ */
710
711 /*! \brief Wait for input on a channel 
712  * \param chan channel to wait on
713  * \param ms length of time to wait on the channel
714  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
715   \return Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
716 int ast_waitfor(struct ast_channel *chan, int ms);
717
718 /*! \brief Wait for a specied amount of time, looking for hangups 
719  * \param chan channel to wait for
720  * \param ms length of time in milliseconds to sleep
721  * Waits for a specified amount of time, servicing the channel as required.
722  * \return returns -1 on hangup, otherwise 0.
723  */
724 int ast_safe_sleep(struct ast_channel *chan, int ms);
725
726 /*! \brief Wait for a specied amount of time, looking for hangups and a condition argument 
727  * \param chan channel to wait for
728  * \param ms length of time in milliseconds to sleep
729  * \param cond a function pointer for testing continue condition
730  * \param data argument to be passed to the condition test function
731  * \return returns -1 on hangup, otherwise 0.
732  * Waits for a specified amount of time, servicing the channel as required. If cond
733  * returns 0, this function returns.
734  */
735 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
736
737 /*! \brief Waits for activity on a group of channels 
738  * \param chan an array of pointers to channels
739  * \param n number of channels that are to be waited upon
740  * \param fds an array of fds to wait upon
741  * \param nfds the number of fds to wait upon
742  * \param exception exception flag
743  * \param outfd fd that had activity on it
744  * \param ms how long the wait was
745  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
746    file descriptors.
747    \return Returns the channel with activity, or NULL on error or if an FD
748    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
749    will be -1 */
750 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
751
752 /*! Waits for input on a group of channels */
753 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
754    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
755 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
756
757 /*! Waits for input on an fd */
758 /*! This version works on fd's only.  Be careful with it. */
759 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
760
761
762 /*! Reads a frame */
763 /*!
764  * \param chan channel to read a frame from
765  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
766    best just stop reading frames and assume the channel has been
767    disconnected. */
768 struct ast_frame *ast_read(struct ast_channel *chan);
769
770 /*! Reads a frame, returning AST_FRAME_NULL frame if audio. */
771 /*!
772  * \param chan channel to read a frame from
773  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
774    best just stop reading frames and assume the channel has been
775    disconnected.  Audio is replaced with AST_FRAME_NULL to avoid 
776    transcode when the resulting audio is not necessary. */
777 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
778
779 /*! Write a frame to a channel */
780 /*!
781  * \param chan destination channel of the frame
782  * \param frame frame that will be written
783  * This function writes the given frame to the indicated channel.
784  * It returns 0 on success, -1 on failure.
785  */
786 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
787
788 /*! Write video frame to a channel */
789 /*!
790  * \param chan destination channel of the frame
791  * \param frame frame that will be written
792  * This function writes the given frame to the indicated channel.
793  * It returns 1 on success, 0 if not implemented, and -1 on failure.
794  */
795 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
796
797 /* Send empty audio to prime a channel driver */
798 int ast_prod(struct ast_channel *chan);
799
800 /*! Sets read format on channel chan */
801 /*! 
802  * \param chan channel to change
803  * \param format format to change to
804  * Set read format for channel to whichever component of "format" is best. 
805  * Returns 0 on success, -1 on failure
806  */
807 int ast_set_read_format(struct ast_channel *chan, int format);
808
809 /*! Sets write format on channel chan */
810 /*! 
811  * \param chan channel to change
812  * \param format new format for writing
813  * Set write format for channel to whichever compoent of "format" is best. 
814  * Returns 0 on success, -1 on failure
815  */
816 int ast_set_write_format(struct ast_channel *chan, int format);
817
818 /*! Sends text to a channel */
819 /*! 
820  * \param chan channel to act upon
821  * \param text string of text to send on the channel
822  * Write text to a display on a channel
823  * Returns 0 on success, -1 on failure
824  */
825 int ast_sendtext(struct ast_channel *chan, const char *text);
826
827 /*! Receives a text character from a channel */
828 /*! 
829  * \param chan channel to act upon
830  * \param timeout timeout in milliseconds (0 for infinite wait)
831  * Read a char of text from a channel
832  * Returns 0 on success, -1 on failure
833  */
834 int ast_recvchar(struct ast_channel *chan, int timeout);
835
836 /*! Send a DTMF digit to a channel */
837 /*! 
838  * \param chan channel to act upon
839  * \param digit the DTMF digit to send, encoded in ASCII
840  * Send a DTMF digit to a channel.
841  * Returns 0 on success, -1 on failure
842  */
843 int ast_senddigit(struct ast_channel *chan, char digit);
844
845 /*! Receives a text string from a channel */
846 /*! 
847  * \param chan channel to act upon
848  * \param timeout timeout in milliseconds (0 for infinite wait)
849  * \return the received text, or NULL to signify failure.
850  * Read a string of text from a channel
851  */
852 char *ast_recvtext(struct ast_channel *chan, int timeout);
853
854 /*! Browse channels in use */
855 /*! 
856  * \param prev where you want to start in the channel list
857  * Browse the channels currently in use 
858  * Returns the next channel in the list, NULL on end.
859  * If it returns a channel, that channel *has been locked*!
860  */
861 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
862
863 /*! Get channel by name (locks channel) */
864 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
865
866 /*! Get channel by name prefix (locks channel) */
867 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
868
869 /*! Get channel by name prefix (locks channel) */
870 struct ast_channel *ast_walk_channel_by_name_prefix_locked(struct ast_channel *chan, const char *name, const int namelen);
871
872 /*--- ast_get_channel_by_exten_locked: Get channel by exten (and optionally context) and lock it */
873 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
874
875 /*! Waits for a digit */
876 /*! 
877  * \param c channel to wait for a digit on
878  * \param ms how many milliseconds to wait
879  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
880 int ast_waitfordigit(struct ast_channel *c, int ms);
881
882 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
883    reading. Returns 1 if ctrlfd becomes available */
884 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
885
886 /*! Reads multiple digits */
887 /*! 
888  * \param c channel to read from
889  * \param s string to read in to.  Must be at least the size of your length
890  * \param len how many digits to read (maximum)
891  * \param timeout how long to timeout between digits
892  * \param rtimeout timeout to wait on the first digit
893  * \param enders digits to end the string
894  * Read in a digit string "s", max length "len", maximum timeout between 
895    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
896    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
897    a timeout, any digits that were read before the timeout will still be available in s.  
898    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
899 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
900 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
901
902 /*! Report DTMF on channel 0 */
903 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
904 /*! Report DTMF on channel 1 */
905 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
906 /*! Return all voice frames on channel 0 */
907 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
908 /*! Return all voice frames on channel 1 */
909 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
910 /*! Ignore all signal frames except NULL */
911 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
912
913
914 /*! Makes two channel formats compatible */
915 /*! 
916  * \param c0 first channel to make compatible
917  * \param c1 other channel to make compatible
918  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
919    and -1 if it could not be done */
920 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
921
922 /*! Bridge two channels together */
923 /*! 
924  * \param c0 first channel to bridge
925  * \param c1 second channel to bridge
926  * \param config config for the channels
927  * \param fo destination frame(?)
928  * \param rc destination channel(?)
929  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
930    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
931 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
932 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
933
934 /*! Weird function made for call transfers */
935 /*! 
936  * \param original channel to make a copy of
937  * \param clone copy of the original channel
938  * This is a very strange and freaky function used primarily for transfer.  Suppose that
939    "original" and "clone" are two channels in random situations.  This function takes
940    the guts out of "clone" and puts them into the "original" channel, then alerts the
941    channel driver of the change, asking it to fixup any private information (like the
942    p->owner pointer) that is affected by the change.  The physical layer of the original
943    channel is hung up.  */
944 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
945
946 /*! Gives the string form of a given cause code */
947 /*! 
948  * \param state cause to get the description of
949  * Give a name to a cause code
950  * Returns the text form of the binary cause code given
951  */
952 const char *ast_cause2str(int state);
953
954 /*! Gives the string form of a given channel state */
955 /*! 
956  * \param state state to get the name of
957  * Give a name to a state 
958  * Returns the text form of the binary state given
959  */
960 char *ast_state2str(int state);
961
962 /*! Gives the string form of a given transfer capability */
963 /*!
964  * \param transfercapability transfercapabilty to get the name of
965  * Give a name to a transfercapbility
966  * See above
967  * Returns the text form of the binary transfer capbility
968  */
969 char *ast_transfercapability2str(int transfercapability);
970
971 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
972    low level channel.  See frame.h for options.  Note that many channel drivers may support
973    none or a subset of those features, and you should not count on this if you want your
974    asterisk application to be portable.  They're mainly useful for tweaking performance */
975
976 /*! Sets an option on a channel */
977 /*! 
978  * \param channel channel to set options on
979  * \param option option to change
980  * \param data data specific to option
981  * \param datalen length of the data
982  * \param block blocking or not
983  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
984  * Returns 0 on success and -1 on failure
985  */
986 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
987
988 /*! Pick the best codec  */
989 /* Choose the best codec...  Uhhh...   Yah. */
990 extern int ast_best_codec(int fmts);
991
992
993 /*! Checks the value of an option */
994 /*! 
995  * Query the value of an option, optionally blocking until a reply is received
996  * Works similarly to setoption except only reads the options.
997  */
998 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
999
1000 /*! Checks for HTML support on a channel */
1001 /*! Returns 0 if channel does not support HTML or non-zero if it does */
1002 int ast_channel_supports_html(struct ast_channel *channel);
1003
1004 /*! Sends HTML on given channel */
1005 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
1006 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1007
1008 /*! Sends a URL on a given link */
1009 /*! Send URL on link.  Returns 0 on success or -1 on failure */
1010 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1011
1012 /*! Defers DTMF */
1013 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
1014    non-zero if channel was already DTMF-deferred or 0 if channel is just now
1015    being DTMF-deferred */
1016 int ast_channel_defer_dtmf(struct ast_channel *chan);
1017
1018 /*! Undeos a defer */
1019 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
1020 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1021
1022 /*! Initiate system shutdown -- prevents new channels from being allocated.
1023     If "hangup" is non-zero, all existing channels will receive soft
1024      hangups */
1025 void ast_begin_shutdown(int hangup);
1026
1027 /*! Cancels an existing shutdown and returns to normal operation */
1028 void ast_cancel_shutdown(void);
1029
1030 /*! Returns number of active/allocated channels */
1031 int ast_active_channels(void);
1032
1033 /*! Returns non-zero if Asterisk is being shut down */
1034 int ast_shutting_down(void);
1035
1036 /*! Activate a given generator */
1037 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1038
1039 /*! Deactive an active generator */
1040 void ast_deactivate_generator(struct ast_channel *chan);
1041
1042 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani);
1043
1044 /*! Start a tone going */
1045 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1046 /*! Stop a tone from playing */
1047 void ast_tonepair_stop(struct ast_channel *chan);
1048 /*! Play a tone pair for a given amount of time */
1049 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1050
1051 /*! Automatically service a channel for us... */
1052 int ast_autoservice_start(struct ast_channel *chan);
1053
1054 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
1055 int ast_autoservice_stop(struct ast_channel *chan);
1056
1057 /* If built with zaptel optimizations, force a scheduled expiration on the
1058    timer fd, at which point we call the callback function / data */
1059 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
1060
1061 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
1062    and 1 if supported and requested 
1063         \param chan current channel
1064         \param dest destination extension for transfer
1065 */
1066 int ast_transfer(struct ast_channel *chan, char *dest);
1067
1068 /*!     \brief  Start masquerading a channel
1069         XXX This is a seriously wacked out operation.  We're essentially putting the guts of
1070            the clone channel into the original channel.  Start by killing off the original
1071            channel's backend.   I'm not sure we're going to keep this function, because
1072            while the features are nice, the cost is very high in terms of pure nastiness. XXX
1073         \param chan     Channel to masquerade
1074 */
1075 int ast_do_masquerade(struct ast_channel *chan);
1076
1077 /*!     \brief Find bridged channel 
1078         \param chan Current channel
1079 */
1080 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1081
1082 /*!
1083   \brief Inherits channel variable from parent to child channel
1084   \param parent Parent channel
1085   \param child Child channel
1086
1087   Scans all channel variables in the parent channel, looking for those
1088   that should be copied into the child channel.
1089   Variables whose names begin with a single '_' are copied into the
1090   child channel with the prefix removed.
1091   Variables whose names begin with '__' are copied into the child
1092   channel with their names unchanged.
1093 */
1094 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1095
1096 /*!
1097   \brief adds a list of channel variables to a channel
1098   \param chan the channel
1099   \param vars a linked list of variables
1100
1101   Variable names can be for a regular channel variable or a dialplan function
1102   that has the ability to be written to.
1103 */
1104 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1105
1106 /*!
1107   \brief An opaque 'object' structure use by silence generators on channels.
1108  */
1109 struct ast_silence_generator;
1110
1111 /*!
1112   \brief Starts a silence generator on the given channel.
1113   \param chan The channel to generate silence on
1114   \return An ast_silence_generator pointer, or NULL if an error occurs
1115
1116   This function will cause SLINEAR silence to be generated on the supplied
1117   channel until it is disabled; if the channel cannot be put into SLINEAR
1118   mode then the function will fail.
1119
1120   The pointer returned by this function must be preserved and passed to
1121   ast_channel_stop_silence_generator when you wish to stop the silence
1122   generation.
1123  */
1124 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1125
1126 /*!
1127   \brief Stops a previously-started silence generator on the given channel.
1128   \param chan The channel to operate on
1129   \param state The ast_silence_generator pointer return by a previous call to
1130   ast_channel_start_silence_generator.
1131   \return nothing
1132
1133   This function will stop the operating silence generator and return the channel
1134   to its previous write format.
1135  */
1136 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1137
1138 /* Misc. functions below */
1139
1140 /* if fd is a valid descriptor, set *pfd with the descriptor
1141  * Return 1 (not -1!) if added, 0 otherwise (so we can add the
1142  * return value to the index into the array)
1143  */
1144 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1145 {
1146         pfd->fd = fd;
1147         pfd->events = POLLIN | POLLPRI;
1148         return fd >= 0;
1149 }
1150
1151 /* Helper function for migrating select to poll */
1152 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
1153 {
1154         int x;
1155         int dummy=0;
1156
1157         if (fd < 0)
1158                 return 0;
1159         if (!start)
1160                 start = &dummy;
1161         for (x = *start; x<max; x++)
1162                 if (pfds[x].fd == fd) {
1163                         if (x == *start)
1164                                 (*start)++;
1165                         return pfds[x].revents;
1166                 }
1167         return 0;
1168 }
1169
1170 #ifdef SOLARIS
1171 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1172 {
1173         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1174         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1175         if (tvdiff->tv_usec < 0) {
1176                 tvdiff->tv_sec --;
1177                 tvdiff->tv_usec += 1000000;
1178         }
1179
1180 }
1181 #endif
1182
1183 /*! \brief Waits for activity on a group of channels 
1184  * \param nfds the maximum number of file descriptors in the sets
1185  * \param rfds file descriptors to check for read availability
1186  * \param wfds file descriptors to check for write availability
1187  * \param efds file descriptors to check for exceptions (OOB data)
1188  * \param tvp timeout while waiting for events
1189  * This is the same as a standard select(), except it guarantees the
1190  * behaviour where the passed struct timeval is updated with how much
1191  * time was not slept while waiting for the specified events
1192  */
1193 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1194 {
1195 #ifdef __linux__
1196         return select(nfds, rfds, wfds, efds, tvp);
1197 #else
1198         if (tvp) {
1199                 struct timeval tv, tvstart, tvend, tvlen;
1200                 int res;
1201
1202                 tv = *tvp;
1203                 gettimeofday(&tvstart, NULL);
1204                 res = select(nfds, rfds, wfds, efds, tvp);
1205                 gettimeofday(&tvend, NULL);
1206                 timersub(&tvend, &tvstart, &tvlen);
1207                 timersub(&tv, &tvlen, tvp);
1208                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1209                         tvp->tv_sec = 0;
1210                         tvp->tv_usec = 0;
1211                 }
1212                 return res;
1213         }
1214         else
1215                 return select(nfds, rfds, wfds, efds, NULL);
1216 #endif
1217 }
1218
1219 #ifdef DO_CRASH
1220 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
1221 #else
1222 #define CRASH do { } while(0)
1223 #endif
1224
1225 #define CHECK_BLOCKING(c) {      \
1226                                                         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1227                                                                 ast_log(LOG_WARNING, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \
1228                                                                 CRASH; \
1229                                                         } else { \
1230                                                                 (c)->blocker = pthread_self(); \
1231                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
1232                                                                         ast_set_flag(c, AST_FLAG_BLOCKING); \
1233                                                                         } }
1234
1235 extern ast_group_t ast_get_group(char *s);
1236
1237 /*! \brief print call- and pickup groups into buffer */
1238 extern char *ast_print_group(char *buf, int buflen, ast_group_t group);
1239
1240 /*! \brief Convert enum channelreloadreason to text string for manager event
1241         \param reason   Enum channelreloadreason - reason for reload (manager, cli, start etc)
1242 */
1243 const char *channelreloadreason2txt(enum channelreloadreason reason);
1244
1245 /*! \brief return an ast_variable list of channeltypes */
1246 extern struct ast_variable *ast_channeltype_list(void);
1247
1248 #if defined(__cplusplus) || defined(c_plusplus)
1249 }
1250 #endif
1251
1252 #endif /* _ASTERISK_CHANNEL_H */