ejabberd模块开发

ejabberd模块开发

ejabberd内部模块以插件的形式工作。每一个模块都是一个Erlang模块，模块名以"mod_"开头。gen_mod 是ejabberd中的一种行为模式。如同Erlang/OTP中的gen_server，gen_fsm,gen_event行为模式一样，gen_mod也预定义了一些到处函数。在自己写的模块中加上行为模式声明语句：-behaviour(gen_mod).之后系统就会在启动的时候自动启动该模块。所有的内部模块都必须使用gen_mod行为模式。该行为模式提供了以下的API:

start(Host, Opts) -> ok
stop(Host) -> ok
% Host = string()
% Opts = [{Name, Value}]
% Name = Value = string() 

Host是运行该模块的虚拟主机的IP或者主机名。Opts是传递给模块的参数，一般该参数在配置文件ejabberd.yml中定义。

start/2，stop/1函数会在系统启动活停止的时候，由系统自动调用。

编写好模块，编译没有错误之后就可以将生成的目标文件放进系统的目标文件目录，如果ejabberd是编译安装的话，这个目录一般是"InstallRootDirectory/lib/ebin/目录。或者直接执行make,make install即可。接着需要在配置文件ejabberd.yml中声明该模块，配置文件中没有配置的模块默认是不会启动的。例如：

你自己写了一个模块叫做mod_misc.erl。那么你需要在配置文件ejabberd.yml中加上一句：mod_misc: {}

直接加在mod_version: {}的下面一行即可，配置文件的写法必须严格安照yaml语言的语法格式来书写，否则ejabberd是不识别的。这样的话，系统启动之时就会调用Module:start/2函数，启动该模块。