apps/app_waitforring.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 Wait for Ring Application
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  *
  25  * \ingroup applications
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include "asterisk/file.h"
  33 #include "asterisk/channel.h"
  34 #include "asterisk/pbx.h"
  35 #include "asterisk/module.h"
  36 #include "asterisk/lock.h"
  37
  38 static char *synopsis = "Wait for Ring Application";
  39
  40 static char *desc = "  WaitForRing(timeout):\n"
  41 "Returns 0 after waiting at least timeout seconds. and\n"
  42 "only after the next ring has completed.  Returns 0 on\n"
  43 "success or -1 on hangup\n";
  44
  45 static char *app = "WaitForRing";
  46
  47
  48 static int waitforring_exec(struct ast_channel *chan, void *data)
  49 {
  50         struct ast_frame *f;
  51         int res = 0;
  52         double s;
  53         int ms;
  54
  55         if (!data || (sscanf(data, "%lg", &s) != 1)) {
  56                 ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
  57                 return 0;
  58         }
  59
  60         ms = s * 1000.0;
  61         while (ms > 0) {
  62                 ms = ast_waitfor(chan, ms);
  63                 if (ms < 0) {
  64                         res = ms;
  65                         break;
  66                 }
  67                 if (ms > 0) {
  68                         f = ast_read(chan);
  69                         if (!f) {
  70                                 res = -1;
  71                                 break;
  72                         }
  73                         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
  74                                 ast_verb(3, "Got a ring but still waiting for timeout\n");
  75                         }
  76                         ast_frfree(f);
  77                 }
  78         }
  79         /* Now we're really ready for the ring */
  80         if (!res) {
  81                 ms = 99999999;
  82                 while(ms > 0) {
  83                         ms = ast_waitfor(chan, ms);
  84                         if (ms < 0) {
  85                                 res = ms;
  86                                 break;
  87                         }
  88                         if (ms > 0) {
  89                                 f = ast_read(chan);
  90                                 if (!f) {
  91                                         res = -1;
  92                                         break;
  93                                 }
  94                                 if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_RING)) {
  95                                         ast_verb(3, "Got a ring after the timeout\n");
  96                                         ast_frfree(f);
  97                                         break;
  98                                 }
  99                                 ast_frfree(f);
 100                         }
 101                 }
 102         }
 103
 104         return res;
 105 }
 106
 107 static int unload_module(void)
 108 {
 109         return ast_unregister_application(app);
 110 }
 111
 112 static int load_module(void)
 113 {
 114         return ast_register_application(app, waitforring_exec, synopsis, desc);
 115 }
 116
 117 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Waits until first ring after time");