Files
asterisk/apps/app_celgenuserevent.c
George Joseph a80179bfe7 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

(cherry picked from commit 85a4ab8390)
2025-01-23 18:39:42 +00:00

109 lines
2.5 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2008, Digium, Inc
*
* 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 Generate User-Defined CEL event
*
* \author Steve Murphy
*
* \ingroup applications
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/channel.h"
#include "asterisk/cel.h"
/*** DOCUMENTATION
<application name="CELGenUserEvent" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Generates a CEL User Defined Event.
</synopsis>
<syntax>
<parameter name="event-name" required="true">
<argument name="event-name" required="true">
</argument>
<argument name="extra" required="false">
<para>Extra text to be included with the event.</para>
</argument>
</parameter>
</syntax>
<description>
<para>A CEL event will be immediately generated by this channel, with the supplied name for a type.</para>
</description>
</application>
***/
static char *app = "CELGenUserEvent";
static int celgenuserevent_exec(struct ast_channel *chan, const char *data)
{
int res = 0;
char *parse;
RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
AST_DECLARE_APP_ARGS(args,
AST_APP_ARG(event);
AST_APP_ARG(extra);
);
if (ast_strlen_zero(data)) {
return 0;
}
parse = ast_strdupa(data);
AST_STANDARD_APP_ARGS(args, parse);
blob = ast_json_pack("{s: s, s: {s: s}}",
"event", args.event,
"extra", "extra", S_OR(args.extra, ""));
if (!blob) {
return res;
}
ast_cel_publish_event(chan, AST_CEL_USER_DEFINED, blob);
return res;
}
static int unload_module(void)
{
ast_unregister_application(app);
return 0;
}
static int load_module(void)
{
int res = ast_register_application_xml(app, celgenuserevent_exec);
if (res) {
return AST_MODULE_LOAD_DECLINE;
} else {
return AST_MODULE_LOAD_SUCCESS;
}
}
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Generate an User-Defined CEL event",
.support_level = AST_MODULE_SUPPORT_CORE,
.load = load_module,
.unload = unload_module,
.requires = "cel",
);