mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-02 19:16:15 +00:00
a80179bfe7
* Do a git blame on the embedded XML application or function element.
* From the commit hash, grab the summary line.
* Do a git log --grep <summary> to find the cherry-pick commits in all
branches that match.
* Do a git patch-id to ensure the commits are all related and didn't get
a false match on the summary.
* Do a git tag --contains <commit> to find the tags that contain each
commit.
* Weed out all tags not ..0.
* Sort and discard any .0.0 and following tags where the commit
appeared in an earlier branch.
* The result is a single tag for each branch where the application or function
was defined.
The applications and functions defined in the following files were done by
hand because the XML was extracted from the C source file relatively recently.
* channels/pjsip/dialplan_functions_doc.xml
* main/logger_doc.xml
* main/manager_doc.xml
* res/res_geolocation/geoloc_doc.xml
* res/res_stir_shaken/stir_shaken_doc.xml
(cherry picked from commit 85a4ab8390)
143 lines
3.2 KiB
C
143 lines
3.2 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.com>
|
|
*
|
|
* 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 Wait for Ring Application
|
|
*
|
|
* \author Mark Spencer <markster@digium.com>
|
|
*
|
|
* \ingroup applications
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<support_level>extended</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/lock.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="WaitForRing" language="en_US">
|
|
<since><version>1.6.2.0</version></since>
|
|
<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";
|
|
|
|
static int waitforring_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
struct ast_frame *f;
|
|
struct ast_silence_generator *silgen = NULL;
|
|
int res = 0;
|
|
double s;
|
|
int timeout_ms;
|
|
int ms;
|
|
struct timeval start = ast_tvnow();
|
|
|
|
if (!data || (sscanf(data, "%30lg", &s) != 1)) {
|
|
ast_log(LOG_WARNING, "WaitForRing requires an argument (minimum seconds)\n");
|
|
return 0;
|
|
}
|
|
|
|
if (s < 0.0) {
|
|
ast_log(LOG_WARNING, "Invalid timeout provided for WaitForRing (%lg)\n", s);
|
|
return 0;
|
|
}
|
|
|
|
if (ast_opt_transmit_silence) {
|
|
silgen = ast_channel_start_silence_generator(chan);
|
|
}
|
|
|
|
timeout_ms = s * 1000.0;
|
|
while ((ms = ast_remaining_ms(start, timeout_ms))) {
|
|
ms = ast_waitfor(chan, ms);
|
|
if (ms < 0) {
|
|
res = -1;
|
|
break;
|
|
}
|
|
if (ms > 0) {
|
|
f = ast_read(chan);
|
|
if (!f) {
|
|
res = -1;
|
|
break;
|
|
}
|
|
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);
|
|
}
|
|
}
|
|
/* Now we're really ready for the ring */
|
|
if (!res) {
|
|
for (;;) {
|
|
int wait_res = ast_waitfor(chan, -1);
|
|
if (wait_res < 0) {
|
|
res = -1;
|
|
break;
|
|
} else {
|
|
f = ast_read(chan);
|
|
if (!f) {
|
|
res = -1;
|
|
break;
|
|
}
|
|
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;
|
|
}
|
|
ast_frfree(f);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (silgen) {
|
|
ast_channel_stop_silence_generator(chan, silgen);
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
return ast_unregister_application(app);
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_register_application_xml(app, waitforring_exec);
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Waits until first ring after time");
|