Wed Aug 18 22:34:27 2010

Asterisk developer's documentation


module.h File Reference

Asterisk module definitions. More...

#include "asterisk/utils.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), 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

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.
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 struct ast_module_infoast_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  
)

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_user::entry, 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_user::entry, 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_user::entry, 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 836 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().

00837 {
00838    int res;
00839    AST_LIST_LOCK(&module_list);
00840    res = load_resource(resource_name, 0, NULL);
00841    AST_LIST_UNLOCK(&module_list);
00842 
00843    return res;
00844 }

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

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_malloc, and ast_module_user::entry.

Referenced by show_console().

01136 {
01137    struct loadupdate *tmp;
01138 
01139    if (!(tmp = ast_malloc(sizeof(*tmp))))
01140       return -1;
01141 
01142    tmp->updater = v;
01143    AST_LIST_LOCK(&updaters);
01144    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
01145    AST_LIST_UNLOCK(&updaters);
01146 
01147    return 0;
01148 }

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 1150 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, ast_module_user::entry, and loadupdate::updater.

Referenced by exit_now().

01151 {
01152    struct loadupdate *cur;
01153 
01154    AST_LIST_LOCK(&updaters);
01155    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
01156       if (cur->updater == v)  {
01157          AST_LIST_REMOVE_CURRENT(entry);
01158          break;
01159       }
01160    }
01161    AST_LIST_TRAVERSE_SAFE_END;
01162    AST_LIST_UNLOCK(&updaters);
01163 
01164    return cur ? 0 : -1;
01165 }

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

References ast_strlen_zero(), and find_resource().

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

01123 {
01124    struct ast_module *cur;
01125 
01126    if (ast_strlen_zero(name))
01127       return 0;       /* FALSE */
01128 
01129    cur = find_resource(name, 1);
01130 
01131    return (cur != NULL);
01132 }

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

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

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

00548 {
00549    struct ast_module *cur;
00550    int i, which=0, l = strlen(word);
00551    char *ret = NULL;
00552 
00553    if (pos != rpos)
00554       return NULL;
00555 
00556    AST_LIST_LOCK(&module_list);
00557    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00558       if (!strncasecmp(word, cur->resource, l) &&
00559           (cur->info->reload || !needsreload) &&
00560           ++which > state) {
00561          ret = ast_strdup(cur->resource);
00562          break;
00563       }
00564    }
00565    AST_LIST_UNLOCK(&module_list);
00566 
00567    if (!ret) {
00568       for (i=0; !ret && reload_classes[i].name; i++) {
00569          if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
00570             ret = ast_strdup(reload_classes[i].name);
00571       }
00572    }
00573 
00574    return ret;
00575 }

struct ast_module* ast_module_ref ( struct ast_module  ) 

Definition at line 1167 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(), moh_alloc(), moh_files_alloc(), newpvt(), oss_new(), phone_check_exception(), phone_new(), sip_new(), skinny_new(), and usbradio_new().

01168 {
01169    ast_atomic_fetchadd_int(&mod->usecount, +1);
01170    ast_update_use_count();
01171 
01172    return mod;
01173 }

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, embedding, ast_module_user::entry, ast_module::info, resource_being_loaded, and ast_module::users.

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

void ast_module_shutdown ( void   ) 

Run the unload() callback for all loaded modules.

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

Note:
Some resources, like timers, are started up dynamically, and thus may be still in use, even if all channels are dead. We must therefore check the usecount before asking modules to unload.

If we go through the entire list without changing anything, ignore the usecounts and unload, then exit.

Definition at line 449 of file loader.c.

References 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_user::entry, free, ast_module::info, ast_module_info::unload, ast_module::usecount, and ast_module::users.

Referenced by quit_handler().

00450 {
00451    struct ast_module *mod;
00452    int somethingchanged = 1, final = 0;
00453 
00454    AST_LIST_LOCK(&module_list);
00455 
00456    /*!\note Some resources, like timers, are started up dynamically, and thus
00457     * may be still in use, even if all channels are dead.  We must therefore
00458     * check the usecount before asking modules to unload. */
00459    do {
00460       if (!somethingchanged) {
00461          /*!\note If we go through the entire list without changing
00462           * anything, ignore the usecounts and unload, then exit. */
00463          final = 1;
00464       }
00465 
00466       /* Reset flag before traversing the list */
00467       somethingchanged = 0;
00468 
00469       AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00470          if (!final && mod->usecount) {
00471             continue;
00472          }
00473          AST_LIST_REMOVE_CURRENT(entry);
00474          if (mod->info->unload) {
00475             mod->info->unload();
00476          }
00477          AST_LIST_HEAD_DESTROY(&mod->users);
00478          free(mod);
00479          somethingchanged = 1;
00480       }
00481       AST_LIST_TRAVERSE_SAFE_END;
00482    } while (somethingchanged && !final);
00483 
00484    AST_LIST_UNLOCK(&module_list);
00485 }

void ast_module_unref ( struct ast_module  ) 

Definition at line 1175 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(), local_ast_moh_cleanup(), mgcp_hangup(), oh323_hangup(), oss_hangup(), phone_check_exception(), phone_hangup(), sip_hangup(), and usbradio_hangup().

01176 {
01177    ast_atomic_fetchadd_int(&mod->usecount, -1);
01178    ast_update_use_count();
01179 }

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_user::entry, 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 4567 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_app::list, LOG_WARNING, ast_app::module, ast_app::name, ast_app::synopsis, and term_color().

Referenced by ast_features_init(), and load_pbx().

04568 {
04569    struct ast_app *tmp, *cur = NULL;
04570    char tmps[80];
04571    int length, res;
04572 
04573    AST_RWLIST_WRLOCK(&apps);
04574    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
04575       if (!(res = strcasecmp(app, tmp->name))) {
04576          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
04577          AST_RWLIST_UNLOCK(&apps);
04578          return -1;
04579       } else if (res < 0)
04580          break;
04581    }
04582 
04583    length = sizeof(*tmp) + strlen(app) + 1;
04584 
04585    if (!(tmp = ast_calloc(1, length))) {
04586       AST_RWLIST_UNLOCK(&apps);
04587       return -1;
04588    }
04589 
04590    strcpy(tmp->name, app);
04591    tmp->execute = execute;
04592    tmp->synopsis = synopsis;
04593    tmp->description = description;
04594    tmp->module = mod;
04595 
04596    /* Store in alphabetical order */
04597    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
04598       if (strcasecmp(tmp->name, cur->name) < 0) {
04599          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
04600          break;
04601       }
04602    }
04603    AST_RWLIST_TRAVERSE_SAFE_END;
04604    if (!cur)
04605       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
04606 
04607    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
04608 
04609    AST_RWLIST_UNLOCK(&apps);
04610 
04611    return 0;
04612 }

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 487 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, unload_dynamic_module(), and ast_module::usecount.

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

00488 {
00489    struct ast_module *mod;
00490    int res = -1;
00491    int error = 0;
00492 
00493    AST_LIST_LOCK(&module_list);
00494 
00495    if (!(mod = find_resource(resource_name, 0))) {
00496       AST_LIST_UNLOCK(&module_list);
00497       ast_log(LOG_WARNING, "Unload failed, '%s' could not be found\n", resource_name);
00498       return -1;
00499    }
00500 
00501    if (!(mod->flags.running || mod->flags.declined))
00502       error = 1;
00503 
00504    if (!error && (mod->usecount > 0)) {
00505       if (force)
00506          ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
00507             resource_name, mod->usecount);
00508       else {
00509          ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
00510             mod->usecount);
00511          error = 1;
00512       }
00513    }
00514 
00515    if (!error) {
00516       __ast_module_user_hangup_all(mod);
00517       res = mod->info->unload();
00518 
00519       if (res) {
00520          ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
00521          if (force <= AST_FORCE_FIRM)
00522             error = 1;
00523          else
00524             ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
00525       }
00526    }
00527 
00528    if (!error)
00529       mod->flags.running = mod->flags.declined = 0;
00530 
00531    AST_LIST_UNLOCK(&module_list);
00532 
00533    if (!error && !mod->lib && mod->info && mod->info->restore_globals)
00534       mod->info->restore_globals();
00535 
00536 #ifdef LOADABLE_MODULES
00537    if (!error)
00538       unload_dynamic_module(mod);
00539 #endif
00540 
00541    if (!error)
00542       ast_update_use_count();
00543 
00544    return res;
00545 }

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

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

05862 {
05863    struct ast_app *tmp;
05864 
05865    AST_RWLIST_WRLOCK(&apps);
05866    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
05867       if (!strcasecmp(app, tmp->name)) {
05868          unreference_cached_app(tmp);
05869          AST_RWLIST_REMOVE_CURRENT(list);
05870          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
05871          ast_free(tmp);
05872          break;
05873       }
05874    }
05875    AST_RWLIST_TRAVERSE_SAFE_END;
05876    AST_RWLIST_UNLOCK(&apps);
05877 
05878    return tmp ? 0 : -1;
05879 }

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

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

Referenced by handle_modlist(), and mod_update().

01103 {
01104    struct ast_module *cur;
01105    int unlock = -1;
01106    int total_mod_loaded = 0;
01107 
01108    if (AST_LIST_TRYLOCK(&module_list))
01109       unlock = 0;
01110  
01111    AST_LIST_TRAVERSE(&module_list, cur, entry) {
01112       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
01113    }
01114 
01115    if (unlock)
01116       AST_LIST_UNLOCK(&module_list);
01117 
01118    return total_mod_loaded;
01119 }

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

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_module_user::entry, 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(), sip_request_call(), start_resource(), and unistim_new().

01090 {
01091    /* Notify any module monitors that the use count for a
01092       resource has changed */
01093    struct loadupdate *m;
01094 
01095    AST_LIST_LOCK(&updaters);
01096    AST_LIST_TRAVERSE(&updaters, m, entry)
01097       m->updater();
01098    AST_LIST_UNLOCK(&updaters);
01099 }


Variable Documentation

struct ast_module_info* ast_module_info [static]

Definition at line 283 of file module.h.


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