Wed Oct 28 11:46:13 2009

Asterisk developer's documentation


module.h File Reference

Asterisk module definitions. More...

#include "asterisk/utils.h"

Include dependency graph for module.h:

Go to the source code of this file.

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) }
enum  ast_module_load_result { AST_MODULE_LOAD_SUCCESS = 0, AST_MODULE_LOAD_DECLINE = 1, AST_MODULE_LOAD_SKIP = 2, 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_moduleast_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 const 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 278 of file module.h.

#define __MODULE_INFO_SECTION

Definition at line 277 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 335 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 357 of file module.h.

#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)

Definition at line 233 of file module.h.

Referenced by unload_module().

#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.

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 381 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

Enumerator:
AST_MODFLAG_DEFAULT 
AST_MODFLAG_GLOBAL_SYMBOLS 

Definition at line 189 of file module.h.

00189                       {
00190    AST_MODFLAG_DEFAULT = 0,
00191    AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00192 };

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_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_FAILURE = -1, /*!< Module could not be loaded properly */
00065 };

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 192 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().

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

void __ast_module_user_hangup_all ( struct ast_module  ) 

Definition at line 224 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().

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

void __ast_module_user_remove ( struct ast_module ,
struct ast_module_user  
)

Definition at line 213 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().

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

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 787 of file loader.c.

References AST_LIST_LOCK, AST_LIST_UNLOCK, and load_resource().

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

00788 {
00789    int res;
00790    AST_LIST_LOCK(&module_list);
00791    res = load_resource(resource_name, 0);
00792    AST_LIST_UNLOCK(&module_list);
00793 
00794    return res;
00795 }

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 1041 of file loader.c.

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

Referenced by show_console().

01042 {
01043    struct loadupdate *tmp;
01044 
01045    if (!(tmp = ast_malloc(sizeof(*tmp))))
01046       return -1;
01047 
01048    tmp->updater = v;
01049    AST_LIST_LOCK(&updaters);
01050    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
01051    AST_LIST_UNLOCK(&updaters);
01052 
01053    return 0;
01054 }

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 1056 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().

01057 {
01058    struct loadupdate *cur;
01059 
01060    AST_LIST_LOCK(&updaters);
01061    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
01062       if (cur->updater == v)  {
01063          AST_LIST_REMOVE_CURRENT(entry);
01064          break;
01065       }
01066    }
01067    AST_LIST_TRAVERSE_SAFE_END;
01068    AST_LIST_UNLOCK(&updaters);
01069 
01070    return cur ? 0 : -1;
01071 }

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 1028 of file loader.c.

References ast_strlen_zero(), and find_resource().

Referenced by ifmodule_read(), and manager_modulecheck().

01029 {
01030    struct ast_module *cur;
01031 
01032    if (ast_strlen_zero(name))
01033       return 0;       /* FALSE */
01034 
01035    cur = find_resource(name, 1);
01036 
01037    return (cur != NULL);
01038 }

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 523 of file loader.c.

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

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

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

struct ast_module* ast_module_ref ( struct ast_module  )  [read]

void ast_module_register ( const struct ast_module_info  ) 

Definition at line 130 of file loader.c.

References ast_calloc, AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, embedding, ast_module::info, ast_module::resource, and ast_module::users.

00131 {
00132    struct ast_module *mod;
00133 
00134    if (embedding) {
00135       if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1)))
00136          return;
00137       strcpy(mod->resource, info->name);
00138    } else {
00139       mod = resource_being_loaded;
00140    }
00141 
00142    mod->info = info;
00143    AST_LIST_HEAD_INIT(&mod->users);
00144 
00145    /* during startup, before the loader has been initialized,
00146       there are no threads, so there is no need to take the lock
00147       on this list to manipulate it. it is also possible that it
00148       might be unsafe to use the list lock at that point... so
00149       let's avoid it altogether
00150    */
00151    if (embedding) {
00152       AST_LIST_INSERT_TAIL(&embedded_module_list, mod, entry);
00153    } else {
00154       AST_LIST_LOCK(&module_list);
00155       /* it is paramount that the new entry be placed at the tail of
00156          the list, otherwise the code that uses dlopen() to load
00157          dynamic modules won't be able to find out if the module it
00158          just opened was registered or failed to load
00159       */
00160       AST_LIST_INSERT_TAIL(&module_list, mod, entry);
00161       AST_LIST_UNLOCK(&module_list);
00162    }
00163 
00164    /* give the module a copy of its own handle, for later use in registrations and the like */
00165    *((struct ast_module **) &(info->self)) = mod;
00166 }

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 438 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().

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

void ast_module_unref ( struct ast_module  ) 

void ast_module_unregister ( const struct ast_module_info  ) 

Definition at line 168 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.

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

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 4425 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, ast_sw::list, LOG_WARNING, ast_app::module, ast_app::name, ast_app::synopsis, and term_color().

Referenced by ast_features_init(), and load_pbx().

04426 {
04427    struct ast_app *tmp, *cur = NULL;
04428    char tmps[80];
04429    int length, res;
04430 
04431    AST_RWLIST_WRLOCK(&apps);
04432    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
04433       if (!(res = strcasecmp(app, tmp->name))) {
04434          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
04435          AST_RWLIST_UNLOCK(&apps);
04436          return -1;
04437       } else if (res < 0)
04438          break;
04439    }
04440 
04441    length = sizeof(*tmp) + strlen(app) + 1;
04442 
04443    if (!(tmp = ast_calloc(1, length))) {
04444       AST_RWLIST_UNLOCK(&apps);
04445       return -1;
04446    }
04447 
04448    strcpy(tmp->name, app);
04449    tmp->execute = execute;
04450    tmp->synopsis = synopsis;
04451    tmp->description = description;
04452    tmp->module = mod;
04453 
04454    /* Store in alphabetical order */
04455    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
04456       if (strcasecmp(tmp->name, cur->name) < 0) {
04457          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
04458          break;
04459       }
04460    }
04461    AST_RWLIST_TRAVERSE_SAFE_END;
04462    if (!cur)
04463       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
04464 
04465    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
04466 
04467    AST_RWLIST_UNLOCK(&apps);
04468 
04469    return 0;
04470 }

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 463 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().

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

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 5558 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, ast_sw::list, ast_app::name, and unreference_cached_app().

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

05559 {
05560    struct ast_app *tmp;
05561 
05562    AST_RWLIST_WRLOCK(&apps);
05563    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
05564       if (!strcasecmp(app, tmp->name)) {
05565          unreference_cached_app(tmp);
05566          AST_RWLIST_REMOVE_CURRENT(list);
05567          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
05568          ast_free(tmp);
05569          break;
05570       }
05571    }
05572    AST_RWLIST_TRAVERSE_SAFE_END;
05573    AST_RWLIST_UNLOCK(&apps);
05574 
05575    return tmp ? 0 : -1;
05576 }

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 1007 of file loader.c.

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

Referenced by handle_modlist(), and mod_update().

01009 {
01010    struct ast_module *cur;
01011    int unlock = -1;
01012    int total_mod_loaded = 0;
01013 
01014    if (AST_LIST_TRYLOCK(&module_list))
01015       unlock = 0;
01016  
01017    AST_LIST_TRAVERSE(&module_list, cur, entry) {
01018       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
01019    }
01020 
01021    if (unlock)
01022       AST_LIST_UNLOCK(&module_list);
01023 
01024    return total_mod_loaded;
01025 }

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 995 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(), load_resource(), oh323_request(), scheduler_process_request_queue(), sip_request_call(), and unistim_new().

00996 {
00997    /* Notify any module monitors that the use count for a
00998       resource has changed */
00999    struct loadupdate *m;
01000 
01001    AST_LIST_LOCK(&updaters);
01002    AST_LIST_TRAVERSE(&updaters, m, entry)
01003       m->updater();
01004    AST_LIST_UNLOCK(&updaters);
01005 }


Variable Documentation

const struct ast_module_info* ast_module_info [static]

Definition at line 274 of file module.h.


Generated on Wed Oct 28 11:46:13 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6