Test for Asterisk Version info
[asterisk/asterisk.git] / apps / app_waitforring.c
old mode 100755 (executable)
new mode 100644 (file)
index 93dec96..bd0353b
@@ -1,57 +1,81 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Wait for Ring Application
- * 
- * Copyright (C) 2003, Digium
+ * Copyright (C) 1999 - 2005, Digium, Inc.
+ *
+ * Mark Spencer <markster@digium.com>
  *
- * Mark Spencer <markster@linux-support.net>
+ * 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
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Wait for Ring Application
+ *
+ * \author Mark Spencer <markster@digium.com>
+ * 
+ * \ingroup applications
  */
 
-#include <sys/types.h>
+/*** MODULEINFO
+       <support_level>extended</support_level>
+ ***/
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include "asterisk/file.h"
-#include "asterisk/logger.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/module.h"
-#include "asterisk/options.h"
 #include "asterisk/lock.h"
-#include <stdlib.h>
-#include <unistd.h>
-#include <string.h>
-#include <stdlib.h>
-
-static char *synopsis = "Wait for Ring Application";
-
-static char *tdesc = "Waits until first ring after time";
 
-static char *desc = "  WaitForRing(timeout)\n"
-"Returns 0 after waiting at least timeout seconds. and\n"
-"only after the next ring has completed.  Returns 0 on\n"
-"success or -1 on hangup\n";
+/*** DOCUMENTATION
+       <application name="WaitForRing" language="en_US">
+               <synopsis>
+                       Wait for Ring Application.
+               </synopsis>
+               <syntax>
+                       <parameter name="timeout" required="true" />
+               </syntax>
+               <description>
+                       <para>Returns <literal>0</literal> after waiting at least <replaceable>timeout</replaceable> seconds,
+                       and only after the next ring has completed. Returns <literal>0</literal> on success or
+                       <literal>-1</literal> on hangup.</para>
+               </description>
+       </application>
+ ***/
 
 static char *app = "WaitForRing";
 
-STANDARD_LOCAL_USER;
-
-LOCAL_USER_DECL;
-
-static int waitforring_exec(struct ast_channel *chan, void *data)
+static int waitforring_exec(struct ast_channel *chan, const char *data)
 {
-       struct localuser *u;
        struct ast_frame *f;
+       struct ast_silence_generator *silgen = NULL;
        int res = 0;
+       double s;
        int ms;
-       if (!data || (sscanf(data, "%d", &ms) != 1)) {
-                ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
+
+       if (!data || (sscanf(data, "%30lg", &s) != 1)) {
+               ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
                return 0;
        }
-       ms *= 1000;
-       LOCAL_USER_ADD(u);
-       while(ms > 0) {
+
+       if (ast_opt_transmit_silence) {
+               silgen = ast_channel_start_silence_generator(chan);
+       }
+
+       ms = s * 1000.0;
+       while (ms > 0) {
                ms = ast_waitfor(chan, ms);
                if (ms < 0) {
                        res = ms;
@@ -63,9 +87,8 @@ static int waitforring_exec(struct ast_channel *chan, void *data)
                                res = -1;
                                break;
                        }
-                       if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
-                               if (option_verbose > 2)
-                                       ast_verbose(VERBOSE_PREFIX_3 "Got a ring but still waiting for timeout\n");
+                       if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass.integer == AST_CONTROL_RING)) {
+                               ast_verb(3, "Got a ring but still waiting for timeout\n");
                        }
                        ast_frfree(f);
                }
@@ -85,9 +108,8 @@ static int waitforring_exec(struct ast_channel *chan, void *data)
                                        res = -1;
                                        break;
                                }
-                               if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
-                                       if (option_verbose > 2)
-                                               ast_verbose(VERBOSE_PREFIX_3 "Got a ring after the timeout\n");
+                               if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass.integer == AST_CONTROL_RING)) {
+                                       ast_verb(3, "Got a ring after the timeout\n");
                                        ast_frfree(f);
                                        break;
                                }
@@ -95,35 +117,22 @@ static int waitforring_exec(struct ast_channel *chan, void *data)
                        }
                }
        }
-       LOCAL_USER_REMOVE(u);
+
+       if (silgen) {
+               ast_channel_stop_silence_generator(chan, silgen);
+       }
 
        return res;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
-       STANDARD_HANGUP_LOCALUSERS;
        return ast_unregister_application(app);
 }
 
-int load_module(void)
-{
-       return ast_register_application(app, waitforring_exec, synopsis, desc);
-}
-
-char *description(void)
+static int load_module(void)
 {
-       return tdesc;
+       return ast_register_application_xml(app, waitforring_exec);
 }
 
-int usecount(void)
-{
-       int res;
-       STANDARD_USECOUNT(res);
-       return res;
-}
-
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Waits until first ring after time");