#include <module.h>
Data Fields | |
| int(* | backup_globals )(void) |
| const char | buildopt_sum [33] |
| const char * | description |
| unsigned int | flags |
| const char * | key |
| enum ast_module_load_result(* | load )(void) |
| unsigned char | load_pri |
| const char * | name |
| const char * | nonoptreq |
| int(* | reload )(void) |
| void(* | restore_globals )(void) |
| struct ast_module * | self |
| int(* | unload )(void) |
Field Documentation
| int(* backup_globals)(void) |
for embedded modules, backup global data
Definition at line 222 of file module.h.
Referenced by load_resource().
| const char buildopt_sum[33] |
The value of AST_BUILDOPT_SUM when this module was compiled
Definition at line 237 of file module.h.
Referenced by inspect_module().
| const char* description |
user friendly description of the module.
Definition at line 225 of file module.h.
Referenced by unload_module(), load_module(), odbc_load_module(), config_module(), ast_module_reload(), inspect_module(), start_resource(), and ast_update_module_list().
| const char* key |
This holds the ASTERISK_GPL_KEY, signifiying that you agree to the terms of the Asterisk license as stated in the ASTERISK_GPL_KEY. Your module will not load if it does not return the EXACT key string.
Definition at line 233 of file module.h.
Referenced by inspect_module().
| enum ast_module_load_result(* load)(void) |
register stuff etc. Optional.
Definition at line 219 of file module.h.
Referenced by start_resource().
| unsigned char load_pri |
This value represents the order in which a module's load() function is initialized. The lower this value, the higher the priority. The value is only checked if the AST_MODFLAG_LOAD_ORDER flag is set. If the AST_MODFLAG_LOAD_ORDER flag is not set, this value will never be read and the module will be given the lowest possible priority on load.
Definition at line 244 of file module.h.
Referenced by mod_load_cmp().
| const char* name |
| const char* nonoptreq |
Modules which should be loaded first, in comma-separated string format. These are only required for loading, when the optional_api header file detects that the compiler does not support the optional API featureset.
Definition at line 249 of file module.h.
Referenced by load_dynamic_module().
| int(* reload)(void) |
config etc. Optional.
Definition at line 220 of file module.h.
Referenced by ast_module_helper(), and ast_module_reload().
| void(* restore_globals)(void) |
for embedded modules, restore global data
Definition at line 223 of file module.h.
Referenced by ast_unload_resource().
| struct ast_module* self |
The 'self' pointer for a module; it will be set by the loader before it calls the module's load_module() entrypoint, and used by various other macros that need to identify the module.
Definition at line 218 of file module.h.
Referenced by unload_module(), load_module(), alsa_hangup(), alsa_new(), my_module_ref(), my_module_unref(), dahdi_hangup(), dahdi_new(), dahdi_destroy_channel_bynum(), gtalk_new(), gtalk_hangup(), oh323_hangup(), __oh323_new(), iax2_predestroy(), ast_iax2_new(), mgcp_hangup(), mgcp_new(), oss_hangup(), oss_new(), phone_hangup(), phone_new(), phone_check_exception(), sip_cc_monitor_destructor(), sip_handle_cc(), sip_hangup(), sip_new(), skinny_hangup(), skinny_new(), usbradio_hangup(), usbradio_new(), ast_agi_register(), ast_agi_unregister(), agi_handle_command(), handle_orig(), handle_cli_file_convert(), ast_fax_tech_register(), ast_fax_tech_unregister(), moh_files_alloc(), moh_alloc(), local_ast_moh_cleanup(), destroy_callback(), mute_add_audiohook(), ast_smdi_interface_destroy(), smdi_load(), ast_srtp_create(), and ast_srtp_destroy().
| int(* unload)(void) |
unload. called with the module locked
Definition at line 221 of file module.h.
Referenced by ast_module_shutdown(), and ast_unload_resource().
The documentation for this struct was generated from the following file:
