update doxygen docs to specify authors
[asterisk/asterisk.git] / funcs / func_timeout.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 Channel timeout related dialplan functions
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <string.h>
29 #include <sys/types.h>
30
31 #include "asterisk.h"
32
33 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
34
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/app.h"
40 #include "asterisk/options.h"
41
42 static char *builtin_function_timeout_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
43 {
44         time_t myt;
45
46         if (!data) {
47                 ast_log(LOG_ERROR, "Must specify type of timeout to get.");
48                 return NULL;
49         }
50         
51         switch(*data) {
52         case 'a':
53         case 'A':
54                 if (chan->whentohangup == 0) {
55                         ast_copy_string(buf, "0", len);
56                 } else {
57                         time(&myt);
58                         snprintf(buf, len, "%d", (int) (chan->whentohangup - myt));
59                 }
60                 break;
61
62         case 'r':
63         case 'R':
64                 if (chan->pbx) {
65                         snprintf(buf, len, "%d", chan->pbx->rtimeout);
66                 }
67                 break;
68
69         case 'd':
70         case 'D':
71                 if (chan->pbx) {
72                         snprintf(buf, len, "%d", chan->pbx->dtimeout);
73                 }
74                 break;
75
76         default:
77                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
78                 break;
79         }
80
81         return buf;
82 }
83
84 static void builtin_function_timeout_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
85 {
86         int x;
87         char timestr[64];
88         struct tm myt;
89
90         if (!data) {
91                 ast_log(LOG_ERROR, "Must specify type of timeout to set.");
92                 return;
93         }
94         
95         if (!value)
96                 return;
97
98         x = atoi(value);
99
100         switch(*data) {
101         case 'a':
102         case 'A':
103                 ast_channel_setwhentohangup(chan, x);
104                 if (option_verbose > 2) {
105                         if (chan->whentohangup) {
106                                 strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S UTC", gmtime_r(&chan->whentohangup, &myt));
107                                 ast_verbose( VERBOSE_PREFIX_3 "Channel will hangup at %s.\n", timestr);
108                         } else {
109                                 ast_verbose( VERBOSE_PREFIX_3 "Channel hangup cancelled.\n");
110                         } 
111                 }
112                 break;
113
114         case 'r':
115         case 'R':
116                 if (chan->pbx) {
117                         chan->pbx->rtimeout = x;
118                         if (option_verbose > 2)
119                                 ast_verbose( VERBOSE_PREFIX_3 "Response timeout set to %d\n", chan->pbx->rtimeout);
120                 }
121                 break;
122
123         case 'd':
124         case 'D':
125                 if (chan->pbx) {
126                         chan->pbx->dtimeout = x;
127                         if (option_verbose > 2)
128                                 ast_verbose( VERBOSE_PREFIX_3 "Digit timeout set to %d\n", chan->pbx->dtimeout);
129                 }
130                 break;
131
132         default:
133                 ast_log(LOG_ERROR, "Unknown timeout type specified.");
134                 break;
135         }
136 }
137
138 #ifndef BUILTIN_FUNC
139 static
140 #endif
141 struct ast_custom_function timeout_function = {
142         .name = "TIMEOUT",
143         .synopsis = "Gets or sets timeouts on the channel.",
144         .syntax = "TIMEOUT(timeouttype)",
145         .desc = "Gets or sets various channel timeouts. The timeouts that can be\n"
146         "manipulated are:\n"
147         "\n"
148         "absolute: The absolute maximum amount of time permitted for a call.  A\n"
149         "          setting of 0 disables the timeout.\n"
150         "\n"
151         "digit:    The maximum amount of time permitted between digits when the\n"
152         "          user is typing in an extension.  When this timeout expires,\n"
153         "          after the user has started to type in an extension, the\n"
154         "          extension will be considered complete, and will be\n"
155         "          interpreted.  Note that if an extension typed in is valid,\n"
156         "          it will not have to timeout to be tested, so typically at\n"
157         "          the expiry of this timeout, the extension will be considered\n"
158         "          invalid (and thus control would be passed to the 'i'\n"
159         "          extension, or if it doesn't exist the call would be\n"
160         "          terminated).  The default timeout is 5 seconds.\n"
161         "\n"
162         "response: The maximum amount of time permitted after falling through a\n"
163         "          series of priorities for a channel in which the user may\n"
164         "          begin typing an extension.  If the user does not type an\n"
165         "          extension in this amount of time, control will pass to the\n"
166         "          't' extension if it exists, and if not the call would be\n"
167         "          terminated.  The default timeout is 10 seconds.\n",
168         .read = builtin_function_timeout_read,
169         .write = builtin_function_timeout_write,
170 };
171
172 /*
173 Local Variables:
174 mode: C
175 c-file-style: "linux"
176 indent-tabs-mode: nil
177 End:
178 */