Asterisk - The Open Source Telephony Project  GIT-master-9ed6387
Functions | Variables
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)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static int load_module (void)
 
static int unload_module (void)
 
static int waituntil_exec (struct ast_channel *chan, const char *data)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
 
static char * app = "WaitUntil"
 
static const struct ast_module_infoast_module_info = &__mod_info
 

Detailed Description

Sleep until the given epoch.

Author
Philip Prindeville phili.nosp@m.pp@r.nosp@m.edfis.nosp@m.h-so.nosp@m.lutio.nosp@m.ns.c.nosp@m.om

Definition in file app_waituntil.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 120 of file app_waituntil.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 120 of file app_waituntil.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 120 of file app_waituntil.c.

◆ load_module()

static int load_module ( void  )
static

Definition at line 115 of file app_waituntil.c.

References app, ast_register_application_xml, and waituntil_exec().

116 {
118 }
static char * app
Definition: app_waituntil.c:70
#define ast_register_application_xml(app, execute)
Register an application using XML documentation.
Definition: module.h:626
static int waituntil_exec(struct ast_channel *chan, const char *data)
Definition: app_waituntil.c:72

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 110 of file app_waituntil.c.

References app, and ast_unregister_application().

111 {
113 }
int ast_unregister_application(const char *app)
Unregister an application.
Definition: pbx_app.c:392
static char * app
Definition: app_waituntil.c:70

◆ waituntil_exec()

static int waituntil_exec ( struct ast_channel chan,
const char *  data 
)
static

Definition at line 72 of file app_waituntil.c.

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

Referenced by load_module().

73 {
74  int res;
75  double fraction;
76  long seconds;
77  struct timeval future = { 0, };
78  struct timeval now = ast_tvnow();
79  int msec;
80 
81  if (ast_strlen_zero(data)) {
82  ast_log(LOG_WARNING, "WaitUntil requires an argument(epoch)\n");
83  pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "FAILURE");
84  return 0;
85  }
86 
87  if (sscanf(data, "%30ld%30lf", &seconds, &fraction) == 0) {
88  ast_log(LOG_WARNING, "WaitUntil called with non-numeric argument\n");
89  pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "FAILURE");
90  return 0;
91  }
92 
93  future.tv_sec = seconds;
94  future.tv_usec = fraction * 1000000;
95 
96  if ((msec = ast_tvdiff_ms(future, now)) < 0) {
97  ast_log(LOG_NOTICE, "WaitUntil called in the past (now %ld, arg %ld)\n", (long)now.tv_sec, (long)future.tv_sec);
98  pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "PAST");
99  return 0;
100  }
101 
102  if ((res = ast_safe_sleep(chan, msec)))
103  pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "HANGUP");
104  else
105  pbx_builtin_setvar_helper(chan, "WAITUNTILSTATUS", "OK");
106 
107  return res;
108 }
int ast_safe_sleep(struct ast_channel *chan, int ms)
Wait for a specified amount of time, looking for hangups.
Definition: channel.c:1554
#define LOG_WARNING
Definition: logger.h:274
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:150
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:98
#define ast_log
Definition: astobj2.c:42
#define LOG_NOTICE
Definition: logger.h:263
#define ast_strlen_zero(a)
Definition: muted.c:73
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static

Definition at line 120 of file app_waituntil.c.

◆ app

char* app = "WaitUntil"
static

Definition at line 70 of file app_waituntil.c.

Referenced by load_module(), and unload_module().

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 120 of file app_waituntil.c.