Modules

All modules must have at least the following:

Load Module

Module loading including tests for configuration or dependencies. This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE, or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails tests return AST_MODULE_LOAD_FAILURE. If the module can not load the configuration file or other non-critical problem return AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.

Example:

Unload Module

The module will soon be unloaded. If any channels are using your features, you should give them a softhangup in an effort to keep the program from crashing. Generally, unload_module is only called when the usecount is 0 or less, but the user can force unloading at their discretion, and thus a module should do its best to comply (although in some cases there may be no way to avoid a crash). This function should return 0 on success and non-zero on failure (i.e. it cannot yet be unloaded).

Example:

Module Information

AST_MODULE_INFO_STANDARD

• keystr - Applicable license for module. In most cases this is ASTERISK_GPL_KEY.
• desc - Description of module.

AST_MODULE_INFO

• keystr
• flags_to_set
• desc
• load_func
• unload_func
• reload_func
• load_pri