2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Channel timeout related dialplan functions
23 * \author Mark Spencer <markster@digium.com>
28 ASTERISK_FILE_VERSION(__FILE__
, "$Revision$")
33 #include <sys/types.h>
35 #include "asterisk/module.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/app.h"
41 #include "asterisk/options.h"
43 static int timeout_read(struct ast_channel
*chan
, char *cmd
, char *data
,
44 char *buf
, size_t len
)
49 ast_log(LOG_ERROR
, "Must specify type of timeout to get.\n");
56 if (chan
->whentohangup
== 0) {
57 ast_copy_string(buf
, "0", len
);
60 snprintf(buf
, len
, "%d", (int) (chan
->whentohangup
- myt
));
67 snprintf(buf
, len
, "%d", chan
->pbx
->rtimeout
);
74 snprintf(buf
, len
, "%d", chan
->pbx
->dtimeout
);
79 ast_log(LOG_ERROR
, "Unknown timeout type specified.\n");
86 static int timeout_write(struct ast_channel
*chan
, char *cmd
, char *data
,
94 ast_log(LOG_ERROR
, "Must specify type of timeout to set.\n");
106 ast_channel_setwhentohangup(chan
, x
);
107 if (option_verbose
> 2) {
108 if (chan
->whentohangup
) {
109 strftime(timestr
, sizeof(timestr
), "%Y-%m-%d %H:%M:%S UTC",
110 gmtime_r(&chan
->whentohangup
, &myt
));
111 ast_verbose(VERBOSE_PREFIX_3
"Channel will hangup at %s.\n",
114 ast_verbose(VERBOSE_PREFIX_3
"Channel hangup cancelled.\n");
122 chan
->pbx
->rtimeout
= x
;
123 if (option_verbose
> 2)
124 ast_verbose(VERBOSE_PREFIX_3
"Response timeout set to %d\n",
125 chan
->pbx
->rtimeout
);
132 chan
->pbx
->dtimeout
= x
;
133 if (option_verbose
> 2)
134 ast_verbose(VERBOSE_PREFIX_3
"Digit timeout set to %d\n",
135 chan
->pbx
->dtimeout
);
140 ast_log(LOG_ERROR
, "Unknown timeout type specified.\n");
147 static struct ast_custom_function timeout_function
= {
149 .synopsis
= "Gets or sets timeouts on the channel.",
150 .syntax
= "TIMEOUT(timeouttype)",
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
,
176 static int unload_module(void)
178 return ast_custom_function_unregister(&timeout_function
);
181 static int load_module(void)
183 return ast_custom_function_register(&timeout_function
);
186 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY
, "Channel timeout dialplan functions");