major dialplan functions update
[asterisk/asterisk.git] / funcs / func_timeout.c
index 547159e..772343a 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 1999 - 2005, Digium, Inc.
+ * Copyright (C) 1999 - 2006, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
@@ -40,16 +40,17 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/app.h"
 #include "asterisk/options.h"
 
-static char *timeout_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
+static int timeout_read(struct ast_channel *chan, char *cmd, char *data,
+                       char *buf, size_t len)
 {
        time_t myt;
 
        if (!data) {
                ast_log(LOG_ERROR, "Must specify type of timeout to get.");
-                return NULL;
+               return -1;
        }
-       
-       switch(*data) {
+
+       switch (*data) {
        case 'a':
        case 'A':
                if (chan->whentohangup == 0) {
@@ -79,10 +80,11 @@ static char *timeout_read(struct ast_channel *chan, char *cmd, char *data, char
                break;
        }
 
-       return buf;
+       return 0;
 }
 
-static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
+static int timeout_write(struct ast_channel *chan, char *cmd, char *data,
+                        const char *value)
 {
        int x;
        char timestr[64];
@@ -90,25 +92,27 @@ static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const
 
        if (!data) {
                ast_log(LOG_ERROR, "Must specify type of timeout to set.");
-               return;
+               return -1;
        }
-       
+
        if (!value)
-               return;
+               return -1;
 
        x = atoi(value);
 
-       switch(*data) {
+       switch (*data) {
        case 'a':
        case 'A':
                ast_channel_setwhentohangup(chan, x);
                if (option_verbose > 2) {
                        if (chan->whentohangup) {
-                               strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S UTC", gmtime_r(&chan->whentohangup, &myt));
-                               ast_verbose( VERBOSE_PREFIX_3 "Channel will hangup at %s.\n", timestr);
+                               strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S UTC",
+                                        gmtime_r(&chan->whentohangup, &myt));
+                               ast_verbose(VERBOSE_PREFIX_3 "Channel will hangup at %s.\n",
+                                           timestr);
                        } else {
-                               ast_verbose( VERBOSE_PREFIX_3 "Channel hangup cancelled.\n");
-                       } 
+                               ast_verbose(VERBOSE_PREFIX_3 "Channel hangup cancelled.\n");
+                       }
                }
                break;
 
@@ -117,7 +121,8 @@ static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const
                if (chan->pbx) {
                        chan->pbx->rtimeout = x;
                        if (option_verbose > 2)
-                               ast_verbose( VERBOSE_PREFIX_3 "Response timeout set to %d\n", chan->pbx->rtimeout);
+                               ast_verbose(VERBOSE_PREFIX_3 "Response timeout set to %d\n",
+                                           chan->pbx->rtimeout);
                }
                break;
 
@@ -126,7 +131,8 @@ static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const
                if (chan->pbx) {
                        chan->pbx->dtimeout = x;
                        if (option_verbose > 2)
-                               ast_verbose( VERBOSE_PREFIX_3 "Digit timeout set to %d\n", chan->pbx->dtimeout);
+                               ast_verbose(VERBOSE_PREFIX_3 "Digit timeout set to %d\n",
+                                           chan->pbx->dtimeout);
                }
                break;
 
@@ -134,35 +140,35 @@ static void timeout_write(struct ast_channel *chan, char *cmd, char *data, const
                ast_log(LOG_ERROR, "Unknown timeout type specified.");
                break;
        }
+
+       return 0;
 }
 
 static struct ast_custom_function timeout_function = {
        .name = "TIMEOUT",
        .synopsis = "Gets or sets timeouts on the channel.",
        .syntax = "TIMEOUT(timeouttype)",
-       .desc = "Gets or sets various channel timeouts. The timeouts that can be\n"
-       "manipulated are:\n"
-       "\n"
-       "absolute: The absolute maximum amount of time permitted for a call.  A\n"
-       "          setting of 0 disables the timeout.\n"
-       "\n"
-       "digit:    The maximum amount of time permitted between digits when the\n"
-       "          user is typing in an extension.  When this timeout expires,\n"
-       "          after the user has started to type in an extension, the\n"
-       "          extension will be considered complete, and will be\n"
-       "          interpreted.  Note that if an extension typed in is valid,\n"
-       "          it will not have to timeout to be tested, so typically at\n"
-       "          the expiry of this timeout, the extension will be considered\n"
-       "          invalid (and thus control would be passed to the 'i'\n"
-       "          extension, or if it doesn't exist the call would be\n"
-       "          terminated).  The default timeout is 5 seconds.\n"
-       "\n"
-       "response: The maximum amount of time permitted after falling through a\n"
-       "          series of priorities for a channel in which the user may\n"
-       "          begin typing an extension.  If the user does not type an\n"
-       "          extension in this amount of time, control will pass to the\n"
-       "          't' extension if it exists, and if not the call would be\n"
-       "          terminated.  The default timeout is 10 seconds.\n",
+       .desc =
+               "Gets or sets various channel timeouts. The timeouts that can be\n"
+               "manipulated are:\n" "\n"
+               "absolute: The absolute maximum amount of time permitted for a call.  A\n"
+               "          setting of 0 disables the timeout.\n" "\n"
+               "digit:    The maximum amount of time permitted between digits when the\n"
+               "          user is typing in an extension.  When this timeout expires,\n"
+               "          after the user has started to type in an extension, the\n"
+               "          extension will be considered complete, and will be\n"
+               "          interpreted.  Note that if an extension typed in is valid,\n"
+               "          it will not have to timeout to be tested, so typically at\n"
+               "          the expiry of this timeout, the extension will be considered\n"
+               "          invalid (and thus control would be passed to the 'i'\n"
+               "          extension, or if it doesn't exist the call would be\n"
+               "          terminated).  The default timeout is 5 seconds.\n" "\n"
+               "response: The maximum amount of time permitted after falling through a\n"
+               "          series of priorities for a channel in which the user may\n"
+               "          begin typing an extension.  If the user does not type an\n"
+               "          extension in this amount of time, control will pass to the\n"
+               "          't' extension if it exists, and if not the call would be\n"
+               "          terminated.  The default timeout is 10 seconds.\n",
        .read = timeout_read,
        .write = timeout_write,
 };
@@ -171,12 +177,12 @@ static char *tdesc = "Channel timeout dialplan functions";
 
 int unload_module(void)
 {
-        return ast_custom_function_unregister(&timeout_function);
+       return ast_custom_function_unregister(&timeout_function);
 }
 
 int load_module(void)
 {
-        return ast_custom_function_register(&timeout_function);
+       return ast_custom_function_register(&timeout_function);
 }
 
 char *description(void)
@@ -193,11 +199,3 @@ char *key()
 {
        return ASTERISK_GPL_KEY;
 }
-
-/*
-Local Variables:
-mode: C
-c-file-style: "linux"
-indent-tabs-mode: nil
-End:
-*/