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