func_timeout.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2006, Digium, Inc.
 *
 * Mark Spencer <[email protected]>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 *
 * \brief Channel timeout related dialplan functions
 *
 * \author Mark Spencer <[email protected]>
 * \ingroup functions
 */

/*** MODULEINFO
   <support_level>core</support_level>
 ***/

#include "asterisk.h"

#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"

/*** DOCUMENTATION
   <function name="TIMEOUT" language="en_US">
      <synopsis>
         Gets or sets timeouts on the channel. Timeout values are in seconds.
      </synopsis>
      <syntax>
         <parameter name="timeouttype" required="true">
            <para>The timeout that will be manipulated. The possible timeout types
            are: <literal>absolute</literal>, <literal>digit</literal> or
            <literal>response</literal></para>
         </parameter>
      </syntax>
      <description>
         <para>The timeouts that can be manipulated are:</para>
         <para><literal>absolute</literal>: The absolute maximum amount of time permitted for a call.
         Setting of 0 disables the timeout.</para>
         <para><literal>digit</literal>: The maximum amount of time permitted between digits when the
         user is typing in an extension.  When this timeout expires,
         after the user has started to type in an extension, the
         extension will be considered complete, and will be
         interpreted.  Note that if an extension typed in is valid,
         it will not have to timeout to be tested, so typically at
         the expiry of this timeout, the extension will be considered
         invalid (and thus control would be passed to the <literal>i</literal>
         extension, or if it doesn't exist the call would be
         terminated).  The default timeout is 5 seconds.</para>
         <para><literal>response</literal>: The maximum amount of time permitted after falling through a
         series of priorities for a channel in which the user may
         begin typing an extension.  If the user does not type an
         extension in this amount of time, control will pass to the
         <literal>t</literal> extension if it exists, and if not the call would be
         terminated.  The default timeout is 10 seconds.</para>
      </description>
   </function>
 ***/

static int timeout_read(struct ast_channel *chan, const char *cmd, char *data,
         char *buf, size_t len)
{
   struct timeval myt;

   if (!chan)
      return -1;

   if (!data) {
      ast_log(LOG_ERROR, "Must specify type of timeout to get.\n");
      return -1;
   }

   switch (*data) {
   case 'a':
   case 'A':
      if (ast_tvzero(*ast_channel_whentohangup(chan))) {
         ast_copy_string(buf, "0", len);
      } else {
         myt = ast_tvnow();
         snprintf(buf, len, "%.3f", ast_tvdiff_ms(*ast_channel_whentohangup(chan), myt) / 1000.0);
      }
      break;

   case 'r':
   case 'R':
      if (ast_channel_pbx(chan)) {
         snprintf(buf, len, "%.3f", ast_channel_pbx(chan)->rtimeoutms / 1000.0);
      }
      break;

   case 'd':
   case 'D':
      if (ast_channel_pbx(chan)) {
         snprintf(buf, len, "%.3f", ast_channel_pbx(chan)->dtimeoutms / 1000.0);
      }
      break;

   default:
      ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
      return -1;
   }

   return 0;
}

static int timeout_write(struct ast_channel *chan, const char *cmd, char *data,
          const char *value)
{
   double x = 0.0;
   long sec = 0L;
   char timestr[64];
   struct ast_tm myt;
   struct timeval when = {0,};
   int res;

   if (!chan)
      return -1;

   if (!data) {
      ast_log(LOG_ERROR, "Must specify type of timeout to set.\n");
      return -1;
   }

   if (!value)
      return -1;

   res = sscanf(value, "%30ld%30lf", &sec, &x);
   if (res == 0 || sec < 0) {
      when.tv_sec = 0;
      when.tv_usec = 0;
   } else if (res == 1) {
      when.tv_sec = sec;
   } else if (res == 2) {
      when.tv_sec = sec;
      when.tv_usec = x * 1000000;
   }

   switch (*data) {
   case 'a':
   case 'A':
      ast_channel_lock(chan);
      ast_channel_setwhentohangup_tv(chan, when);
      ast_channel_unlock(chan);
      if (VERBOSITY_ATLEAST(3)) {
         if (!ast_tvzero(*ast_channel_whentohangup(chan))) {
            when = ast_tvadd(when, ast_tvnow());
            ast_strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S.%3q %Z",
               ast_localtime(&when, &myt, NULL));
            ast_verb(3, "Channel will hangup at %s.\n", timestr);
         } else {
            ast_verb(3, "Channel hangup cancelled.\n");
         }
      }
      break;

   case 'r':
   case 'R':
      if (ast_channel_pbx(chan)) {
         ast_channel_pbx(chan)->rtimeoutms = when.tv_sec * 1000 + when.tv_usec / 1000;
         ast_verb(3, "Response timeout set to %.3f\n", ast_channel_pbx(chan)->rtimeoutms / 1000.0);
      }
      break;

   case 'd':
   case 'D':
      if (ast_channel_pbx(chan)) {
         ast_channel_pbx(chan)->dtimeoutms = when.tv_sec * 1000 + when.tv_usec / 1000;
         ast_verb(3, "Digit timeout set to %.3f\n", ast_channel_pbx(chan)->dtimeoutms / 1000.0);
      }
      break;

   default:
      ast_log(LOG_ERROR, "Unknown timeout type specified.\n");
      break;
   }

   return 0;
}

static struct ast_custom_function timeout_function = {
   .name = "TIMEOUT",
   .read = timeout_read,
   .read_max = 22,
   .write = timeout_write,
};

static int unload_module(void)
{
   return ast_custom_function_unregister(&timeout_function);
}

static int load_module(void)
{
   return ast_custom_function_register(&timeout_function);
}

AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel timeout dialplan functions");