Thu May 14 14:50:04 2009

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

Variables

static const 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 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 262 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 281 of file module.h.

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

Definition at line 220 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_exec(), appendcdruserfield_exec(), aqm_exec(), asyncgoto_exec(), auth_exec(), background_detect_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_exec(), execif_exec(), extenspy_exec(), festival_exec(), flash_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(), nbs_new(), NBScat_exec(), nocdr_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), page_exec(), park_call_exec(), park_exec(), parkandannounce_exec(), pickup_exec(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), queue_function_queuemembercount(), queue_function_queuememberlist(), queue_function_queuewaitingcount(), random_exec(), read_exec(), readfile_exec(), realtime_exec(), realtime_update_exec(), record_exec(), retrydial_exec(), rqm_exec(), sayunixtime_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(), stop_mixmonitor_exec(), system_exec_helper(), testclient_exec(), testserver_exec(), transfer_exec(), tryexec_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), vmauthenticate(), waitforring_exec(), and zapateller_exec().

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

Definition at line 222 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 221 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_exec(), appendcdruserfield_exec(), aqm_exec(), asyncgoto_exec(), auth_exec(), background_detect_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_exec(), execif_exec(), extenspy_exec(), festival_exec(), flash_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(), nbs_destroy(), NBScat_exec(), nocdr_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), page_exec(), park_call_exec(), park_exec(), parkandannounce_exec(), pickup_exec(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_function_queuemembercount(), queue_function_queuememberlist(), queue_function_queuewaitingcount(), random_exec(), read_exec(), readfile_exec(), realtime_exec(), realtime_update_exec(), record_exec(), retrydial_exec(), rqm_exec(), sayunixtime_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(), stop_mixmonitor_exec(), system_exec_helper(), testclient_exec(), testserver_exec(), transfer_exec(), tryexec_exec(), upqm_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), vmauthenticate(), waitforring_exec(), and zapateller_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.


Enumeration Type Documentation

enum ast_module_flags

Enumerator:
AST_MODFLAG_DEFAULT 
AST_MODFLAG_GLOBAL_SYMBOLS 
AST_MODFLAG_BUILDSUM 

Definition at line 179 of file module.h.

00179                       {
00180    AST_MODFLAG_DEFAULT = 0,
00181    AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
00182    AST_MODFLAG_BUILDSUM = (1 << 1),
00183 };

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

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

void __ast_module_user_hangup_all ( struct ast_module  ) 

Definition at line 207 of file loader.c.

References ast_atomic_fetchadd_int(), 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, free, ast_module::usecount, and ast_module::users.

Referenced by ast_unload_resource().

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

void __ast_module_user_remove ( struct ast_module ,
struct ast_module_user  
)

Definition at line 196 of file loader.c.

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

00197 {
00198    AST_LIST_LOCK(&mod->users);
00199    AST_LIST_REMOVE(&mod->users, u, entry);
00200    AST_LIST_UNLOCK(&mod->users);
00201    ast_atomic_fetchadd_int(&mod->usecount, -1);
00202    free(u);
00203 
00204    ast_update_use_count();
00205 }

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

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

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

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, and ast_malloc.

Referenced by show_console().

00964 {
00965    struct loadupdate *tmp;
00966 
00967    if (!(tmp = ast_malloc(sizeof(*tmp))))
00968       return -1;
00969 
00970    tmp->updater = v;
00971    AST_LIST_LOCK(&updaters);
00972    AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
00973    AST_LIST_UNLOCK(&updaters);
00974 
00975    return 0;
00976 }

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

00979 {
00980    struct loadupdate *cur;
00981 
00982    AST_LIST_LOCK(&updaters);
00983    AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
00984       if (cur->updater == v)  {
00985          AST_LIST_REMOVE_CURRENT(&updaters, entry);
00986          break;
00987       }
00988    }
00989    AST_LIST_TRAVERSE_SAFE_END;
00990    AST_LIST_UNLOCK(&updaters);
00991 
00992    return cur ? 0 : -1;
00993 }

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

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

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

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

struct ast_module* ast_module_ref ( struct ast_module  ) 

Definition at line 995 of file loader.c.

References ast_atomic_fetchadd_int(), 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(), dahdi_new(), features_new(), fn_wrapper(), gtalk_new(), handle_orig(), mgcp_new(), newpvt(), oss_new(), phone_check_exception(), phone_new(), sip_new(), and skinny_new().

00996 {
00997    ast_atomic_fetchadd_int(&mod->usecount, +1);
00998    ast_update_use_count();
00999 
01000    return mod;
01001 }

void ast_module_register ( const struct ast_module_info  ) 

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

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

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 435 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, ast_module_user::entry, free, ast_module::info, ast_module_info::unload, and ast_module::users.

Referenced by quit_handler().

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

void ast_module_unref ( struct ast_module  ) 

Definition at line 1003 of file loader.c.

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

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

01004 {
01005    ast_atomic_fetchadd_int(&mod->usecount, -1);
01006    ast_update_use_count();
01007 }

void ast_module_unregister ( const struct ast_module_info  ) 

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

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

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 460 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::lib, LOG_WARNING, ast_module::running, unload_dynamic_module(), and ast_module::usecount.

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

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

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

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

Referenced by handle_modlist(), and mod_update().

00945 {
00946    struct ast_module *cur;
00947    int unlock = -1;
00948    int total_mod_loaded = 0;
00949 
00950    if (AST_LIST_TRYLOCK(&module_list))
00951       unlock = 0;
00952 
00953    AST_LIST_TRAVERSE(&module_list, cur, entry) {
00954       total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
00955    }
00956 
00957    if (unlock)
00958       AST_LIST_UNLOCK(&module_list);
00959 
00960    return total_mod_loaded;
00961 }

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

00932 {
00933    /* Notify any module monitors that the use count for a
00934       resource has changed */
00935    struct loadupdate *m;
00936 
00937    AST_LIST_LOCK(&updaters);
00938    AST_LIST_TRAVERSE(&updaters, m, entry)
00939       m->updater();
00940    AST_LIST_UNLOCK(&updaters);
00941 }


Variable Documentation

const struct ast_module_info* ast_module_info [static]

Definition at line 260 of file module.h.


Generated on Thu May 14 14:50:04 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7