Wed Aug 18 22:34:04 2010

Asterisk developer's documentation


app_waituntil.c File Reference

Sleep until the given epoch. More...

#include "asterisk.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"

Go to the source code of this file.

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
static int unload_module (void)
static int waituntil_exec (struct ast_channel *chan, void *data)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Wait until specified time" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, }
static char * app = "WaitUntil"
static struct ast_module_infoast_module_info = &__mod_info
static char * descrip
static char * synopsis = "Wait (sleep) until the current time is the given epoch"


Detailed Description

Sleep until the given epoch.

Author:
Philip Prindeville <philipp@redfish-solutions.com>

Definition in file app_waituntil.c.


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 95 of file app_waituntil.c.

static void __unreg_module ( void   )  [static]

Definition at line 95 of file app_waituntil.c.

static int load_module ( void   )  [static]

Definition at line 90 of file app_waituntil.c.

References ast_register_application, and waituntil_exec().

00091 {
00092    return ast_register_application(app, waituntil_exec, synopsis, descrip);
00093 }

static int unload_module ( void   )  [static]

Definition at line 85 of file app_waituntil.c.

References ast_unregister_application().

00086 {
00087    return ast_unregister_application(app);
00088 }

static int waituntil_exec ( struct ast_channel chan,
void *  data 
) [static]

Definition at line 47 of file app_waituntil.c.

References ast_log(), ast_safe_sleep(), ast_strlen_zero(), ast_tvdiff_ms(), ast_tvnow(), chan, LOG_NOTICE, LOG_WARNING, and pbx_builtin_setvar_helper().

Referenced by load_module().

00048 {
00049    int res;
00050    double fraction;
00051    long seconds;
00052    struct timeval future = { 0, };
00053    struct timeval now = ast_tvnow();
00054    int msec;
00055 
00056    if (ast_strlen_zero(data)) {
00057       ast_log(LOG_WARNING, "WaitUntil requires an argument(epoch)\n");
00058       pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "FAILURE");
00059       return 0;
00060    }
00061 
00062    if (sscanf(data, "%30ld%30lf", &seconds, &fraction) == 0) {
00063       ast_log(LOG_WARNING, "WaitUntil called with non-numeric argument\n");
00064       pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "FAILURE");
00065       return 0;
00066    }
00067 
00068    future.tv_sec = seconds;
00069    future.tv_usec = fraction * 1000000;
00070 
00071    if ((msec = ast_tvdiff_ms(future, now)) < 0) {
00072       ast_log(LOG_NOTICE, "WaitUntil called in the past (now %ld, arg %ld)\n", (long)now.tv_sec, (long)future.tv_sec);
00073       pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "PAST");
00074       return 0;
00075    }
00076 
00077    if ((res = ast_safe_sleep(chan, msec)))
00078       pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "HANGUP");
00079    else
00080       pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "OK");
00081 
00082    return res;
00083 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Wait until specified time" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, } [static]

Definition at line 95 of file app_waituntil.c.

char* app = "WaitUntil" [static]

Definition at line 37 of file app_waituntil.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 95 of file app_waituntil.c.

char* descrip [static]

Definition at line 39 of file app_waituntil.c.

char* synopsis = "Wait (sleep) until the current time is the given epoch" [static]

Definition at line 38 of file app_waituntil.c.


Generated on Wed Aug 18 22:34:04 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7