Mon Mar 31 07:41:54 2008

Asterisk developer's documentation


module.h File Reference

Asterisk module definitions. More...

#include "asterisk/utils.h"

Include dependency graph for module.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_module_info

Defines

#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 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_BUILDSUM = (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_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 *)
static const __attribute__ ((unused)) struct ast_module_info *ast_module_info
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 (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_unload_resource (const char *resource_name, enum ast_module_unload_mode)
 Unload a module.
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.


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 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 269 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 288 of file module.h.

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

Definition at line 227 of file module.h.

Referenced by __login_exec(), _macro_exec(), _while_exec(), acf_curl_exec(), acf_cut_exec(), acf_rand_exec(), acf_sort_exec(), acf_vmcount_exec(), admin_exec(), adsi_exec(), agi_exec_full(), alarmreceiver_exec(), amd_exec(), app_conference_main(), app_exec(), appendcdruserfield_exec(), aqm_exec(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), builtin_parkcall(), chanavail_exec(), chanspy_exec(), conf_exec(), controlplayback_exec(), count_exec(), cpeid_exec(), del_exec(), deltree_exec(), dictate_exec(), directory_exec(), disa_exec(), dumpchan_exec(), dundifunc_read(), echo_exec(), exec_exec(), execif_exec(), extenspy_exec(), festival_exec(), flash_exec(), forkcdr_exec(), function_enum(), function_realtime_read(), function_realtime_write(), function_txtcidname(), gosub_exec(), gosubif_exec(), hasvoicemail_exec(), ices_exec(), local_new(), log_exec(), lookupblacklist_exec(), lookupcidname_exec(), macroif_exec(), milliwatt_exec(), mixmonitor_exec(), morsecode_exec(), mp3_exec(), mwanalyze_exec(), MYSQL_exec(), nbs_new(), NBScat_exec(), nocdr_exec(), nv_background_detect_exec(), nv_detectfax_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), page_exec(), park_call_exec(), park_exec(), parkandannounce_exec(), pickdown_channel(), pickup_channel(), pickup_exec(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), queue_function_qac(), queue_function_queuememberlist(), queue_function_queuewaitingcount(), random_exec(), read_exec(), readfile_exec(), realtime_exec(), realtime_update_exec(), record_exec(), retrydial_exec(), rqm_exec(), rxfax_exec(), sayunixtime_exec(), segfault_exec(), senddtmf_exec(), sendimage_exec(), sendtext_exec(), sendurl_exec(), setcallerid_exec(), setcallerid_pres_exec(), setcdruserfield_exec(), settransfercapability_exec(), skel_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_activate(), speech_background(), speech_create(), speech_deactivate(), speech_destroy(), speech_load(), speech_processing_sound(), speech_start(), speech_unload(), steal_channel(), stop_mixmonitor_exec(), system_exec_helper(), testclient_exec(), testserver_exec(), transfer_exec(), tryexec_exec(), txfax_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), vmauthenticate(), waitforring_exec(), zapateller_exec(), and zapras_exec().

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

Definition at line 229 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 228 of file module.h.

Referenced by _macro_exec(), acf_curl_exec(), acf_cut_exec(), acf_rand_exec(), acf_sort_exec(), acf_vmcount_exec(), admin_exec(), adsi_exec(), agi_exec_full(), alarmreceiver_exec(), amd_exec(), app_conference_main(), app_exec(), appendcdruserfield_exec(), aqm_exec(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), builtin_parkcall(), chanavail_exec(), chanspy_exec(), conf_exec(), controlplayback_exec(), count_exec(), cpeid_exec(), del_exec(), deltree_exec(), dictate_exec(), directory_exec(), disa_exec(), dumpchan_exec(), dundifunc_read(), echo_exec(), exec_exec(), execif_exec(), extenspy_exec(), festival_exec(), flash_exec(), forkcdr_exec(), function_enum(), function_realtime_read(), function_realtime_write(), function_txtcidname(), gosub_exec(), gosubif_exec(), hasvoicemail_exec(), ices_exec(), local_hangup(), log_exec(), lookupblacklist_exec(), lookupcidname_exec(), macroif_exec(), milliwatt_exec(), mixmonitor_exec(), morsecode_exec(), mp3_exec(), mwanalyze_exec(), MYSQL_exec(), nbs_destroy(), NBScat_exec(), nocdr_exec(), nv_background_detect_exec(), nv_detectfax_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), page_exec(), park_call_exec(), park_exec(), parkandannounce_exec(), pickdown_channel(), pickup_channel(), pickup_exec(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_function_qac(), queue_function_queuememberlist(), queue_function_queuewaitingcount(), random_exec(), read_exec(), readfile_exec(), realtime_exec(), realtime_update_exec(), record_exec(), retrydial_exec(), rqm_exec(), rxfax_exec(), sayunixtime_exec(), segfault_exec(), senddtmf_exec(), sendimage_exec(), sendtext_exec(), sendurl_exec(), setcallerid_exec(), setcallerid_pres_exec(), setcdruserfield_exec(), settransfercapability_exec(), skel_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_activate(), speech_background(), speech_create(), speech_deactivate(), speech_destroy(), speech_load(), speech_processing_sound(), speech_start(), speech_unload(), steal_channel(), stop_mixmonitor_exec(), system_exec_helper(), testclient_exec(), testserver_exec(), transfer_exec(), tryexec_exec(), txfax_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), vmauthenticate(), waitforring_exec(), zapateller_exec(), and zapras_exec().

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

Referenced by key().


Enumeration Type Documentation

enum ast_module_flags

Enumerator:
AST_MODFLAG_DEFAULT 
AST_MODFLAG_GLOBAL_SYMBOLS 
AST_MODFLAG_BUILDSUM 

Definition at line 186 of file module.h.

00186                       {
00187    AST_MODFLAG_DEFAULT = 0,
00188    AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00189    AST_MODFLAG_BUILDSUM = (1 << 1),
00190 };

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

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

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

00181 {
00182    struct ast_module_user *u = ast_calloc(1, sizeof(*u));
00183 
00184    if (!u)
00185       return NULL;
00186 
00187    u->chan = chan;
00188 
00189    AST_LIST_LOCK(&mod->users);
00190    AST_LIST_INSERT_HEAD(&mod->users, u, entry);
00191    AST_LIST_UNLOCK(&mod->users);
00192 
00193    ast_atomic_fetchadd_int(&mod->usecount, +1);
00194 
00195    ast_update_use_count();
00196 
00197    return u;
00198 }

void __ast_module_user_hangup_all ( struct ast_module  ) 

Definition at line 211 of file loader.c.

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

Referenced by ast_unload_resource().

00212 {
00213    struct ast_module_user *u;
00214 
00215    AST_LIST_LOCK(&mod->users);
00216    while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
00217       ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
00218       ast_atomic_fetchadd_int(&mod->usecount, -1);
00219       free(u);
00220    }
00221    AST_LIST_UNLOCK(&mod->users);
00222 
00223         ast_update_use_count();
00224 }

void __ast_module_user_remove ( struct ast_module ,
struct ast_module_user  
)

Definition at line 200 of file loader.c.

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

00201 {
00202    AST_LIST_LOCK(&mod->users);
00203    AST_LIST_REMOVE(&mod->users, u, entry);
00204    AST_LIST_UNLOCK(&mod->users);
00205    ast_atomic_fetchadd_int(&mod->usecount, -1);
00206    free(u);
00207 
00208    ast_update_use_count();
00209 }

static const __attribute__ ( (unused)   )  [static]

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

References AST_LIST_LOCK, AST_LIST_UNLOCK, and load_resource().

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

00712 {
00713        AST_LIST_LOCK(&module_list);
00714        load_resource(resource_name, 0);
00715        AST_LIST_UNLOCK(&module_list);
00716 
00717        return 0;
00718 }

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.

Returns:
Zero on success and -1 on failure.

Definition at line 953 of file loader.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, and ast_malloc.

Referenced by show_console().

00954 {
00955    struct loadupdate *tmp;
00956 
00957    if (!(tmp = ast_malloc(sizeof(*tmp))))
00958       return -1;
00959 
00960    tmp->updater = v;
00961    AST_LIST_LOCK(&updaters);
00962    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
00963    AST_LIST_UNLOCK(&updaters);
00964 
00965    return 0;
00966 }

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.

Returns:
Zero on success, -1 on failure.

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

00969 {
00970    struct loadupdate *cur;
00971 
00972    AST_LIST_LOCK(&updaters);
00973    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
00974       if (cur->updater == v)  {
00975          AST_LIST_REMOVE_CURRENT(&updaters, entry);
00976          break;
00977       }
00978    }
00979    AST_LIST_TRAVERSE_SAFE_END;
00980    AST_LIST_UNLOCK(&updaters);
00981 
00982    return cur ? 0 : -1;
00983 }

int ast_module_check ( char *  name  ) 

Check if module with the name given is loaded.

Parameters:
name Module name, like "chan_sip.so"
Returns:
0 if false, 1 if true

Definition at line 934 of file loader.c.

References AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_trylock(), and ast_strlen_zero().

Referenced by ifmodule_read().

00935 {
00936    struct ast_module *cur;
00937    int unlock = -1;
00938    int res = 0;
00939 
00940    if (ast_strlen_zero(name))
00941       return 0;   /* FALSE */
00942 
00943    if (ast_mutex_trylock(&module_list.lock))
00944       unlock = 0;
00945    AST_LIST_TRAVERSE(&module_list, cur, entry)
00946       if (!res && !strcasecmp(name, cur->resource))
00947          res = 1;
00948    if (unlock)
00949       AST_LIST_UNLOCK(&module_list);
00950    return res;
00951 }

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.
Returns:
A possible completion of the partial match, or NULL if no matches were found.

Definition at line 519 of file loader.c.

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

Referenced by complete_mod_2(), complete_mod_3(), complete_mod_3_nr(), complete_mod_4(), and load_module().

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

struct ast_module* ast_module_ref ( struct ast_module  ) 

Definition at line 985 of file loader.c.

References ast_update_use_count(), and ast_module::usecount.

Referenced by __oh323_new(), alsa_new(), ast_iax2_new(), cli_audio_convert(), cli_audio_convert_deprecated(), complete_orig(), features_new(), fn_wrapper(), gtalk_new(), handle_orig(), mgcp_new(), newpvt(), oss_new(), phone_check_exception(), phone_new(), sip_new(), skinny_new(), and zt_new().

00986 {
00987    ast_atomic_fetchadd_int(&mod->usecount, +1);
00988    ast_update_use_count();
00989 
00990    return mod;
00991 }

void ast_module_register ( const struct ast_module_info  ) 

Definition at line 117 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_info::name, resource_being_loaded, ast_module_info::self, and ast_module::users.

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

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

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

void ast_module_unref ( struct ast_module  ) 

Definition at line 993 of file loader.c.

References ast_update_use_count(), and ast_module::usecount.

Referenced by alsa_hangup(), ast_closestream(), ast_smdi_interface_destroy(), cli_audio_convert(), cli_audio_convert_deprecated(), complete_orig(), destroy(), gtalk_hangup(), handle_orig(), iax2_predestroy(), mgcp_hangup(), oh323_hangup(), oss_hangup(), phone_check_exception(), phone_hangup(), sip_hangup(), and zt_hangup().

00994 {
00995    ast_atomic_fetchadd_int(&mod->usecount, -1);
00996    ast_update_use_count();
00997 }

void ast_module_unregister ( const struct ast_module_info  ) 

Definition at line 155 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, free, ast_module::info, and ast_module::users.

00156 {
00157    struct ast_module *mod = NULL;
00158 
00159    /* it is assumed that the users list in the module structure
00160       will already be empty, or we cannot have gotten to this
00161       point
00162    */
00163    AST_LIST_LOCK(&module_list);
00164    AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
00165       if (mod->info == info) {
00166          AST_LIST_REMOVE_CURRENT(&module_list, entry);
00167          break;
00168       }
00169    }
00170    AST_LIST_TRAVERSE_SAFE_END;
00171    AST_LIST_UNLOCK(&module_list);
00172 
00173    if (mod) {
00174       AST_LIST_HEAD_DESTROY(&mod->users);
00175       free(mod);
00176    }
00177 }

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

Returns:
Zero on success, -1 on error.

Definition at line 458 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, error(), find_resource(), ast_module::flags, ast_module::lib, ast_module::running, and ast_module::usecount.

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

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

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

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

Referenced by handle_modlist(), and mod_update().

00916 {
00917    struct ast_module *cur;
00918    int unlock = -1;
00919    int total_mod_loaded = 0;
00920 
00921    if (AST_LIST_TRYLOCK(&module_list))
00922       unlock = 0;
00923 
00924    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00925       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
00926    }
00927 
00928    if (unlock)
00929       AST_LIST_UNLOCK(&module_list);
00930 
00931    return total_mod_loaded;
00932 }

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 LOCAL_USER macros take care of calling this function for you.

Definition at line 902 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(), agent_new(), ast_module_ref(), ast_module_unref(), ast_unload_resource(), exit_now(), load_module(), load_resource(), oh323_request(), sip_request_call(), and sipsock_read().

00903 {
00904    /* Notify any module monitors that the use count for a
00905       resource has changed */
00906    struct loadupdate *m;
00907 
00908    AST_LIST_LOCK(&updaters);
00909    AST_LIST_TRAVERSE(&updaters, m, entry)
00910       m->updater();
00911    AST_LIST_UNLOCK(&updaters);
00912 }


Generated on Mon Mar 31 07:41:58 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.1