since the module API is changing, it's a good time to const-ify the description(...
[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 <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <unistd.h>
32 #include <sys/types.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/file.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/options.h"
44 #include "asterisk/lock.h"
45
46 static char *synopsis = "Wait for Ring Application";
47
48 static char *tdesc = "Waits until first ring after time";
49
50 static char *desc = "  WaitForRing(timeout)\n"
51 "Returns 0 after waiting at least timeout seconds. and\n"
52 "only after the next ring has completed.  Returns 0 on\n"
53 "success or -1 on hangup\n";
54
55 static char *app = "WaitForRing";
56
57 LOCAL_USER_DECL;
58
59 static int waitforring_exec(struct ast_channel *chan, void *data)
60 {
61         struct localuser *u;
62         struct ast_frame *f;
63         int res = 0;
64         int ms;
65
66         if (!data || (sscanf(data, "%d", &ms) != 1)) {
67                 ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
68                 return 0;
69         }
70
71         LOCAL_USER_ADD(u);
72
73         ms *= 1000;
74         while(ms > 0) {
75                 ms = ast_waitfor(chan, ms);
76                 if (ms < 0) {
77                         res = ms;
78                         break;
79                 }
80                 if (ms > 0) {
81                         f = ast_read(chan);
82                         if (!f) {
83                                 res = -1;
84                                 break;
85                         }
86                         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
87                                 if (option_verbose > 2)
88                                         ast_verbose(VERBOSE_PREFIX_3 "Got a ring but still waiting for timeout\n");
89                         }
90                         ast_frfree(f);
91                 }
92         }
93         /* Now we're really ready for the ring */
94         if (!res) {
95                 ms = 99999999;
96                 while(ms > 0) {
97                         ms = ast_waitfor(chan, ms);
98                         if (ms < 0) {
99                                 res = ms;
100                                 break;
101                         }
102                         if (ms > 0) {
103                                 f = ast_read(chan);
104                                 if (!f) {
105                                         res = -1;
106                                         break;
107                                 }
108                                 if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
109                                         if (option_verbose > 2)
110                                                 ast_verbose(VERBOSE_PREFIX_3 "Got a ring after the timeout\n");
111                                         ast_frfree(f);
112                                         break;
113                                 }
114                                 ast_frfree(f);
115                         }
116                 }
117         }
118         LOCAL_USER_REMOVE(u);
119
120         return res;
121 }
122
123 int unload_module(void)
124 {
125         int res;
126
127         res = ast_unregister_application(app);
128
129         STANDARD_HANGUP_LOCALUSERS;
130
131         return res;     
132 }
133
134 int load_module(void)
135 {
136         return ast_register_application(app, waitforring_exec, synopsis, desc);
137 }
138
139 const char *description(void)
140 {
141         return tdesc;
142 }
143
144 int usecount(void)
145 {
146         int res;
147         STANDARD_USECOUNT(res);
148         return res;
149 }
150
151 const char *key()
152 {
153         return ASTERISK_GPL_KEY;
154 }