Asterisk - The Open Source Telephony Project  GIT-master-9ed6387
Functions | Variables
app_celgenuserevent.c File Reference

Generate User-Defined CEL event. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/channel.h"
#include "asterisk/cel.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 celgenuserevent_exec (struct ast_channel *chan, const char *data)
 
static int load_module (void)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Generate an User-Defined CEL event" , .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, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "cel", }
 
static char * app = "CELGenUserEvent"
 
static const struct ast_module_infoast_module_info = &__mod_info
 

Detailed Description

Generate User-Defined CEL event.

Author
Steve Murphy

Definition in file app_celgenuserevent.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 107 of file app_celgenuserevent.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 107 of file app_celgenuserevent.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 107 of file app_celgenuserevent.c.

◆ celgenuserevent_exec()

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

Definition at line 59 of file app_celgenuserevent.c.

References args, AST_APP_ARG, ast_cel_publish_event(), AST_CEL_USER_DEFINED, AST_DECLARE_APP_ARGS, ast_json_pack(), ast_json_unref(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero, NULL, parse(), RAII_VAR, and S_OR.

Referenced by load_module().

60 {
61  int res = 0;
62  char *parse;
63  RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
66  AST_APP_ARG(extra);
67  );
68 
69  if (ast_strlen_zero(data)) {
70  return 0;
71  }
72 
73  parse = ast_strdupa(data);
75 
76  blob = ast_json_pack("{s: s, s: {s: s}}",
77  "event", args.event,
78  "extra", "extra", S_OR(args.extra, ""));
79  if (!blob) {
80  return res;
81  }
83  return res;
84 }
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition: json.c:591
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
Definition: astman.c:222
const char * args
#define NULL
Definition: resample.c:96
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:851
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
#define ast_strlen_zero(a)
Definition: muted.c:73
static void parse(struct mgcp_request *req)
Definition: chan_mgcp.c:1872
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one...
Definition: strings.h:79
Abstract JSON element (object, array, string, int, ...).
a user-defined event, the event name field should be set
Definition: cel.h:69
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
void ast_cel_publish_event(struct ast_channel *chan, enum ast_cel_event_type event_type, struct ast_json *blob)
Publish a CEL event.
Definition: cel.c:1666
#define AST_APP_ARG(name)
Define an application argument.

◆ load_module()

static int load_module ( void  )
static

Definition at line 92 of file app_celgenuserevent.c.

References app, AST_MODFLAG_DEFAULT, AST_MODULE_INFO(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_MODULE_SUPPORT_CORE, ast_register_application_xml, ASTERISK_GPL_KEY, celgenuserevent_exec(), and unload_module().

93 {
95  if (res) {
97  } else {
99  }
100 }
static int celgenuserevent_exec(struct ast_channel *chan, const char *data)
static char * app
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
#define ast_register_application_xml(app, execute)
Register an application using XML documentation.
Definition: module.h:626

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 86 of file app_celgenuserevent.c.

References app, and ast_unregister_application().

Referenced by load_module().

87 {
89  return 0;
90 }
int ast_unregister_application(const char *app)
Unregister an application.
Definition: pbx_app.c:392
static char * app

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Generate an User-Defined CEL event" , .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, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .requires = "cel", }
static

Definition at line 107 of file app_celgenuserevent.c.

◆ app

char* app = "CELGenUserEvent"
static

Definition at line 57 of file app_celgenuserevent.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 107 of file app_celgenuserevent.c.