Skeleton application. More...

#include "asterisk.h"
#include <math.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"
#include "asterisk/config.h"
#include "asterisk/config_options.h"
#include "asterisk/say.h"
#include "asterisk/astobj2.h"
#include "asterisk/acl.h"
#include "asterisk/netsock2.h"
#include "asterisk/strings.h"
#include "asterisk/cli.h"

Include dependency graph for app_skel.c:

Go to the source code of this file.

Data Structures
struct	skel_config
	A container that holds all config-related information. More...

struct	skel_current_game
	Information about a currently running set of games. More...

struct	skel_global_config
	A structure to hold global configuration-related options. More...

struct	skel_level
	Object to hold level config information. More...

struct	skel_level_state
	A structure to maintain level state across reloads. More...

Macros
#define	LEVEL_BUCKETS 1

#define	SKEL_FORMAT "%-15.15s %-15.15s %-15.15s\n"

#define	SKEL_FORMAT "%-15.15s %-11.11s %-12.12s %-8.8s %-8.8s %-12.12s\n"

#define	SKEL_FORMAT1 "%-15.15s %-15u %-15u\n"

#define	SKEL_FORMAT1 "%-15.15s %-11u %-12u %-8u %-8u %-8f\n"

Enumerations
enum	option_args { OPTION_ARG_NUMGAMES , OPTION_ARG_ARRAY_SIZE }

enum	option_flags { OPTION_CHEAT = (1 << 0) , OPTION_NUMGAMES = (1 << 1) , OPTION_PATTERNS_DISABLED = (1 << 0) }

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

static	AO2_GLOBAL_OBJ_STATIC (globals)
	A global object container that will contain the skel_config that gets swapped out on reloads. More...

static int	app_exec (struct ast_channel chan, const char data)

struct ast_module *	AST_MODULE_SELF_SYM (void)

	CONFIG_INFO_STANDARD (cfg_info, globals, skel_config_alloc,.files=ACO_FILES(&app_skel_conf),)
	Register information about the configs being processed by this module. More...

static int	custom_bitfield_handler (const struct aco_option opt, struct ast_variable var, void *obj)
	A custom bitfield handler. More...

static char *	handle_skel_show_config (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static char *	handle_skel_show_games (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static char *	handle_skel_show_levels (struct ast_cli_entry e, int cmd, struct ast_cli_args a)

static int	load_module (void)
	Load the module. More...

static void	play_files_helper (struct ast_channel chan, const char prompts)

static int	reload_module (void)

static void *	skel_config_alloc (void)
	Allocate a skel_config to hold a snapshot of the complete results of parsing a config. More...

static void	skel_config_destructor (void *obj)

static void *	skel_find_or_create_state (const char *category)
	Look up an existing state object, or create a new one. More...

static struct skel_current_game *	skel_game_alloc (struct skel_level *level)

static void	skel_game_destructor (void *obj)

static void	skel_global_config_destructor (void *obj)

static void *	skel_level_alloc (const char *cat)
	Allocate a skel_level based on a category in a configuration file. More...

static int	skel_level_cmp (void obj, void arg, int flags)

static void	skel_level_destructor (void *obj)

static void *	skel_level_find (struct ao2_container tmp_container, const char category)
	Find a skel level in the specified container. More...

static int	skel_level_hash (const void *obj, const int flags)

static struct skel_level *	skel_state_alloc (const char *name)

static void	skel_state_destructor (void *obj)

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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, }

static char *	app = "SkelGuessNumber"

static const struct ast_app_option	app_opts [128] = { [ 'c' ] = { .flag = OPTION_CHEAT }, [ 'n' ] = { .flag = OPTION_NUMGAMES , .arg_index = OPTION_ARG_NUMGAMES + 1 }, }

struct aco_file	app_skel_conf

static const struct ast_module_info *	ast_module_info = &__mod_info

static struct ao2_container *	games
	The container of active games. More...

static struct aco_type	global_option
	An aco_type structure to link the "general" category to the skel_global_config type. More...

struct aco_type *	global_options [] = ACO_TYPES(&global_option)

static const char *	level_categories []

static struct aco_type	level_option
	An aco_type structure to link the everything but the "general" and "sounds" categories to the skel_level type. More...

struct aco_type *	level_options [] = ACO_TYPES(&level_option)

static struct ast_cli_entry	skel_cli []

static struct aco_type	sound_option
	An aco_type structure to link the "sounds" category to the skel_global_config type. More...

struct aco_type *	sound_options [] = ACO_TYPES(&sound_option)

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.

Macro Definition Documentation

◆ LEVEL_BUCKETS

#define LEVEL_BUCKETS 1

Examples: app_skel.c.

Definition at line 244 of file app_skel.c.

◆ SKEL_FORMAT [1/2]

#define SKEL_FORMAT "%-15.15s %-15.15s %-15.15s\n"

Examples: app_skel.c.

◆ SKEL_FORMAT [2/2]

#define SKEL_FORMAT "%-15.15s %-11.11s %-12.12s %-8.8s %-8.8s %-12.12s\n"

◆ SKEL_FORMAT1 [1/2]

#define SKEL_FORMAT1 "%-15.15s %-15u %-15u\n"

Examples: app_skel.c.

◆ SKEL_FORMAT1 [2/2]

#define SKEL_FORMAT1 "%-15.15s %-11u %-12u %-8u %-8u %-8f\n"

Enumeration Type Documentation

◆ option_args

enum option_args

Enumerator
OPTION_ARG_NUMGAMES
OPTION_ARG_ARRAY_SIZE

Definition at line 184 of file app_skel.c.

                 {
    OPTION_ARG_NUMGAMES,
    /* This *must* be the last value in this enum! */
    OPTION_ARG_ARRAY_SIZE,
};

◆ option_flags

enum option_flags

Enumerator
OPTION_CHEAT
OPTION_NUMGAMES
OPTION_PATTERNS_DISABLED

Definition at line 179 of file app_skel.c.

                  {
    OPTION_CHEAT    = (1 << 0),
    OPTION_NUMGAMES = (1 << 1),
};

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 817 of file app_skel.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 817 of file app_skel.c.

◆ AO2_GLOBAL_OBJ_STATIC()

static AO2_GLOBAL_OBJ_STATIC ( globals )

static

A global object container that will contain the skel_config that gets swapped out on reloads.

Examples: app_skel.c.

◆ app_exec()

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

static

Examples: app_skel.c.

Definition at line 423 of file app_skel.c.

{
    int win = 0;
    uint32_t guesses;
    RAII_VAR(struct skel_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
    RAII_VAR(struct skel_level *, level, NULL, ao2_cleanup);
    RAII_VAR(struct skel_current_game *, game, NULL, ao2_cleanup);
    char *parse, *opts[OPTION_ARG_ARRAY_SIZE];
    struct ast_flags flags;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(level);
        AST_APP_ARG(options);
    );
 
    if (!cfg) {
        ast_log(LOG_ERROR, "Couldn't access configuration data!\n");
        return -1;
    }
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "%s requires an argument (level[,options])\n", app);
        return -1;
    }
 
    /* We need to make a copy of the input string if we are going to modify it! */
    parse = ast_strdupa(data);
 
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (args.argc == 2) {
        ast_app_parse_options(app_opts, &flags, opts, args.options);
    }
 
    if (ast_strlen_zero(args.level)) {
        ast_log(LOG_ERROR, "%s requires a level argument\n", app);
        return -1;
    }
 
    if (!(level = ao2_find(cfg->levels, args.level, OBJ_KEY))) {
        ast_log(LOG_ERROR, "Unknown level: %s\n", args.level);
        return -1;
    }
 
    if (!(game = skel_game_alloc(level))) {
        return -1;
    }
 
    ao2_link(games, game);
 
    /* Use app-specified values, or the options specified in [general] if they aren't passed to the app */
    if (!ast_test_flag(&flags, OPTION_NUMGAMES) ||
            ast_strlen_zero(opts[OPTION_ARG_NUMGAMES]) ||
            ast_parse_arg(opts[OPTION_ARG_NUMGAMES], PARSE_UINT32, &game->total_games)) {
        game->total_games = cfg->global->num_games;
    }
    game->games_left = game->total_games;
    game->cheat = ast_test_flag(&flags, OPTION_CHEAT) || cfg->global->cheat;
 
    for (game->games_left = game->total_games; game->games_left; game->games_left--) {
        uint32_t num = ast_random() % level->max_num; /* random number between 0 and level->max_num */
 
        ast_debug(1, "They should totally should guess %u\n", num);
 
        /* Play the prompt */
        play_files_helper(chan, cfg->global->prompt);
        ast_say_number(chan, level->max_num, "", ast_channel_language(chan), "");
 
        for (guesses = 0; guesses < level->max_guesses; guesses++) {
            size_t buflen = log10(level->max_num) + 1;
            char buf[buflen];
            int guess;
            buf[buflen] = '\0';
 
            /* Read the number pressed */
            ast_readstring(chan, buf, buflen - 1, 2000, 10000, "");
            if (ast_parse_arg(buf, PARSE_INT32 | PARSE_IN_RANGE, &guess, 0, level->max_num)) {
                if (guesses < level->max_guesses - 1) {
                    play_files_helper(chan, cfg->global->wrong);
                }
                continue;
            }
 
            /* Inform whether the guess was right, low, or high */
            if (guess == num && !game->cheat) {
                /* win */
                win = 1;
                play_files_helper(chan, cfg->global->right);
                guesses++;
                break;
            } else if (guess < num) {
                play_files_helper(chan, cfg->global->low);
            } else {
                play_files_helper(chan, cfg->global->high);
            }
 
            if (guesses < level->max_guesses - 1) {
                play_files_helper(chan, cfg->global->wrong);
            }
        }
 
        /* Process game stats */
        ao2_lock(level->state);
        if (win) {
            ++level->state->wins;
            level->state->avg_guesses = ((level->state->wins - 1) * level->state->avg_guesses + guesses) / level->state->wins;
        } else {
            /* lose */
            level->state->losses++;
            play_files_helper(chan, cfg->global->lose);
        }
        ao2_unlock(level->state);
    }
 
    ao2_unlink(games, game);
 
    return 0;
}

References ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_link, ao2_lock, ao2_unlink, ao2_unlock, app, app_opts, args, AST_APP_ARG, ast_app_parse_options(), ast_channel_language(), ast_debug, AST_DECLARE_APP_ARGS, ast_log, ast_parse_arg(), ast_random(), ast_readstring(), ast_say_number(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, buf, ast_flags::flags, games, globals, LOG_ERROR, LOG_WARNING, NULL, OBJ_KEY, OPTION_ARG_ARRAY_SIZE, OPTION_ARG_NUMGAMES, OPTION_CHEAT, OPTION_NUMGAMES, options, PARSE_IN_RANGE, PARSE_INT32, PARSE_UINT32, play_files_helper(), RAII_VAR, and skel_game_alloc().

Referenced by load_module().

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 817 of file app_skel.c.

◆ CONFIG_INFO_STANDARD()

CONFIG_INFO_STANDARD	(	cfg_info	,
		globals	,
		skel_config_alloc	,
		.	files = `ACO_FILES(&app_skel_conf)`
	)

Register information about the configs being processed by this module.

Examples: app_skel.c.

◆ custom_bitfield_handler()

static int custom_bitfield_handler	(	const struct aco_option *	opt,
		struct ast_variable *	var,
		void *	obj
	)

static

A custom bitfield handler.

Examples: app_skel.c.

Definition at line 399 of file app_skel.c.

{
    struct skel_global_config *global = obj;
 
    if (!strcasecmp(var->name, "cheat")) {
        global->cheat = ast_true(var->value);
    } else {
        return -1;
    }
 
    return 0;
}

References ast_true(), global, and var.

Referenced by load_module().

◆ handle_skel_show_config()

static char * handle_skel_show_config	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Examples: app_skel.c.

Definition at line 639 of file app_skel.c.

{
    RAII_VAR(struct skel_config *, cfg, NULL, ao2_cleanup);
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "skel show config";
        e->usage =
            "Usage: skel show config\n"
            "       List app_skel global config\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (!(cfg = ao2_global_obj_ref(globals)) || !cfg->global) {
        return NULL;
    }
 
    ast_cli(a->fd, "games per call:  %u\n", cfg->global->num_games);
    ast_cli(a->fd, "computer cheats: %s\n", AST_CLI_YESNO(cfg->global->cheat));
    ast_cli(a->fd, "\n");
    ast_cli(a->fd, "Sounds\n");
    ast_cli(a->fd, "  prompt:      %s\n", cfg->global->prompt);
    ast_cli(a->fd, "  wrong guess: %s\n", cfg->global->wrong);
    ast_cli(a->fd, "  right guess: %s\n", cfg->global->right);
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, ao2_global_obj_ref, ast_cli(), AST_CLI_YESNO, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, globals, NULL, RAII_VAR, and ast_cli_entry::usage.

◆ handle_skel_show_games()

static char * handle_skel_show_games	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Examples: app_skel.c.

Definition at line 669 of file app_skel.c.

{
    struct ao2_iterator iter;
    struct skel_current_game *game;
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "skel show games";
        e->usage =
            "Usage: skel show games\n"
            "       List app_skel active games\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
#define SKEL_FORMAT "%-15.15s %-15.15s %-15.15s\n"
#define SKEL_FORMAT1 "%-15.15s %-15u %-15u\n"
    ast_cli(a->fd, SKEL_FORMAT, "Level", "Total Games", "Games Left");
    iter = ao2_iterator_init(games, 0);
    while ((game = ao2_iterator_next(&iter))) {
        ast_cli(a->fd, SKEL_FORMAT1, game->level_info->name, game->total_games, game->games_left);
        ao2_ref(game, -1);
    }
    ao2_iterator_destroy(&iter);
#undef SKEL_FORMAT
#undef SKEL_FORMAT1
    return CLI_SUCCESS;
}

References a, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, games, skel_current_game::games_left, skel_current_game::level_info, skel_level::name, NULL, SKEL_FORMAT, SKEL_FORMAT1, skel_current_game::total_games, and ast_cli_entry::usage.

◆ handle_skel_show_levels()

static char * handle_skel_show_levels	(	struct ast_cli_entry *	e,
		int	cmd,
		struct ast_cli_args *	a
	)

static

Examples: app_skel.c.

Definition at line 699 of file app_skel.c.

{
    RAII_VAR(struct skel_config *, cfg, NULL, ao2_cleanup);
    struct ao2_iterator iter;
    struct skel_level *level;
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "skel show levels";
        e->usage =
            "Usage: skel show levels\n"
            "       List the app_skel levels\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (!(cfg = ao2_global_obj_ref(globals)) || !cfg->levels) {
        return NULL;
    }
 
#define SKEL_FORMAT "%-15.15s %-11.11s %-12.12s %-8.8s %-8.8s %-12.12s\n"
#define SKEL_FORMAT1 "%-15.15s %-11u %-12u %-8u %-8u %-8f\n"
    ast_cli(a->fd, SKEL_FORMAT, "Name", "Max number", "Max Guesses", "Wins", "Losses", "Avg Guesses");
    iter = ao2_iterator_init(cfg->levels, 0);
    while ((level = ao2_iterator_next(&iter))) {
        ast_cli(a->fd, SKEL_FORMAT1, level->name, level->max_num, level->max_guesses, level->state->wins, level->state->losses, level->state->avg_guesses);
        ao2_ref(level, -1);
    }
    ao2_iterator_destroy(&iter);
#undef SKEL_FORMAT
#undef SKEL_FORMAT1
 
    return CLI_SUCCESS;
}

References a, ao2_cleanup, ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli(), skel_level_state::avg_guesses, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, globals, skel_level_state::losses, skel_level::max_guesses, skel_level::max_num, skel_level::name, NULL, RAII_VAR, SKEL_FORMAT, SKEL_FORMAT1, skel_level::state, ast_cli_entry::usage, and skel_level_state::wins.

◆ load_module()

static int load_module ( void )

static

Load the module.

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Examples: app_skel.c.

Definition at line 769 of file app_skel.c.

{
    if (aco_info_init(&cfg_info)) {
        goto error;
    }
 
    games = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_MUTEX, 0, NULL, NULL);
    if (!games) {
        goto error;
    }
 
    /* Global options */
    aco_option_register(&cfg_info, "games", ACO_EXACT, global_options, "3", OPT_UINT_T, 0, FLDSET(struct skel_global_config, num_games));
    aco_option_register_custom(&cfg_info, "cheat", ACO_EXACT, global_options, "no", custom_bitfield_handler, 0);
 
    /* Sound options */
    aco_option_register(&cfg_info, "prompt", ACO_EXACT, sound_options, "please-enter-your&number&queue-less-than", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, prompt));
    aco_option_register(&cfg_info, "wrong_guess", ACO_EXACT, sound_options, "vm-pls-try-again", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, wrong));
    aco_option_register(&cfg_info, "right_guess", ACO_EXACT, sound_options, "auth-thankyou", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, right));
    aco_option_register(&cfg_info, "too_high", ACO_EXACT, sound_options, "high", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, high));
    aco_option_register(&cfg_info, "too_low", ACO_EXACT, sound_options, "low", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, low));
    aco_option_register(&cfg_info, "lose", ACO_EXACT, sound_options, "vm-goodbye", OPT_STRINGFIELD_T, 0, STRFLDSET(struct skel_global_config, lose));
 
    /* Level options */
    aco_option_register(&cfg_info, "max_number", ACO_EXACT, level_options, NULL, OPT_UINT_T, 0, FLDSET(struct skel_level, max_num));
    aco_option_register(&cfg_info, "max_guesses", ACO_EXACT, level_options, NULL, OPT_UINT_T, 0, FLDSET(struct skel_level, max_guesses));
 
    if (aco_process_config(&cfg_info, 0) == ACO_PROCESS_ERROR) {
        goto error;
    }
 
    ast_cli_register_multiple(skel_cli, ARRAY_LEN(skel_cli));
    if (ast_register_application_xml(app, app_exec)) {
        goto error;
    }
    return AST_MODULE_LOAD_SUCCESS;
 
error:
    aco_info_destroy(&cfg_info);
    ao2_cleanup(games);
    return AST_MODULE_LOAD_DECLINE;
}

References ACO_EXACT, aco_info_destroy(), aco_info_init(), aco_option_register, aco_option_register_custom, aco_process_config(), ACO_PROCESS_ERROR, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_cleanup, ao2_container_alloc_list, app, app_exec(), ARRAY_LEN, ast_cli_register_multiple, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_register_application_xml, custom_bitfield_handler(), error(), FLDSET, games, global_options, level_options, NULL, OPT_STRINGFIELD_T, OPT_UINT_T, prompt, skel_cli, sound_options, and STRFLDSET.

◆ play_files_helper()

static void play_files_helper	(	struct ast_channel *	chan,
		const char *	prompts
	)

static

Examples: app_skel.c.

Definition at line 412 of file app_skel.c.

{
    char *prompt, *rest = ast_strdupa(prompts);
 
    ast_stopstream(chan);
    while ((prompt = ast_strsep(&rest, '&', AST_STRSEP_STRIP | AST_STRSEP_TRIM))
        && !ast_stream_and_wait(chan, prompt, "")) {
        ast_stopstream(chan);
    }
}

References ast_stopstream(), ast_strdupa, ast_stream_and_wait(), ast_strsep(), AST_STRSEP_STRIP, AST_STRSEP_TRIM, and prompt.

Referenced by app_exec().

◆ reload_module()

static int reload_module ( void )

static

Examples: app_skel.c.

Definition at line 741 of file app_skel.c.

{
    if (aco_process_config(&cfg_info, 1) == ACO_PROCESS_ERROR) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return 0;
}

References aco_process_config(), ACO_PROCESS_ERROR, and AST_MODULE_LOAD_DECLINE.

◆ skel_config_alloc()

static void * skel_config_alloc ( void )

static

Allocate a skel_config to hold a snapshot of the complete results of parsing a config.

Examples: app_skel.c.

Definition at line 610 of file app_skel.c.

{
    struct skel_config *cfg;
 
    if (!(cfg = ao2_alloc(sizeof(*cfg), skel_config_destructor))) {
        return NULL;
    }
 
    /* Allocate/initialize memory */
    if (!(cfg->global = ao2_alloc(sizeof(*cfg->global), skel_global_config_destructor))) {
        goto error;
    }
 
    if (ast_string_field_init(cfg->global, 128)) {
        goto error;
    }
 
    cfg->levels = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, LEVEL_BUCKETS,
        skel_level_hash, NULL, skel_level_cmp);
    if (!cfg->levels) {
        goto error;
    }
 
    return cfg;
error:
    ao2_ref(cfg, -1);
    return NULL;
}

References ao2_alloc, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_ref, ast_string_field_init, error(), skel_config::global, LEVEL_BUCKETS, skel_config::levels, NULL, skel_config_destructor(), skel_global_config_destructor(), skel_level_cmp(), and skel_level_hash().

◆ skel_config_destructor()

static void skel_config_destructor ( void * obj )

static

Examples: app_skel.c.

Definition at line 603 of file app_skel.c.

{
    struct skel_config *cfg = obj;
    ao2_cleanup(cfg->global);
    ao2_cleanup(cfg->levels);
}

References ao2_cleanup, skel_config::global, and skel_config::levels.

Referenced by skel_config_alloc().

◆ skel_find_or_create_state()

static void * skel_find_or_create_state ( const char * category )

static

Look up an existing state object, or create a new one.

Examples: app_skel.c.

Definition at line 565 of file app_skel.c.

{
    RAII_VAR(struct skel_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
    RAII_VAR(struct skel_level *, level, NULL, ao2_cleanup);
    if (!cfg || !cfg->levels || !(level = ao2_find(cfg->levels, category, OBJ_KEY))) {
        return skel_state_alloc(category);
    }
    ao2_ref(level->state, +1);
    return level->state;
}

References ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_ref, globals, NULL, OBJ_KEY, RAII_VAR, and skel_state_alloc().

Referenced by skel_level_alloc().

◆ skel_game_alloc()

static struct skel_current_game * skel_game_alloc ( struct skel_level * level )

static

Examples: app_skel.c.

Definition at line 357 of file app_skel.c.

{
    struct skel_current_game *game;
    if (!(game = ao2_alloc(sizeof(struct skel_current_game), skel_game_destructor))) {
        return NULL;
    }
    ao2_ref(level, +1);
    game->level_info = level;
    return game;
}

References ao2_alloc, ao2_ref, skel_current_game::level_info, NULL, and skel_game_destructor().

Referenced by app_exec().

◆ skel_game_destructor()

static void skel_game_destructor ( void * obj )

static

Examples: app_skel.c.

Definition at line 346 of file app_skel.c.

{
    struct skel_current_game *game = obj;
    ao2_cleanup(game->level_info);
}

References ao2_cleanup, and skel_current_game::level_info.

Referenced by skel_game_alloc().

◆ skel_global_config_destructor()

static void skel_global_config_destructor ( void * obj )

static

Examples: app_skel.c.

Definition at line 340 of file app_skel.c.

{
    struct skel_global_config *global = obj;
    ast_string_field_free_memory(global);
}

References ast_string_field_free_memory, and global.

Referenced by skel_config_alloc().

◆ skel_level_alloc()

static void * skel_level_alloc ( const char * cat )

static

Allocate a skel_level based on a category in a configuration file.

Parameters

cat	The category to base the level on

Returns: A void pointer to a newly allocated skel_level

Examples: app_skel.c.

Definition at line 576 of file app_skel.c.

{
    struct skel_level *level;
 
    if (!(level = ao2_alloc(sizeof(*level), skel_level_destructor))) {
        return NULL;
    }
 
    if (ast_string_field_init(level, 128)) {
        ao2_ref(level, -1);
        return NULL;
    }
 
    /* Since the level has state information that needs to persist between reloads,
     * it is important to handle that here in the level's allocation function.
     * If not separated out into its own object, the data would be destroyed on
     * reload. */
    if (!(level->state = skel_find_or_create_state(cat))) {
        ao2_ref(level, -1);
        return NULL;
    }
 
    ast_string_field_set(level, name, cat);
 
    return level;
}

References ao2_alloc, ao2_ref, ast_string_field_init, ast_string_field_set, name, NULL, skel_find_or_create_state(), skel_level_destructor(), and skel_level::state.

◆ skel_level_cmp()

static int skel_level_cmp	(	void *	obj,
		void *	arg,
		int	flags
	)

static

Examples: app_skel.c.

Definition at line 382 of file app_skel.c.

{
    struct skel_level *one = obj, *two = arg;
    const char *match = (flags & OBJ_KEY) ? arg : two->name;
    return strcasecmp(one->name, match) ? 0 : (CMP_MATCH | CMP_STOP);
}

References CMP_MATCH, CMP_STOP, match(), skel_level::name, and OBJ_KEY.

Referenced by skel_config_alloc().

◆ skel_level_destructor()

static void skel_level_destructor ( void * obj )

static

Examples: app_skel.c.

Definition at line 368 of file app_skel.c.

{
    struct skel_level *level = obj;
    ast_string_field_free_memory(level);
    ao2_cleanup(level->state);
}

References ao2_cleanup, ast_string_field_free_memory, and skel_level::state.

Referenced by skel_level_alloc().

◆ skel_level_find()

static void * skel_level_find	(	struct ao2_container *	tmp_container,
		const char *	category
	)

static

Find a skel level in the specified container.

Note: This function does not look for a skel_level in the active container. It is used internally by the Config Options code to check if an level has already been added to the container that will be swapped for the live container on a successful reload.

Parameters

tmp_container	A non-active container to search for a level
category	The category associated with the level to check for

Return values

non-NULL	The level from the container
NULL	The level does not exist in the container

Examples: app_skel.c.

Definition at line 552 of file app_skel.c.

{
    return ao2_find(tmp_container, category, OBJ_KEY);
}

References ao2_find, and OBJ_KEY.

◆ skel_level_hash()

static int skel_level_hash	(	const void *	obj,
		const int	flags
	)

static

Examples: app_skel.c.

Definition at line 375 of file app_skel.c.

{
    const struct skel_level *level = obj;
    const char *name = (flags & OBJ_KEY) ? obj : level->name;
    return ast_str_case_hash(name);
}

References ast_str_case_hash(), name, skel_level::name, and OBJ_KEY.

Referenced by skel_config_alloc().

◆ skel_state_alloc()

static struct skel_level * skel_state_alloc ( const char * name )

static

Examples: app_skel.c.

Definition at line 541 of file app_skel.c.

{
    struct skel_level *level;
 
    if (!(level = ao2_alloc(sizeof(*level), skel_state_destructor))) {
        return NULL;
    }
 
    return level;
}

References ao2_alloc, NULL, and skel_state_destructor().

Referenced by skel_find_or_create_state().

◆ skel_state_destructor()

static void skel_state_destructor ( void * obj )

static

Examples: app_skel.c.

Definition at line 352 of file app_skel.c.

{
    return;
}

Referenced by skel_state_alloc().

◆ unload_module()

static int unload_module ( void )

static

Examples: app_skel.c.

Definition at line 750 of file app_skel.c.

{
    ast_cli_unregister_multiple(skel_cli, ARRAY_LEN(skel_cli));
    aco_info_destroy(&cfg_info);
    ao2_global_obj_release(globals);
    ao2_cleanup(games);
    return ast_unregister_application(app);
}

References aco_info_destroy(), ao2_cleanup, ao2_global_obj_release, app, ARRAY_LEN, ast_cli_unregister_multiple(), ast_unregister_application(), games, globals, and skel_cli.

Variable Documentation

◆ __mod_info

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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, }

static

Definition at line 817 of file app_skel.c.

◆ app

char* app = "SkelGuessNumber"

static

Examples: app_skel.c.

Definition at line 177 of file app_skel.c.

Referenced by app_exec(), load_module(), and unload_module().

◆ app_opts

const struct ast_app_option app_opts[128] = { [ 'c' ] = { .flag = OPTION_CHEAT }, [ 'n' ] = { .flag = OPTION_NUMGAMES , .arg_index = OPTION_ARG_NUMGAMES + 1 }, }

static

Examples: app_skel.c.

Definition at line 193 of file app_skel.c.

Referenced by app_exec().

◆ app_skel_conf

struct aco_file app_skel_conf

Initial value:

= {
    .filename = "app_skel.conf",
    .types = ACO_TYPES(&global_option, &sound_option, &level_option),
}

Examples: app_skel.c.

Definition at line 324 of file app_skel.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 817 of file app_skel.c.

◆ games

struct ao2_container* games

static

The container of active games.

Examples: app_skel.c.

Definition at line 333 of file app_skel.c.

Referenced by app_exec(), handle_skel_show_games(), load_module(), and unload_module().

◆ global_option

struct aco_type global_option

static

An aco_type structure to link the "general" category to the skel_global_config type.

Examples: app_skel.c.

Definition at line 284 of file app_skel.c.

◆ global_options

struct aco_type* global_options[] = ACO_TYPES(&global_option)

Examples: app_skel.c.

Definition at line 292 of file app_skel.c.

Referenced by load_module().

◆ level_categories

const char* level_categories[]

static

Initial value:

= {
    "general",
    "sounds",
    NULL,
}

Examples: app_skel.c.

Definition at line 305 of file app_skel.c.

◆ level_option

struct aco_type level_option

static

An aco_type structure to link the everything but the "general" and "sounds" categories to the skel_level type.

Examples: app_skel.c.

Definition at line 312 of file app_skel.c.

◆ level_options

struct aco_type* level_options[] = ACO_TYPES(&level_option)

Examples: app_skel.c.

Definition at line 322 of file app_skel.c.

Referenced by load_module().

◆ skel_cli

struct ast_cli_entry skel_cli[]

static

Initial value:

= {
    { .handler =  handle_skel_show_config , .summary =  "Show app_skel global config options" ,},
    { .handler =  handle_skel_show_levels , .summary =  "Show app_skel levels" ,},
    { .handler =  handle_skel_show_games , .summary =  "Show app_skel active games" ,},
}

Examples: app_skel.c.

Definition at line 735 of file app_skel.c.

Referenced by load_module(), and unload_module().

◆ sound_option

struct aco_type sound_option

static

An aco_type structure to link the "sounds" category to the skel_global_config type.

Examples: app_skel.c.

Definition at line 295 of file app_skel.c.

◆ sound_options

struct aco_type* sound_options[] = ACO_TYPES(&sound_option)

Examples: app_skel.c.

Definition at line 303 of file app_skel.c.

Referenced by load_module().

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ LEVEL_BUCKETS

◆ SKEL_FORMAT [1/2]

◆ SKEL_FORMAT [2/2]

◆ SKEL_FORMAT1 [1/2]

◆ SKEL_FORMAT1 [2/2]

Enumeration Type Documentation

◆ option_args

◆ option_flags

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ AO2_GLOBAL_OBJ_STATIC()

◆ app_exec()

◆ AST_MODULE_SELF_SYM()

◆ CONFIG_INFO_STANDARD()

◆ custom_bitfield_handler()

◆ handle_skel_show_config()

◆ handle_skel_show_games()

◆ handle_skel_show_levels()

◆ load_module()

◆ play_files_helper()

◆ reload_module()

◆ skel_config_alloc()

◆ skel_config_destructor()

◆ skel_find_or_create_state()

◆ skel_game_alloc()

◆ skel_game_destructor()

◆ skel_global_config_destructor()

◆ skel_level_alloc()

◆ skel_level_cmp()

◆ skel_level_destructor()

◆ skel_level_find()

◆ skel_level_hash()

◆ skel_state_alloc()

◆ skel_state_destructor()

◆ unload_module()

Variable Documentation

◆ __mod_info

◆ app

◆ app_opts

◆ app_skel_conf

◆ ast_module_info

◆ games

◆ global_option

◆ global_options

◆ level_categories

◆ level_option

◆ level_options

◆ skel_cli

◆ sound_option

◆ sound_options