Gen_event行为分析和实践

标签：

1.简介

1.  1 gen_event moduleCallbackmodule
    2 -------------------------------
    3 gen_event:start_link ----->-
    4 gen_event:add_handler
    5 gen_event:add_sup_handler ----->Module:init/1
    6 gen_event:notify
    7 gen_event:sync_notify ----->Module:handle_event/2
    8 gen_event:call ----->Module:handle_call/2
    9 ------>Module:handle_info/2
   10 gen_event:delete_handler ----->Module:terminate/2
   11 gen_event:swap_handler
   12 gen_event:swap_sup_handler ----->Module1:terminate/2
   13 Module2:init/1
   14 gen_event:which_handlers ----->-
   15 gen_event:stop ----->Module:terminate/2
   16 ------>Module:code_change/3

2.函数

2.1 导出函数

start_link() -> Result
start_link(EventMgrName) -> Result

EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName}

Result = {ok,Pid} | {error,{already_started,Pid}}

监控树可以通过调用该方法创建一个事件管理器进程作为一颗监控树的一部分，并连接到监控树。

如果EventMgrName={local,Name},事件管理器在本地被注册为Name通过register/2. 如果EventMgrName={global,GlobalName},事件管理器将在全局被注册为GlobalName通过global:register_name/2.如果没有指定名字,事件管理器将不会被注册.如果EventMgrName={via,Module,ViaName},事件管理器将通过Module被注册为ViaName.Module模块应该导出register_name/2, unregister_name/1, whereis_name/1 and send/2,它的原理与global相似。

如果事件管理器被成功创建将返回{ok，Pid},如果指定名字的事件管理器已经存在将返回{error,{already_started,Pid}}

start() -> Result
start(EventMgrName) -> Result

EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName}

Result = {ok,Pid} | {error,{already_started,Pid}}

创建一个独立与监控树的事件管理器。其参数与start_link/0,1一样。

add_handler(EventMgrRef, Handler, Args) -> Result

EventMgr = Name | {Name,Node} | {global,GlobalName} | {via,Module,ViaName} | pid()

Handler = Module | {Module,Id}

Result = ok | {‘EXIT‘,Reason} | term()

向事件管理器EventMgrRef添加一个事件处理器，事件管理器将通过回调Module:init/1初始化事件处理器和它的内部状态。
EventMgrRef可以是：

• pid
• Name,本地注册的事件管理器名字
• {Name, Node},在本地另一个节点注册的事件管理器名字
• {global,GlobalName},全局注册的事件管理器名字
• {via,Module,ViaName},通过指定模块注册的事件管理器的名字

Handler是一个gen_event回调模块的名字或元组{Module, Id},元组{Module, Id}是一个特别的具有身份Id的gen_event回调模块，用来处理当事件处理器是同样一块gen_event回调模块的情况。

Args是任意的数据类型，用来作为Module:init/1的参数。

如果Module:init/1返回一个正确的值表明成功添加事件处理器，事件管理器的添加函数将返回ok.如果Module:init/1因为Reason失败或返回{error, Reason}，这个事件处理器将被忽略并且该函数返回{‘EXIT‘,Reason}或{error, Reason}.

2.2 回调函数

3.实践

首先通过gen_event:start_link/1启动一个事件管理器：

1.  1 start_link()-> 2 gen_event:start_link({local,?SERVER}). 

同时终止管理器的方法为：

1.  1 stop()-> 2 gen_event:stop(?SERVER). 

当终止事件管理器时会调用事件处理器的Module:terminate(stop, ...),来依次关闭事件处理器。

3.1 添加删除事件

添加事件处理器：

1. 1 add_handler()->
   2 gen_event:add_handler(?SERVER, myevent,[]),
   3 gen_event:add_sup_handler(?SERVER, myerror,[]).

将会调用Module:init/1初始化事件处理器。

删除事件处理器：

1. 1 delete()->
   2 gen_event:delete_handler(?SERVER,myerror,[]).

将会调用Module:terminate/2来终止事件处理器。

3.2 事件消息

1. 1 notity()->
   2 gen_event:notify(?SERVER,liuwei). %%异步通知
   3 notity_sync()->
   4 gen_event:sync_notify(?SERVER,liuwei_sync).   %%同步通知
   5 handle_event(_Event,State)->
   6 timer:sleep(2000),
   7 io:format("Event:~p~n",[_Event]),
   8 {ok,State}.

当返回{ok, NewState}时，事件管理器不变，并更新内部状态。

当返回{swap_handler,Args1,NewState,Handler2,Args2}时，将替换老的事件管理器：

当返回remove_handler时,将删除事件处理器：

3.3 事件交换

1. 1 swap()->
   2 gen_event:swap_handler(?SERVER,{myevent,normal_swap},{myerror,[]}).

首先会调用myevent:terminate(normal_swap, ...)来终止myevent事件处理器，并返回数据Term;然后调用myerror:init({[],Term})来启动myerror事件处理器。

特别注意：新的事件处理器将被添加，即使指定的老的事件处理器未安装(Term=error);或Module1:terminate/2由于Reason失败(Term={‘EXIT‘,Reason}).老的事件处理器将被删除,即使Module2:init/1失败。

       

3.4 监控事件

创建进程与事件管理器的监控连接：

1.  1 %%启动服务器add1
    2 start_link()->
    3 gen_server:start({local,?SERVER},?MODULE,[],[]).
    4 %%启动事件管理器myevent
    5 start_link()->
    6 {Flag,Pid}= gen_event:start_link({local,?SERVER}).
    7 %%添加连接事件处理器
    8 add_sup_handler()->
    9 gen_server:call(?SERVER, add_sup_handler).
   10 handle_call(add_sup_handler,_From,State)->
   11 myevent:add_sup_handler(),
   12 {reply, ok,State};
   13 add_sup_handler()->
   14 gen_event:add_sup_handler(?SERVER, myerror,["add_sup_handler:myerror"]).
   15 %%删除连接的事件处理器
   16 delete()->
   17 gen_event:delete_handler(?SERVER,myerror,[]).
   18 %%接受事件处理器退出信息
   19 handle_info(_Info,State)->
   20 io:format("add1::info:~p~n",[_Info]),
   21 {noreply,State}.

当事件处理器正常删除时（delete_handler/2）：

当因为事件管理器终止时(stop/1)：

当事件处理器因为替换而终止时(swap_handler/2)：

当事件处理器因为error而终止时：

当调用进程终止时（Module:terminate({stop, Reason}, ...)来终止事件处理器）：

gen_event:swap_sup_handler/3与上面一样，当老的事件处理器在替换成新的事件处理器时，将与调用进程间建立监控连接。

当我们在调用gen_event:swap_handler/3时，用老的事件处理器去替换新的事件处理器，当老的事件处理器与一个进程建立监控连接时，这时这个进程将与新的事件处理器建立监控连接：

4.总结

Gen_event行为分析和实践

标签：

原文地址：http://www.cnblogs.com/liuweiccy/p/4658588.html