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