include "logger.h" and errno.h from asterisk.h - usage shows that they
[asterisk/asterisk.git] / apps / app_waitforring.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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  *
21  * \brief Wait for Ring Application
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/file.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/pbx.h"
35 #include "asterisk/module.h"
36 #include "asterisk/options.h"
37 #include "asterisk/lock.h"
38
39 static char *synopsis = "Wait for Ring Application";
40
41 static char *desc = "  WaitForRing(timeout):\n"
42 "Returns 0 after waiting at least timeout seconds. and\n"
43 "only after the next ring has completed.  Returns 0 on\n"
44 "success or -1 on hangup\n";
45
46 static char *app = "WaitForRing";
47
48
49 static int waitforring_exec(struct ast_channel *chan, void *data)
50 {
51         struct ast_frame *f;
52         int res = 0;
53         double s;
54         int ms;
55
56         if (!data || (sscanf(data, "%lg", &s) != 1)) {
57                 ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
58                 return 0;
59         }
60
61         ms = s*1000.0;
62         while(ms > 0) {
63                 ms = ast_waitfor(chan, ms);
64                 if (ms < 0) {
65                         res = ms;
66                         break;
67                 }
68                 if (ms > 0) {
69                         f = ast_read(chan);
70                         if (!f) {
71                                 res = -1;
72                                 break;
73                         }
74                         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
75                                 ast_verb(3, "Got a ring but still waiting for timeout\n");
76                         }
77                         ast_frfree(f);
78                 }
79         }
80         /* Now we're really ready for the ring */
81         if (!res) {
82                 ms = 99999999;
83                 while(ms > 0) {
84                         ms = ast_waitfor(chan, ms);
85                         if (ms < 0) {
86                                 res = ms;
87                                 break;
88                         }
89                         if (ms > 0) {
90                                 f = ast_read(chan);
91                                 if (!f) {
92                                         res = -1;
93                                         break;
94                                 }
95                                 if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
96                                         ast_verb(3, "Got a ring after the timeout\n");
97                                         ast_frfree(f);
98                                         break;
99                                 }
100                                 ast_frfree(f);
101                         }
102                 }
103         }
104
105         return res;
106 }
107
108 static int unload_module(void)
109 {
110         return ast_unregister_application(app);
111 }
112
113 static int load_module(void)
114 {
115         return ast_register_application(app, waitforring_exec, synopsis, desc);
116 }
117
118 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Waits until first ring after time");