Files
asterisk/apps/app_reload.c
George Joseph 198b01c536 docs: Add version information to application and function XML elements
* 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
2025-01-23 18:11:58 +00:00

115 lines
3.2 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2021, Naveen Albert
*
* Naveen Albert <asterisk@phreaknet.org>
*
* 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 Reload Asterisk modules
*
* \author Naveen Albert <asterisk@phreaknet.org>
*
* \ingroup applications
*/
/*** MODULEINFO
<support_level>extended</support_level>
***/
#include "asterisk.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
/*** DOCUMENTATION
<application name="Reload" language="en_US">
<since>
<version>16.20.0</version>
<version>18.6.0</version>
</since>
<synopsis>
Reloads an Asterisk module, blocking the channel until the reload has completed.
</synopsis>
<syntax>
<parameter name="module" required="false">
<para>The full name(s) of the target module(s) or resource(s) to reload.
If omitted, everything will be reloaded.</para>
<para>The full names MUST be specified (e.g. <literal>chan_iax2</literal>
to reload IAX2 or <literal>pbx_config</literal> to reload the dialplan.</para>
</parameter>
</syntax>
<description>
<para>Reloads the specified (or all) Asterisk modules and reports success or failure.
Success is determined by each individual module, and if all reloads are successful,
that is considered an aggregate success. If multiple modules are specified and any
module fails, then FAILURE will be returned. It is still possible that other modules
did successfully reload, however.</para>
<para>Sets <variable>RELOADSTATUS</variable> to one of the following values:</para>
<variablelist>
<variable name="RELOADSTATUS">
<value name="SUCCESS">
Specified module(s) reloaded successfully.
</value>
<value name="FAILURE">
Some or all of the specified modules failed to reload.
</value>
</variable>
</variablelist>
</description>
</application>
***/
static char *app = "Reload";
static int reload_exec(struct ast_channel *chan, const char *data)
{
char *targets, *target = NULL;
enum ast_module_reload_result res = AST_MODULE_RELOAD_SUCCESS;
targets = ast_strdupa(data);
ast_autoservice_start(chan);
if (ast_strlen_zero(targets)) { /* Reload everything */
res = ast_module_reload(targets);
} else {
while((target = ast_strsep(&targets, ',', AST_STRSEP_ALL))) {
res |= ast_module_reload(target);
}
}
ast_autoservice_stop(chan);
if (res == AST_MODULE_RELOAD_SUCCESS) {
pbx_builtin_setvar_helper(chan, "RELOADSTATUS", "SUCCESS");
} else {
pbx_builtin_setvar_helper(chan, "RELOADSTATUS", "FAILURE");
}
return 0;
}
static int unload_module(void)
{
return ast_unregister_application(app);
}
static int load_module(void)
{
return ast_register_application_xml(app, reload_exec);
}
AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Reload module(s)");