Files
asterisk/doc/modules.txt
T

27 lines
894 B
Plaintext
Raw Normal View History

1999-10-19 01:52:58 +00:00
All modules must have at least the following functions:
int load_module():
Do what you need to do when you get started. This function
2004-02-15 07:48:46 +00:00
returns 0 on success and non-zero on failure (it is not considered loaded
if it fails.
1999-10-19 01:52:58 +00:00
int 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
2004-02-15 07:48:46 +00:00
discretion, and thus a module should do its best to comply (although in
1999-10-19 01:52:58 +00:00
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).
char *description():
Return a description of the module's functionality.
int usecnt():
Return the number of channels, etc that are using you.