module.h File Reference

Asterisk module definitions. More...

#include "asterisk/utils.h"

Include dependency graph for module.h:

Data Structures
struct	ast_module_info
Defines
#define	__MODULE_INFO_GLOBALS
#define	__MODULE_INFO_SECTION
#define	AST_MODULE_CONFIG "modules.conf"
	Module configuration file.
#define	AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
#define	AST_MODULE_INFO_STANDARD(keystr, desc)
#define	ast_module_user_add(chan) __ast_module_user_add(ast_module_info->self, chan)
#define	ast_module_user_hangup_all() __ast_module_user_hangup_all(ast_module_info->self)
#define	ast_module_user_remove(user) __ast_module_user_remove(ast_module_info->self, user)
#define	ast_register_application(app, execute, synopsis, description) ast_register_application2(app, execute, synopsis, description, ast_module_info->self)
	Register an application.
#define	ASTERISK_GPL_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"
	The text the key() function should return.
Enumerations
enum	ast_module_flags { AST_MODFLAG_DEFAULT = 0, AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0), AST_MODFLAG_LOAD_ORDER = (1 << 1) }
enum	ast_module_load_result { AST_MODULE_LOAD_SUCCESS = 0, AST_MODULE_LOAD_DECLINE = 1, AST_MODULE_LOAD_SKIP = 2, AST_MODULE_LOAD_PRIORITY = 3, AST_MODULE_LOAD_FAILURE = -1 }
enum	ast_module_unload_mode { AST_FORCE_SOFT = 0, AST_FORCE_FIRM = 1, AST_FORCE_HARD = 2 }
Functions
struct ast_module_user *	__ast_module_user_add (struct ast_module , struct ast_channel )
void	__ast_module_user_hangup_all (struct ast_module *)
void	__ast_module_user_remove (struct ast_module , struct ast_module_user )
enum ast_module_load_result	ast_load_resource (const char *resource_name)
	Load a module.
int	ast_loader_register (int(*updater)(void))
	Add a procedure to be run when modules have been updated.
int	ast_loader_unregister (int(*updater)(void))
	Remove a procedure to be run when modules are updated.
int	ast_module_check (const char *name)
	Check if module with the name given is loaded.
char *	ast_module_helper (const char line, const char word, int pos, int state, int rpos, int needsreload)
	Match modules names for the Asterisk cli.
struct ast_module *	ast_module_ref (struct ast_module *)
void	ast_module_register (const struct ast_module_info *)
void	ast_module_shutdown (void)
	Run the unload() callback for all loaded modules.
void	ast_module_unref (struct ast_module *)
void	ast_module_unregister (const struct ast_module_info *)
int	ast_register_application2 (const char app, int(execute)(struct ast_channel , void ), const char synopsis, const char description, void *mod)
	Register an application.
int	ast_unload_resource (const char *resource_name, enum ast_module_unload_mode)
	Unload a module.
int	ast_unregister_application (const char *app)
	Unregister an application.
int	ast_update_module_list (int(modentry)(const char module, const char description, int usecnt, const char like), const char *like)
	Ask for a list of modules, descriptions, and use counts.
void	ast_update_use_count (void)
	Notify when usecount has been changed.
Variables
static struct ast_module_info *	ast_module_info

Detailed Description

Asterisk module definitions.

This file contains the definitons for functions Asterisk modules should provide and some other module related functions.

Definition in file module.h.

Define Documentation

#define __MODULE_INFO_GLOBALS

Definition at line 287 of file module.h.

#define __MODULE_INFO_SECTION

Definition at line 286 of file module.h.

#define AST_MODULE_CONFIG "modules.conf"

Module configuration file.

Definition at line 51 of file module.h.

Referenced by load_modules().

#define AST_MODULE_INFO	(	keystr,
		flags_to_set,
		desc,
		fields...	)

Definition at line 344 of file module.h.

#define AST_MODULE_INFO_STANDARD	(	keystr,
		desc		)

Value:

AST_MODULE_INFO(keystr, AST_MODFLAG_DEFAULT, desc, \
         .load = load_module,       \
         .unload = unload_module,      \
             )

Definition at line 366 of file module.h.

#define ast_module_user_add ( chan ) __ast_module_user_add(ast_module_info->self, chan)

Definition at line 240 of file module.h.

Referenced by canmatch(), dundi_query_read(), dundi_result_read(), dundifunc_read(), exec(), exists(), local_new(), login_exec(), matchmore(), nbs_new(), smdi_msg_read(), and smdi_msg_retrieve_read().

#define ast_module_user_hangup_all ( ) __ast_module_user_hangup_all(ast_module_info->self)

Definition at line 242 of file module.h.

Referenced by unload_module().

#define ast_module_user_remove ( user ) __ast_module_user_remove(ast_module_info->self, user)

Definition at line 241 of file module.h.

Referenced by canmatch(), dundi_query_read(), dundi_result_read(), dundifunc_read(), exec(), exists(), local_hangup(), login_exec(), matchmore(), nbs_destroy(), smdi_msg_read(), and smdi_msg_retrieve_read().

#define ast_register_application	(	app,
		execute,
		synopsis,
		description	)	ast_register_application2(app, execute, synopsis, description, ast_module_info->self)

Register an application.

Parameters:

	app	Short name of the application
	execute	a function callback to execute the application. It should return non-zero if the channel needs to be hung up.
	synopsis	a short description (one line synopsis) of the application
	description	long description with all of the details about the use of the application

This registers an application with Asterisk's internal application list.

Note:: The individual applications themselves are responsible for registering and unregistering and unregistering their own CLI commands.

Return values:

	0	success
	-1	failure.

Definition at line 390 of file module.h.

Referenced by load_module().

#define ASTERISK_GPL_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"

The text the key() function should return.

Definition at line 38 of file module.h.

Enumeration Type Documentation

enum ast_module_flags

Enumerator:

AST_MODFLAG_DEFAULT
AST_MODFLAG_GLOBAL_SYMBOLS
AST_MODFLAG_LOAD_ORDER

Definition at line 190 of file module.h.

00190                       {
00191    AST_MODFLAG_DEFAULT = 0,
00192    AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00193    AST_MODFLAG_LOAD_ORDER = (1 << 1),
00194 };

enum ast_module_load_result

Enumerator:

AST_MODULE_LOAD_SUCCESS	Module loaded and configured
AST_MODULE_LOAD_DECLINE	Module is not configured
AST_MODULE_LOAD_SKIP	Module was skipped for some reason
AST_MODULE_LOAD_PRIORITY	Module is not loaded yet, but is added to prioity heap
AST_MODULE_LOAD_FAILURE	Module could not be loaded properly

Definition at line 60 of file module.h.

00060                             {
00061    AST_MODULE_LOAD_SUCCESS = 0,    /*!< Module loaded and configured */
00062    AST_MODULE_LOAD_DECLINE = 1,    /*!< Module is not configured */
00063    AST_MODULE_LOAD_SKIP = 2,       /*!< Module was skipped for some reason */
00064    AST_MODULE_LOAD_PRIORITY = 3,   /*!< Module is not loaded yet, but is added to prioity heap */
00065    AST_MODULE_LOAD_FAILURE = -1,   /*!< Module could not be loaded properly */
00066 };

enum ast_module_unload_mode

Enumerator:

AST_FORCE_SOFT	Softly unload a module, only if not in use
AST_FORCE_FIRM	Firmly unload a module, even if in use
AST_FORCE_HARD	as FIRM, plus dlclose() on the module. Not recommended as it may cause crashes

Definition at line 53 of file module.h.

00053                             {
00054    AST_FORCE_SOFT = 0, /*!< Softly unload a module, only if not in use */
00055    AST_FORCE_FIRM = 1, /*!< Firmly unload a module, even if in use */
00056    AST_FORCE_HARD = 2, /*!< as FIRM, plus dlclose() on the module. Not recommended
00057             as it may cause crashes */
00058 };

Function Documentation

struct ast_module_user* __ast_module_user_add	(	struct ast_module *	,
		struct ast_channel *
	)			`[read]`

Definition at line 195 of file loader.c.

References ast_atomic_fetchadd_int(), ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_update_use_count(), ast_module_user::chan, ast_module::usecount, and ast_module::users.

Referenced by ast_func_read(), ast_func_write(), and pbx_exec().

00197 {
00198    struct ast_module_user *u = ast_calloc(1, sizeof(*u));
00199 
00200    if (!u)
00201       return NULL;
00202 
00203    u->chan = chan;
00204 
00205    AST_LIST_LOCK(&mod->users);
00206    AST_LIST_INSERT_HEAD(&mod->users, u, entry);
00207    AST_LIST_UNLOCK(&mod->users);
00208 
00209    ast_atomic_fetchadd_int(&mod->usecount, +1);
00210 
00211    ast_update_use_count();
00212 
00213    return u;
00214 }

void __ast_module_user_hangup_all ( struct ast_module * )

Definition at line 227 of file loader.c.

References ast_atomic_fetchadd_int(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_softhangup(), AST_SOFTHANGUP_APPUNLOAD, ast_update_use_count(), ast_module_user::chan, ast_module::usecount, and ast_module::users.

Referenced by ast_unload_resource().

00228 {
00229    struct ast_module_user *u;
00230 
00231    AST_LIST_LOCK(&mod->users);
00232    while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
00233       ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
00234       ast_atomic_fetchadd_int(&mod->usecount, -1);
00235       ast_free(u);
00236    }
00237    AST_LIST_UNLOCK(&mod->users);
00238 
00239    ast_update_use_count();
00240 }

void __ast_module_user_remove	(	struct ast_module *	,
		struct ast_module_user *
	)

Definition at line 216 of file loader.c.

References ast_atomic_fetchadd_int(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, ast_update_use_count(), ast_module::usecount, and ast_module::users.

Referenced by ast_func_read(), ast_func_write(), and pbx_exec().

00217 {
00218    AST_LIST_LOCK(&mod->users);
00219    AST_LIST_REMOVE(&mod->users, u, entry);
00220    AST_LIST_UNLOCK(&mod->users);
00221    ast_atomic_fetchadd_int(&mod->usecount, -1);
00222    ast_free(u);
00223 
00224    ast_update_use_count();
00225 }

enum ast_module_load_result ast_load_resource ( const char * resource_name )

Load a module.

Parameters:

resource_name

The name of the module to load.

This function is run by the PBX to load the modules. It performs all loading and initialization tasks. Basically, to load a module, just give it the name of the module and it will do the rest.

Returns:: See possible enum values for ast_module_load_result.

Definition at line 817 of file loader.c.

References AST_LIST_LOCK, AST_LIST_UNLOCK, and load_resource().

Referenced by file_ok_sel(), handle_load(), load_module(), manager_moduleload(), and reload().

00818 {
00819    int res;
00820    AST_LIST_LOCK(&module_list);
00821    res = load_resource(resource_name, 0, NULL);
00822    AST_LIST_UNLOCK(&module_list);
00823 
00824    return res;
00825 }

int ast_loader_register ( int(*)(void) updater )

Add a procedure to be run when modules have been updated.

Parameters:

updater

The function to run when modules have been updated.

This function adds the given function to a linked list of functions to be run when the modules are updated.

Return values:

	0	on success
	-1	on failure.

Definition at line 1116 of file loader.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, and loadupdate::updater.

Referenced by show_console().

01117 {
01118    struct loadupdate *tmp;
01119 
01120    if (!(tmp = ast_malloc(sizeof(*tmp))))
01121       return -1;
01122 
01123    tmp->updater = v;
01124    AST_LIST_LOCK(&updaters);
01125    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
01126    AST_LIST_UNLOCK(&updaters);
01127 
01128    return 0;
01129 }

int ast_loader_unregister ( int(*)(void) updater )

Remove a procedure to be run when modules are updated.

Parameters:

updater

The updater function to unregister.

This removes the given function from the updater list.

Return values:

	0	on success
	-1	on failure.

Definition at line 1131 of file loader.c.

References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, and loadupdate::updater.

Referenced by exit_now().

01132 {
01133    struct loadupdate *cur;
01134 
01135    AST_LIST_LOCK(&updaters);
01136    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
01137       if (cur->updater == v)  {
01138          AST_LIST_REMOVE_CURRENT(entry);
01139          break;
01140       }
01141    }
01142    AST_LIST_TRAVERSE_SAFE_END;
01143    AST_LIST_UNLOCK(&updaters);
01144 
01145    return cur ? 0 : -1;
01146 }

int ast_module_check ( const char * name )

Check if module with the name given is loaded.

Parameters:

name

Module name, like "chan_sip.so"

Return values:

	1	if true
	0	if false

Definition at line 1103 of file loader.c.

References ast_strlen_zero(), and find_resource().

Referenced by ifmodule_read(), load_module(), manager_modulecheck(), and unload_module().

01104 {
01105    struct ast_module *cur;
01106 
01107    if (ast_strlen_zero(name))
01108       return 0;       /* FALSE */
01109 
01110    cur = find_resource(name, 1);
01111 
01112    return (cur != NULL);
01113 }

char* ast_module_helper	(	const char *	line,
		const char *	word,
		int	pos,
		int	state,
		int	rpos,
		int	needsreload
	)

Match modules names for the Asterisk cli.

Parameters:

	line	Unused by this function, but this should be the line we are matching.
	word	The partial name to match.
	pos	The position the word we are completing is in.
	state	The possible match to return.
	rpos	The position we should be matching. This should be the same as pos.
	needsreload	This should be 1 if we need to reload this module and 0 otherwise. This function will only return modules that are reloadble if this is 1.

Return values:

	A	possible completion of the partial match.
	NULL	if no matches were found.

Definition at line 528 of file loader.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strdup, ast_module::info, name, and ast_module_info::reload.

Referenced by handle_modlist(), handle_reload(), handle_unload(), and load_module().

00529 {
00530    struct ast_module *cur;
00531    int i, which=0, l = strlen(word);
00532    char *ret = NULL;
00533 
00534    if (pos != rpos)
00535       return NULL;
00536 
00537    AST_LIST_LOCK(&module_list);
00538    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00539       if (!strncasecmp(word, cur->resource, l) &&
00540           (cur->info->reload || !needsreload) &&
00541           ++which > state) {
00542          ret = ast_strdup(cur->resource);
00543          break;
00544       }
00545    }
00546    AST_LIST_UNLOCK(&module_list);
00547 
00548    if (!ret) {
00549       for (i=0; !ret && reload_classes[i].name; i++) {
00550          if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
00551             ret = ast_strdup(reload_classes[i].name);
00552       }
00553    }
00554 
00555    return ret;
00556 }

struct ast_module* ast_module_ref ( struct ast_module * ) [read]

Definition at line 1148 of file loader.c.

References ast_atomic_fetchadd_int(), ast_update_use_count(), and ast_module::usecount.

Referenced by __oh323_new(), agi_handle_command(), alsa_new(), ast_agi_register(), ast_iax2_new(), ast_timer_open(), dahdi_new(), fn_wrapper(), gtalk_new(), handle_cli_file_convert(), handle_orig(), mgcp_new(), newpvt(), oss_new(), phone_check_exception(), phone_new(), sip_new(), skinny_new(), smdi_load(), and usbradio_new().

01149 {
01150    ast_atomic_fetchadd_int(&mod->usecount, +1);
01151    ast_update_use_count();
01152 
01153    return mod;
01154 }

void ast_module_register ( const struct ast_module_info * )

Definition at line 133 of file loader.c.

References ast_calloc, AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, embedded_module_list, embedding, ast_module::info, ast_module_info::name, resource_being_loaded, ast_module_info::self, and ast_module::users.

00135 00136 00137 00138 00139 00140 00141 00142 00143    } 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165    } 00166 00167 00168 00169 }

class="fragment">00134 { struct ast_module *mod; if (embedding) { if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1))) return; strcpy(mod->resource, info->name); } else { mod = resource_being_loaded; mod->info = info; AST_LIST_HEAD_INIT(&mod->users); /* during startup, before the loader has been initialized, there are no threads, so there is no need to take the lock on this list to manipulate it. it is also possible that it might be unsafe to use the list lock at that point... so let's avoid it altogether */ if (embedding) { AST_LIST_INSERT_TAIL(&embedded_module_list, mod, entry); } else { AST_LIST_LOCK(&module_list); /* it is paramount that the new entry be placed at the tail of the list, otherwise the code that uses dlopen() to load dynamic modules won't be able to find out if the module it just opened was registered or failed to load */ AST_LIST_INSERT_TAIL(&module_list, mod, entry); AST_LIST_UNLOCK(&module_list); /* give the module a copy of its own handle, for later use in registrations and the like */ *((struct ast_module **) &(info->self)) = mod;

void ast_module_shutdown ( void )

Run the unload() callback for all loaded modules.

This function should be called when Asterisk is shutting down gracefully.

Definition at line 443 of file loader.c.

References AST_LIST_HEAD_DESTROY, AST_LIST_HEAD_NOLOCK_STATIC, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, free, ast_module::info, ast_module_info::unload, and ast_module::users.

Referenced by quit_handler().

00444 {
00445    struct ast_module *mod;
00446    AST_LIST_HEAD_NOLOCK_STATIC(local_module_list, ast_module);
00447 
00448    /* We have to call the unload() callbacks in reverse order that the modules
00449     * exist in the module list so it is the reverse order of how they were
00450     * loaded. */
00451 
00452    AST_LIST_LOCK(&module_list);
00453    while ((mod = AST_LIST_REMOVE_HEAD(&module_list, entry)))
00454       AST_LIST_INSERT_HEAD(&local_module_list, mod, entry);
00455    AST_LIST_UNLOCK(&module_list);
00456 
00457    while ((mod = AST_LIST_REMOVE_HEAD(&local_module_list, entry))) {
00458       if (mod->info->unload)
00459          mod->info->unload();
00460       /* Since this should only be called when shutting down "gracefully",
00461        * all channels should be down before we get to this point, meaning
00462        * there will be no module users left. */
00463       AST_LIST_HEAD_DESTROY(&mod->users);
00464       free(mod);
00465    }
00466 }

void ast_module_unref ( struct ast_module * )

Definition at line 1156 of file loader.c.

References ast_atomic_fetchadd_int(), ast_update_use_count(), and ast_module::usecount.

Referenced by agi_handle_command(), alsa_hangup(), ast_agi_unregister(), ast_smdi_interface_destroy(), ast_timer_close(), dahdi_destroy_channel_bynum(), dahdi_hangup(), destroy(), filestream_destructor(), gtalk_hangup(), handle_cli_file_convert(), handle_orig(), iax2_predestroy(), mgcp_hangup(), oh323_hangup(), oss_hangup(), phone_check_exception(), phone_hangup(), sip_hangup(), and usbradio_hangup().

01157 {
01158    ast_atomic_fetchadd_int(&mod->usecount, -1);
01159    ast_update_use_count();
01160 }

void ast_module_unregister ( const struct ast_module_info * )

Definition at line 171 of file loader.c.

References ast_free, AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_module::info, and ast_module::users.

00172 {
00173    struct ast_module *mod = NULL;
00174 
00175    /* it is assumed that the users list in the module structure
00176       will already be empty, or we cannot have gotten to this
00177       point
00178    */
00179    AST_LIST_LOCK(&module_list);
00180    AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00181       if (mod->info == info) {
00182          AST_LIST_REMOVE_CURRENT(entry);
00183          break;
00184       }
00185    }
00186    AST_LIST_TRAVERSE_SAFE_END;
00187    AST_LIST_UNLOCK(&module_list);
00188 
00189    if (mod) {
00190       AST_LIST_HEAD_DESTROY(&mod->users);
00191       ast_free(mod);
00192    }
00193 }

int ast_register_application2	(	const char *	app,
		int()(struct ast_channel , void *)	execute,
		const char *	synopsis,
		const char *	description,
		void *	mod
	)

Register an application.

Parameters:

	app	Short name of the application
	execute	a function callback to execute the application. It should return non-zero if the channel needs to be hung up.
	synopsis	a short description (one line synopsis) of the application
	description	long description with all of the details about the use of the application
	mod	module this application belongs to

This registers an application with Asterisk's internal application list.

Note:: The individual applications themselves are responsible for registering and unregistering and unregistering their own CLI commands.

Return values:

	0	success
	-1	failure.

Definition at line 4541 of file pbx.c.

References ast_calloc, ast_log(), AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, COLOR_BRCYAN, ast_app::description, ast_app::execute, LOG_WARNING, ast_app::synopsis, and term_color().

Referenced by ast_features_init(), and load_pbx().

04542 {
04543    struct ast_app *tmp, *cur = NULL;
04544    char tmps[80];
04545    int length, res;
04546 
04547    AST_RWLIST_WRLOCK(&apps);
04548    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
04549       if (!(res = strcasecmp(app, tmp->name))) {
04550          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
04551          AST_RWLIST_UNLOCK(&apps);
04552          return -1;
04553       } else if (res < 0)
04554          break;
04555    }
04556 
04557    length = sizeof(*tmp) + strlen(app) + 1;
04558 
04559    if (!(tmp = ast_calloc(1, length))) {
04560       AST_RWLIST_UNLOCK(&apps);
04561       return -1;
04562    }
04563 
04564    strcpy(tmp->name, app);
04565    tmp->execute = execute;
04566    tmp->synopsis = synopsis;
04567    tmp->description = description;
04568    tmp->module = mod;
04569 
04570    /* Store in alphabetical order */
04571    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
04572       if (strcasecmp(tmp->name, cur->name) < 0) {
04573          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
04574          break;
04575       }
04576    }
04577    AST_RWLIST_TRAVERSE_SAFE_END;
04578    if (!cur)
04579       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
04580 
04581    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
04582 
04583    AST_RWLIST_UNLOCK(&apps);
04584 
04585    return 0;
04586 }

int ast_unload_resource	(	const char *	resource_name,
		enum	ast_module_unload_mode
	)

Unload a module.

Parameters:

	resource_name	The name of the module to unload.
	ast_module_unload_mode	The force flag. This should be set using one of the AST_FORCE flags.

This function unloads a module. It will only unload modules that are not in use (usecount not zero), unless AST_FORCE_FIRM or AST_FORCE_HARD is specified. Setting AST_FORCE_FIRM or AST_FORCE_HARD will unload the module regardless of consequences (NOT RECOMMENDED).

Return values:

	0	on success.
	-1	on error.

Definition at line 468 of file loader.c.

References __ast_module_user_hangup_all(), AST_FORCE_FIRM, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_update_use_count(), ast_module::declined, find_resource(), ast_module::flags, ast_module::info, ast_module::lib, LOG_WARNING, ast_module_info::restore_globals, ast_module::running, ast_module_info::unload, and ast_module::usecount.

Referenced by exit_now(), handle_unload(), manager_moduleload(), reload(), and remove_module().

00469 {
00470    struct ast_module *mod;
00471    int res = -1;
00472    int error = 0;
00473 
00474    AST_LIST_LOCK(&module_list);
00475 
00476    if (!(mod = find_resource(resource_name, 0))) {
00477       AST_LIST_UNLOCK(&module_list);
00478       ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
00479       return 0;
00480    }
00481 
00482    if (!(mod->flags.running || mod->flags.declined))
00483       error = 1;
00484 
00485    if (!error && (mod->usecount > 0)) {
00486       if (force)
00487          ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
00488             resource_name, mod->usecount);
00489       else {
00490          ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
00491             mod->usecount);
00492          error = 1;
00493       }
00494    }
00495 
00496    if (!error) {
00497       __ast_module_user_hangup_all(mod);
00498       res = mod->info->unload();
00499 
00500       if (res) {
00501          ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
00502          if (force <= AST_FORCE_FIRM)
00503             error = 1;
00504          else
00505             ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
00506       }
00507    }
00508 
00509    if (!error)
00510       mod->flags.running = mod->flags.declined = 0;
00511 
00512    AST_LIST_UNLOCK(&module_list);
00513 
00514    if (!error && !mod->lib && mod->info && mod->info->restore_globals)
00515       mod->info->restore_globals();
00516 
00517 #ifdef LOADABLE_MODULES
00518    if (!error)
00519       unload_dynamic_module(mod);
00520 #endif
00521 
00522    if (!error)
00523       ast_update_use_count();
00524 
00525    return res;
00526 }

int ast_unregister_application ( const char * app )

Unregister an application.

Parameters:

app

name of the application (does not have to be the same string as the one that was registered)

This unregisters an application from Asterisk's internal application list.

Return values:

	0	success
	-1	failure

Definition at line 5835 of file pbx.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, and unreference_cached_app().

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

05836 {
05837    struct ast_app *tmp;
05838 
05839    AST_RWLIST_WRLOCK(&apps);
05840    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
05841       if (!strcasecmp(app, tmp->name)) {
05842          unreference_cached_app(tmp);
05843          AST_RWLIST_REMOVE_CURRENT(list);
05844          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
05845          ast_free(tmp);
05846          break;
05847       }
05848    }
05849    AST_RWLIST_TRAVERSE_SAFE_END;
05850    AST_RWLIST_UNLOCK(&apps);
05851 
05852    return tmp ? 0 : -1;
05853 }

int ast_update_module_list	(	int()(const char module, const char description, int usecnt, const char like)	modentry,
		const char *	like
	)

Ask for a list of modules, descriptions, and use counts.

Parameters:

	modentry	A callback to an updater function.
	like	For each of the modules loaded, modentry will be executed with the resource, description, and usecount values of each particular module.

Returns:: the number of modules loaded

Definition at line 1082 of file loader.c.

References AST_LIST_TRAVERSE, AST_LIST_TRYLOCK, AST_LIST_UNLOCK, ast_module_info::description, ast_module::info, and ast_module::usecount.

Referenced by handle_modlist(), and mod_update().

01084 {
01085    struct ast_module *cur;
01086    int unlock = -1;
01087    int total_mod_loaded = 0;
01088 
01089    if (AST_LIST_TRYLOCK(&module_list))
01090       unlock = 0;
01091  
01092    AST_LIST_TRAVERSE(&module_list, cur, entry) {
01093       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
01094    }
01095 
01096    if (unlock)
01097       AST_LIST_UNLOCK(&module_list);
01098 
01099    return total_mod_loaded;
01100 }

void ast_update_use_count ( void )

Notify when usecount has been changed.

This function calulates use counts and notifies anyone trying to keep track of them. It should be called whenever your module's usecount changes.

Note:: The ast_module_user_* functions take care of calling this function for you.

Definition at line 1070 of file loader.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, and loadupdate::updater.

Referenced by __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_module_ref(), ast_module_unref(), ast_unload_resource(), exit_now(), handle_request_do(), load_module(), oh323_request(), scheduler_process_request_queue(), sip_request_call(), start_resource(), and unistim_new().

01071 {
01072    /* Notify any module monitors that the use count for a
01073       resource has changed */
01074    struct loadupdate *m;
01075 
01076    AST_LIST_LOCK(&updaters);
01077    AST_LIST_TRAVERSE(&updaters, m, entry)
01078       m->updater();
01079    AST_LIST_UNLOCK(&updaters);
01080 }

Variable Documentation

struct ast_module_info* ast_module_info [static]

Definition at line 283 of file module.h.

Asterisk developer's documentation

module.h File Reference

Data Structures

Defines

Enumerations

Functions

Variables

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation