Asterisk - The Open Source Telephony Project: ast_module Struct Reference

Asterisk - The Open Source Telephony Project 18.5.0

Collaboration diagram for ast_module:

Collaboration graph

[legend]

Data Fields
struct ast_vector_string	enhances

struct {
struct ast_module * first

struct ast_module * last

}	entry

struct {
unsigned int builtin:1

unsigned int declined:1

unsigned int keepuntilshutdown:1

unsigned int preload:1

unsigned int required:1

unsigned int running:1

}	flags

const struct ast_module_info *	info

void *	lib

struct ast_vector_string	optional_modules

void *	ref_debug

struct module_vector	reffed_deps
	Vector holding pointers to modules we have a reference to. More...

struct ast_vector_string	requires

char	resource [0]

int	usecount

struct module_user_list	users

Detailed Description

Examples:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 293 of file loader.c.

Field Documentation

◆ builtin

unsigned int builtin

The module is built-in.

Definition at line 326 of file loader.c.

Referenced by ast_module_register(), loader_builtin_init(), module_destroy(), and start_resource().

◆ declined

unsigned int declined

The module has declined to start.

Definition at line 322 of file loader.c.

Referenced by ast_module_reload(), ast_unload_resource(), load_modules(), load_resource(), module_matches_helper_type(), module_reffed_deps_add_dep_enhancers(), modules_shutdown(), resource_list_recursive_decline(), start_resource(), and start_resource_list().

◆ enhances

struct ast_vector_string enhances

List of modules this enhances.

Definition at line 309 of file loader.c.

Referenced by ast_module_register(), load_dlopen(), module_deps_reference(), module_destroy(), module_post_register(), and module_reffed_deps_add_dep_enhancers().

◆ entry

struct { ... } entry

◆ first

struct ast_module* first

Definition at line 332 of file loader.c.

◆ flags

◆ info

◆ keepuntilshutdown

unsigned int keepuntilshutdown

This module is being held open until it's time to shutdown.

Definition at line 324 of file loader.c.

Referenced by __ast_module_shutdown_ref(), and modules_shutdown().

◆ last

struct ast_module* last

Definition at line 332 of file loader.c.

◆ lib

void* lib

The shared lib.

Definition at line 298 of file loader.c.

Referenced by is_module_loaded(), load_dlopen(), load_dynamic_module(), and unload_dynamic_module().

◆ optional_modules

struct ast_vector_string optional_modules

List of optional api modules.

Definition at line 307 of file loader.c.

Referenced by ast_module_register(), load_dlopen(), module_deps_reference(), module_destroy(), and module_post_register().

◆ preload

unsigned int preload

This module is marked for preload.

Definition at line 330 of file loader.c.

Referenced by load_resource(), and module_vector_cmp().

◆ ref_debug

void* ref_debug

Used to get module references into refs log

Definition at line 296 of file loader.c.

Referenced by __ast_module_ref(), __ast_module_unref(), __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_module_register(), and module_destroy().

◆ reffed_deps

struct module_vector reffed_deps

Vector holding pointers to modules we have a reference to.

When one module requires another, the required module gets added to this list with a reference.

Definition at line 317 of file loader.c.

Referenced by ast_module_register(), module_destroy(), and module_reffed_deps_add().

◆ required

unsigned int required

The admin has declared this module is required.

Definition at line 328 of file loader.c.

Referenced by Parameter::load(), Property::load(), load_resource(), resource_list_recursive_decline(), start_resource(), and start_resource_attempt().

◆ requires

struct ast_vector_string requires

List of required module names.

Definition at line 305 of file loader.c.

Referenced by ast_module_register(), load_dlopen(), module_deps_reference(), module_destroy(), and module_post_register().

◆ resource

char resource[0]

Definition at line 333 of file loader.c.

Referenced by ast_module_helper(), ast_module_register(), ast_module_reload(), ast_unload_resource(), ast_update_module_list(), ast_update_module_list_condition(), ast_update_module_list_data(), find_resource(), inspect_module(), load_dlopen(), load_modules(), loader_builtin_init(), module_vector_cmp(), module_vector_strcasecmp(), modules_shutdown(), start_resource(), and start_resource_attempt().

◆ running

unsigned int running

The module running and ready to accept requests.

Definition at line 320 of file loader.c.

Referenced by __ast_module_running_ref(), ast_module_reload(), ast_unload_resource(), ast_update_module_list(), ast_update_module_list_condition(), ast_update_module_list_data(), load_modules(), load_resource(), module_deps_process_reqlist(), module_load_helper_on_file(), module_matches_helper_type(), module_reffed_deps_add(), modules_shutdown(), and start_resource().

◆ usecount

int usecount

Number of 'users' and other references currently holding the module.

Definition at line 300 of file loader.c.

Referenced by __ast_module_ref(), __ast_module_unref(), __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_module_unregister(), ast_unload_resource(), ast_update_module_list(), ast_update_module_list_condition(), ast_update_module_list_data(), module_matches_helper_type(), and modules_shutdown().

◆ users

struct module_user_list users

List of users holding the module.

Definition at line 302 of file loader.c.

Referenced by __ast_module_user_add(), __ast_module_user_hangup_all(), __ast_module_user_remove(), ast_module_register(), and module_destroy().

The documentation for this struct was generated from the following file:

loader.c