Thu Oct 11 06:49:21 2012

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 ast_register_application_xml(app, execute)   ast_register_application(app, execute, NULL, NULL)
 Register an application using XML documentation.
#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_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)

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

#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 ast_register_application_xml ( app,
execute   )     ast_register_application(app, execute, NULL, NULL)

Register an application using XML documentation.

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.
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 406 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 
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 };

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 };

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

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

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

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

Referenced by show_console().

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

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

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

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

References ast_strlen_zero(), and find_resource().

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

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

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

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

struct ast_module* ast_module_ref ( struct ast_module  )  [read]

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::info, ast_module::resource, 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 445 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::declined, ast_module::flags, free, ast_module::info, ast_module::running, ast_module_info::unload, ast_module::usecount, and ast_module::users.

Referenced by quit_handler().

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

void ast_module_unref ( struct ast_module  ) 

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 5120 of file pbx.c.

References ast_app::arguments, ast_calloc, ast_free, 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_STATIC_DOC, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), ast_verb, AST_XML_DOC, COLOR_BRCYAN, ast_app::docsrc, ast_app::execute, LOG_WARNING, ast_app::module, ast_app::name, ast_app::seealso, ast_app::syntax, and term_color().

Referenced by ast_features_init(), and load_pbx().

05121 {
05122    struct ast_app *tmp, *cur = NULL;
05123    char tmps[80];
05124    int length, res;
05125 #ifdef AST_XML_DOCS
05126    char *tmpxml;
05127 #endif
05128 
05129    AST_RWLIST_WRLOCK(&apps);
05130    AST_RWLIST_TRAVERSE(&apps, tmp, list) {
05131       if (!(res = strcasecmp(app, tmp->name))) {
05132          ast_log(LOG_WARNING, "Already have an application '%s'\n", app);
05133          AST_RWLIST_UNLOCK(&apps);
05134          return -1;
05135       } else if (res < 0)
05136          break;
05137    }
05138 
05139    length = sizeof(*tmp) + strlen(app) + 1;
05140 
05141    if (!(tmp = ast_calloc(1, length))) {
05142       AST_RWLIST_UNLOCK(&apps);
05143       return -1;
05144    }
05145 
05146    if (ast_string_field_init(tmp, 128)) {
05147       AST_RWLIST_UNLOCK(&apps);
05148       ast_free(tmp);
05149       return -1;
05150    }
05151 
05152 #ifdef AST_XML_DOCS
05153    /* Try to lookup the docs in our XML documentation database */
05154    if (ast_strlen_zero(synopsis) && ast_strlen_zero(description)) {
05155       /* load synopsis */
05156       tmpxml = ast_xmldoc_build_synopsis("application", app);
05157       ast_string_field_set(tmp, synopsis, tmpxml);
05158       ast_free(tmpxml);
05159 
05160       /* load description */
05161       tmpxml = ast_xmldoc_build_description("application", app);
05162       ast_string_field_set(tmp, description, tmpxml);
05163       ast_free(tmpxml);
05164 
05165       /* load syntax */
05166       tmpxml = ast_xmldoc_build_syntax("application", app);
05167       ast_string_field_set(tmp, syntax, tmpxml);
05168       ast_free(tmpxml);
05169 
05170       /* load arguments */
05171       tmpxml = ast_xmldoc_build_arguments("application", app);
05172       ast_string_field_set(tmp, arguments, tmpxml);
05173       ast_free(tmpxml);
05174 
05175       /* load seealso */
05176       tmpxml = ast_xmldoc_build_seealso("application", app);
05177       ast_string_field_set(tmp, seealso, tmpxml);
05178       ast_free(tmpxml);
05179       tmp->docsrc = AST_XML_DOC;
05180    } else {
05181 #endif
05182       ast_string_field_set(tmp, synopsis, synopsis);
05183       ast_string_field_set(tmp, description, description);
05184       tmp->docsrc = AST_STATIC_DOC;
05185 #ifdef AST_XML_DOCS
05186    }
05187 #endif
05188 
05189    strcpy(tmp->name, app);
05190    tmp->execute = execute;
05191    tmp->module = mod;
05192 
05193    /* Store in alphabetical order */
05194    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, cur, list) {
05195       if (strcasecmp(tmp->name, cur->name) < 0) {
05196          AST_RWLIST_INSERT_BEFORE_CURRENT(tmp, list);
05197          break;
05198       }
05199    }
05200    AST_RWLIST_TRAVERSE_SAFE_END;
05201    if (!cur)
05202       AST_RWLIST_INSERT_TAIL(&apps, tmp, list);
05203 
05204    ast_verb(2, "Registered application '%s'\n", term_color(tmps, tmp->name, COLOR_BRCYAN, 0, sizeof(tmps)));
05205 
05206    AST_RWLIST_UNLOCK(&apps);
05207 
05208    return 0;
05209 }

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

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

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 6461 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_string_field_free_memory, ast_verb, ast_app::name, and unreference_cached_app().

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

06462 {
06463    struct ast_app *tmp;
06464 
06465    AST_RWLIST_WRLOCK(&apps);
06466    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&apps, tmp, list) {
06467       if (!strcasecmp(app, tmp->name)) {
06468          unreference_cached_app(tmp);
06469          AST_RWLIST_REMOVE_CURRENT(list);
06470          ast_verb(2, "Unregistered application '%s'\n", tmp->name);
06471          ast_string_field_free_memory(tmp);
06472          ast_free(tmp);
06473          break;
06474       }
06475    }
06476    AST_RWLIST_TRAVERSE_SAFE_END;
06477    AST_RWLIST_UNLOCK(&apps);
06478 
06479    return tmp ? 0 : -1;
06480 }

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 1100 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 ast_var_Modules(), handle_modlist(), and mod_update().

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

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

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


Variable Documentation

struct ast_module_info* ast_module_info [static]

Definition at line 283 of file module.h.


Generated on Thu Oct 11 06:49:21 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6