Wed Aug 18 22:34:02 2010

Asterisk developer's documentation


app_skel.c File Reference

Skeleton application. More...

#include "asterisk.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/lock.h"
#include "asterisk/app.h"

Go to the source code of this file.

Enumerations

enum  { OPTION_A = (1 << 0), OPTION_B = (1 << 1), OPTION_C = (1 << 2) }
enum  { OPTION_ARG_B = 0, OPTION_ARG_C = 1, OPTION_ARG_ARRAY_SIZE = 2 }

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int app_exec (struct ast_channel *chan, void *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 = "Skeleton (sample) Application" , .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 = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, }
static char * app = "Skel"
static struct ast_app_option app_opts [128] = { [ 'a' ] = { .flag = OPTION_A }, [ 'b' ] = { .flag = OPTION_B , .arg_index = OPTION_ARG_B + 1 }, [ 'c' ] = { .flag = OPTION_C , .arg_index = OPTION_ARG_C + 1 },}
static struct ast_module_infoast_module_info = &__mod_info
static char * descrip
enum { ... }  option_args
enum { ... }  option_flags
static char * synopsis


Detailed Description

Skeleton application.

Author:
<Your Name Here> <<Your Email Here>> 
This is a skeleton for development of an Asterisk application

Definition in file app_skel.c.


Enumeration Type Documentation

anonymous enum

Enumerator:
OPTION_A 
OPTION_B 
OPTION_C 

Definition at line 50 of file app_skel.c.

00050      {
00051    OPTION_A = (1 << 0),
00052    OPTION_B = (1 << 1),
00053    OPTION_C = (1 << 2),
00054 } option_flags;

anonymous enum

Enumerator:
OPTION_ARG_B 
OPTION_ARG_C 
OPTION_ARG_ARRAY_SIZE 

Definition at line 56 of file app_skel.c.

00056      {
00057    OPTION_ARG_B = 0,
00058    OPTION_ARG_C = 1,
00059    /* This *must* be the last value in this enum! */
00060    OPTION_ARG_ARRAY_SIZE = 2,
00061 } option_args;


Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 121 of file app_skel.c.

static void __unreg_module ( void   )  [static]

Definition at line 121 of file app_skel.c.

static int app_exec ( struct ast_channel chan,
void *  data 
) [static]

Definition at line 70 of file app_skel.c.

References app_opts, AST_APP_ARG, ast_app_parse_options(), AST_DECLARE_APP_ARGS, ast_log(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, dummy(), ast_flags::flags, LOG_NOTICE, LOG_WARNING, OPTION_A, OPTION_ARG_ARRAY_SIZE, OPTION_ARG_B, OPTION_ARG_C, OPTION_B, OPTION_C, and parse().

00071 {
00072    int res = 0;
00073    struct ast_flags flags;
00074    char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
00075    AST_DECLARE_APP_ARGS(args,
00076       AST_APP_ARG(dummy);
00077       AST_APP_ARG(options);
00078    );
00079 
00080    if (ast_strlen_zero(data)) {
00081       ast_log(LOG_WARNING, "%s requires an argument (dummy[,options])\n", app);
00082       return -1;
00083    }
00084 
00085    /* Do our thing here */
00086 
00087    /* We need to make a copy of the input string if we are going to modify it! */
00088    parse = ast_strdupa(data);
00089 
00090    AST_STANDARD_APP_ARGS(args, parse);
00091 
00092    if (args.argc == 2)
00093       ast_app_parse_options(app_opts, &flags, opts, args.options);
00094 
00095    if (!ast_strlen_zero(args.dummy)) 
00096       ast_log(LOG_NOTICE, "Dummy value is : %s\n", args.dummy);
00097 
00098    if (ast_test_flag(&flags, OPTION_A))
00099       ast_log(LOG_NOTICE, "Option A is set\n");
00100 
00101    if (ast_test_flag(&flags, OPTION_B))
00102       ast_log(LOG_NOTICE, "Option B is set with : %s\n", opts[OPTION_ARG_B] ? opts[OPTION_ARG_B] : "<unspecified>");
00103 
00104    if (ast_test_flag(&flags, OPTION_C))
00105       ast_log(LOG_NOTICE, "Option C is set with : %s\n", opts[OPTION_ARG_C] ? opts[OPTION_ARG_C] : "<unspecified>");
00106 
00107    return res;
00108 }

static int load_module ( void   )  [static]

Definition at line 115 of file app_skel.c.

References app_exec, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, and ast_register_application.

static int unload_module ( void   )  [static]

Definition at line 110 of file app_skel.c.

References ast_unregister_application().

00111 {
00112    return ast_unregister_application(app);
00113 }


Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Skeleton (sample) Application" , .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 = "a9c98e5d177805051735cb5b0b16b0a0" , .load = load_module, .unload = unload_module, } [static]

Definition at line 121 of file app_skel.c.

char* app = "Skel" [static]

Definition at line 44 of file app_skel.c.

struct ast_app_option app_opts[128] = { [ 'a' ] = { .flag = OPTION_A }, [ 'b' ] = { .flag = OPTION_B , .arg_index = OPTION_ARG_B + 1 }, [ 'c' ] = { .flag = OPTION_C , .arg_index = OPTION_ARG_C + 1 },} [static]

Definition at line 67 of file app_skel.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 121 of file app_skel.c.

char* descrip [static]

Initial value:

 "This application is a template to build other applications from.\n"
 " It shows you the basic structure to create your own Asterisk applications.\n"

Definition at line 47 of file app_skel.c.

enum { ... } option_args

Referenced by handle_options().

enum { ... } option_flags

char* synopsis [static]

Initial value:

 
"Skeleton application."

Definition at line 45 of file app_skel.c.


Generated on Wed Aug 18 22:34:02 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7