Modify TIMEOUT() to be accurate down to the millisecond.
[asterisk/asterisk.git] / funcs / func_timeout.c
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  *
21  * \brief Channel timeout related dialplan functions
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  * \ingroup functions
25  */
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/module.h"
32 #include "asterisk/channel.h"
33 #include "asterisk/pbx.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/app.h"
36
37 static int timeout_read(struct ast_channel *chan, const char *cmd, char *data,
38                         char *buf, size_t len)
39 {
40         struct timeval myt;
41
42         if (!chan)
43                 return -1;
44
45         if (!data) {
46                 ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
47                 return -1;
48         }
49
50         switch (*data) {
51         case 'a':
52         case 'A':
53                 if (ast_tvzero(chan->whentohangup)) {
54                         ast_copy_string(buf, "0", len);
55                 } else {
56                         myt = ast_tvnow();
57                         snprintf(buf, len, "%.3f", ast_tvdiff_ms(myt, chan->whentohangup) / 1000.0);
58                 }
59                 break;
60
61         case 'r':
62         case 'R':
63                 if (chan->pbx) {
64                         snprintf(buf, len, "%.3f", chan->pbx->rtimeoutms / 1000.0);
65                 }
66                 break;
67
68         case 'd':
69         case 'D':
70                 if (chan->pbx) {
71                         snprintf(buf, len, "%.3f", chan->pbx->dtimeoutms / 1000.0);
72                 }
73                 break;
74
75         default:
76                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
77                 break;
78         }
79
80         return 0;
81 }
82
83 static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
84                          const char *value)
85 {
86         double x;
87         char timestr[64];
88         struct ast_tm myt;
89         struct timeval tv;
90
91         if (!chan)
92                 return -1;
93
94         if (!data) {
95                 ast_log(LOG_ERROR, "Must specify type of timeout to set.\n");
96                 return -1;
97         }
98
99         if (!value)
100                 return -1;
101
102         if ((sscanf(value, "%ld%lf", (long *)&tv.tv_sec, &x) == 0) || tv.tv_sec < 0)
103                 tv.tv_sec = 0;
104         else
105                 tv.tv_usec = x * 1000000;
106
107         switch (*data) {
108         case 'a':
109         case 'A':
110                 ast_channel_setwhentohangup_tv(chan, tv);
111                 if (VERBOSITY_ATLEAST(3)) {
112                         if (!ast_tvzero(chan->whentohangup)) {
113                                 tv = ast_tvadd(tv, ast_tvnow());
114                                 ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S.%3q %Z",
115                                         ast_localtime(&tv, &myt, NULL));
116                                 ast_verbose("Channel will hangup at %s.\n", timestr);
117                         } else {
118                                 ast_verbose("Channel hangup cancelled.\n");
119                         }
120                 }
121                 break;
122
123         case 'r':
124         case 'R':
125                 if (chan->pbx) {
126                         chan->pbx->rtimeoutms = tv.tv_sec * 1000 + tv.tv_usec / 1000.0;
127                         ast_verb(3, "Response timeout set to %.3f\n", chan->pbx->rtimeoutms / 1000.0);
128                 }
129                 break;
130
131         case 'd':
132         case 'D':
133                 if (chan->pbx) {
134                         chan->pbx->dtimeoutms = tv.tv_sec * 1000 + tv.tv_usec / 1000.0;
135                         ast_verb(3, "Digit timeout set to %.3f\n", chan->pbx->dtimeoutms / 1000.0);
136                 }
137                 break;
138
139         default:
140                 ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
141                 break;
142         }
143
144         return 0;
145 }
146
147 static struct ast_custom_function timeout_function = {
148         .name = "TIMEOUT",
149         .synopsis = "Gets or sets timeouts on the channel. Timeout values are in seconds.",
150         .syntax = "TIMEOUT(timeouttype)",
151         .desc =
152                 "Gets or sets various channel timeouts. The timeouts that can be\n"
153                 "manipulated are:\n" "\n"
154                 "absolute: The absolute maximum amount of time permitted for a call.  A\n"
155                 "          setting of 0 disables the timeout.\n" "\n"
156                 "digit:    The maximum amount of time permitted between digits when the\n"
157                 "          user is typing in an extension.  When this timeout expires,\n"
158                 "          after the user has started to type in an extension, the\n"
159                 "          extension will be considered complete, and will be\n"
160                 "          interpreted.  Note that if an extension typed in is valid,\n"
161                 "          it will not have to timeout to be tested, so typically at\n"
162                 "          the expiry of this timeout, the extension will be considered\n"
163                 "          invalid (and thus control would be passed to the 'i'\n"
164                 "          extension, or if it doesn't exist the call would be\n"
165                 "          terminated).  The default timeout is 5 seconds.\n" "\n"
166                 "response: The maximum amount of time permitted after falling through a\n"
167                 "          series of priorities for a channel in which the user may\n"
168                 "          begin typing an extension.  If the user does not type an\n"
169                 "          extension in this amount of time, control will pass to the\n"
170                 "          't' extension if it exists, and if not the call would be\n"
171                 "          terminated.  The default timeout is 10 seconds.\n",
172         .read = timeout_read,
173         .write = timeout_write,
174 };
175
176 static int unload_module(void)
177 {
178         return ast_custom_function_unregister(&timeout_function);
179 }
180
181 static int load_module(void)
182 {
183         return ast_custom_function_register(&timeout_function);
184 }
185
186 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel timeout dialplan functions");