Mon Apr 30 07:45:16 2007

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) }
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_module *	ast_module_ref (struct ast_module *)
void	ast_module_register (const struct ast_module_info *)
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 256 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 274 of file module.h.

#define ast_module_user_add

(

chan

)

__ast_module_user_add(ast_module_info->self, chan)

Definition at line 215 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(), 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(), 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(), rpt_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(), 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(), 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 217 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 216 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(), 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(), 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(), 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(), 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

Definition at line 179 of file module.h.

                      {
   AST_MODFLAG_DEFAULT = 0,
   AST_MODFLAG_GLOBAL_SYMBOLS = (1 << 0),
};

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.

                            {
   AST_MODULE_LOAD_SUCCESS = 0,  /*!< Module loaded and configured */
   AST_MODULE_LOAD_DECLINE = 1,  /*!< Module is not configured */
   AST_MODULE_LOAD_SKIP = 2,  /*!< Module was skipped for some reason */
   AST_MODULE_LOAD_FAILURE = -1, /*!< Module could not be loaded properly */
};

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.

                            {
   AST_FORCE_SOFT = 0, /*!< Softly unload a module, only if not in use */
   AST_FORCE_FIRM = 1, /*!< Firmly unload a module, even if in use */
   AST_FORCE_HARD = 2, /*!< as FIRM, plus dlclose() on the module. Not recommended
            as it may cause crashes */
};

---

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.

{
   struct ast_module_user *u = ast_calloc(1, sizeof(*u));

   if (!u)
      return NULL;

   u->chan = chan;

   AST_LIST_LOCK(&mod->users);
   AST_LIST_INSERT_HEAD(&mod->users, u, entry);
   AST_LIST_UNLOCK(&mod->users);

   ast_atomic_fetchadd_int(&mod->usecount, +1);

   ast_update_use_count();

   return u;
}

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

{
   struct ast_module_user *u;

   AST_LIST_LOCK(&mod->users);
   while ((u = AST_LIST_REMOVE_HEAD(&mod->users, entry))) {
      ast_softhangup(u->chan, AST_SOFTHANGUP_APPUNLOAD);
      ast_atomic_fetchadd_int(&mod->usecount, -1);
      free(u);
   }
   AST_LIST_UNLOCK(&mod->users);

        ast_update_use_count();
}

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.

{
   AST_LIST_LOCK(&mod->users);
   AST_LIST_REMOVE(&mod->users, u, entry);
   AST_LIST_UNLOCK(&mod->users);
   ast_atomic_fetchadd_int(&mod->usecount, -1);
   free(u);

   ast_update_use_count();
}

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 668 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_module().

{
       AST_LIST_LOCK(&module_list);
       load_resource(resource_name, 0);
       AST_LIST_UNLOCK(&module_list);

       return 0;
}

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

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, and ast_malloc.

Referenced by show_console().

{
   struct loadupdate *tmp;

   if (!(tmp = ast_malloc(sizeof(*tmp))))
      return -1;

   tmp->updater = v;
   AST_LIST_LOCK(&module_list);
   AST_LIST_INSERT_HEAD(&updaters, tmp, entry);
   AST_LIST_UNLOCK(&module_list);

   return 0;
}

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

{
   struct loadupdate *cur;

   AST_LIST_LOCK(&module_list);
   AST_LIST_TRAVERSE_SAFE_BEGIN(&updaters, cur, entry) {
      if (cur->updater == v)  {
         AST_LIST_REMOVE_CURRENT(&updaters, entry);
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&module_list);

   return cur ? 0 : -1;
}

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

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

Referenced by ifmodule_read().

{
   struct ast_module *cur;
   int unlock = -1;
   int res = 0;

   if (ast_strlen_zero(name))
      return 0;   /* FALSE */

   if (ast_mutex_trylock(&module_list.lock))
      unlock = 0;
   AST_LIST_TRAVERSE(&module_list, cur, entry)
      if (!res && !strcasecmp(name, cur->resource))
         res = 1;
   if (unlock)
      AST_LIST_UNLOCK(&module_list);
   return res;
}

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 493 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(), and complete_mod_4().

{
   struct ast_module *cur;
   int i, which=0, l = strlen(word);
   char *ret = NULL;

   if (pos != rpos)
      return NULL;

   AST_LIST_LOCK(&module_list);
   AST_LIST_TRAVERSE(&module_list, cur, entry) {
      if (!strncasecmp(word, cur->resource, l) &&
          (cur->info->reload || !needsreload) &&
          ++which > state) {
         ret = strdup(cur->resource);
         break;
      }
   }
   AST_LIST_UNLOCK(&module_list);

   if (!ret) {
      for (i=0; !ret && reload_classes[i].name; i++) {
         if (!strncasecmp(word, reload_classes[i].name, l) && ++which > state)
            ret = strdup(reload_classes[i].name);
      }
   }

   return ret;
}

struct ast_module* ast_module_ref

(

struct ast_module *

)

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

{
   ast_atomic_fetchadd_int(&mod->usecount, +1);
   ast_update_use_count();

   return mod;
}

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.

{
   struct ast_module *mod;

   if (embedding) {
      if (!(mod = ast_calloc(1, sizeof(*mod) + strlen(info->name) + 1)))
         return;
      strcpy(mod->resource, info->name);
   } else {
      mod = resource_being_loaded;
   }

   mod->info = info;
   AST_LIST_HEAD_INIT(&mod->users);

   /* during startup, before the loader has been initialized,
      there are no threads, so there is no need to take the lock
      on this list to manipulate it. it is also possible that it
      might be unsafe to use the list lock at that point... so
      let's avoid it altogether
   */
   if (!embedding)
      AST_LIST_LOCK(&module_list);

   /* it is paramount that the new entry be placed at the tail of
      the list, otherwise the code that uses dlopen() to load
      dynamic modules won't be able to find out if the module it
      just opened was registered or failed to load
   */
   AST_LIST_INSERT_TAIL(&module_list, mod, entry);

   if (!embedding)
      AST_LIST_UNLOCK(&module_list);

   /* give the module a copy of its own handle, for later use in registrations and the like */
   *((struct ast_module **) &(info->self)) = mod;
}

void ast_module_unref

(

struct ast_module *

)

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

{
   ast_atomic_fetchadd_int(&mod->usecount, -1);
   ast_update_use_count();
}

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.

{
   struct ast_module *mod = NULL;

   /* it is assumed that the users list in the module structure
      will already be empty, or we cannot have gotten to this
      point
   */
   AST_LIST_LOCK(&module_list);
   AST_LIST_TRAVERSE_SAFE_BEGIN(&module_list, mod, entry) {
      if (mod->info == info) {
         AST_LIST_REMOVE_CURRENT(&module_list, entry);
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&module_list);

   if (mod) {
      AST_LIST_HEAD_DESTROY(&mod->users);
      free(mod);
   }
}

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

References __ast_module_user_hangup_all(), ast_clear_flag, AST_FORCE_FIRM, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_test_flag, ast_update_use_count(), error(), find_resource(), FLAG_DECLINED, FLAG_RUNNING, ast_module::lib, and ast_module::usecount.

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

{
   struct ast_module *mod;
   int res = -1;
   int error = 0;

   AST_LIST_LOCK(&module_list);

   if (!(mod = find_resource(resource_name, 0))) {
      AST_LIST_UNLOCK(&module_list);
      return 0;
   }

   if (!ast_test_flag(mod, FLAG_RUNNING | FLAG_DECLINED))
      error = 1;

   if (!mod->lib) {
      ast_log(LOG_WARNING, "Unloading embedded modules is not supported.\n");
      error = 1;
   }

   if (!error && (mod->usecount > 0)) {
      if (force)
         ast_log(LOG_WARNING, "Warning:  Forcing removal of module '%s' with use count %d\n",
            resource_name, mod->usecount);
      else {
         ast_log(LOG_WARNING, "Soft unload failed, '%s' has use count %d\n", resource_name,
            mod->usecount);
         error = 1;
      }
   }

   if (!error) {
      __ast_module_user_hangup_all(mod);
      res = mod->info->unload();

      if (res) {
         ast_log(LOG_WARNING, "Firm unload failed for %s\n", resource_name);
         if (force <= AST_FORCE_FIRM)
            error = 1;
         else
            ast_log(LOG_WARNING, "** Dangerous **: Unloading resource anyway, at user request\n");
      }
   }

   if (!error)
      ast_clear_flag(mod, FLAG_RUNNING | FLAG_DECLINED);

   AST_LIST_UNLOCK(&module_list);

#if LOADABLE_MODULES
   if (!error)
      unload_dynamic_module(mod);
#endif

   if (!error)
      ast_update_use_count();

   return res;
}

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

{
   struct ast_module *cur;
   int unlock = -1;
   int total_mod_loaded = 0;

   if (AST_LIST_TRYLOCK(&module_list))
      unlock = 0;

   AST_LIST_TRAVERSE(&module_list, cur, entry) {
      total_mod_loaded += modentry(cur->resource, cur->info->description, cur->usecount, like);
   }

   if (unlock)
      AST_LIST_UNLOCK(&module_list);

   return total_mod_loaded;
}

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

{
   /* Notify any module monitors that the use count for a
      resource has changed */
   struct loadupdate *m;

   AST_LIST_LOCK(&module_list);
   AST_LIST_TRAVERSE(&updaters, m, entry)
      m->updater();
   AST_LIST_UNLOCK(&module_list);
}

---