aboutsummaryrefslogtreecommitdiffstats
path: root/doc/modules.txt
blob: 4f6d4c67b23d004bdbba736e6a39d06b491f5bb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
All modules must have at least the following functions:

int load_module():

	Do what you need to do when you get started.  This function
returns 0 on success and non-zero on failure (it is not considered loaded
if it fails.

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

char *description():

	Return a description of the module's functionality.

int usecnt():
	
	Return the number of channels, etc that are using you.