说明
最近笔者在学习otp行为模式,在查阅相关资料时发现网上有关erlang的资料不是很多,也不够详细。在参考官方文档以及其他作者的文章后,决定写这篇博客。算是自己对知识的复习,也为诸君提供一些参考。
1.gen_event 简介
Gen_event实现了通用事件处理,通过其提供的标准接口方法以及回调函数,在OTP里面的事件处理模块是由一块通用的事件管理器和任意数量的事件处理器,并且这些事件处理器可以动态的添加和删除。一个事件可以用来记录error,alarm,info, warning等信息。一个事件管理器可以安装一个或多个事件处理器,当一个事件管理器接受到一个事件的通知时,这个事件将会被所有的已安装的事件处理器依次处理。
事件管理器是作为一个进程实现的,每个事件处理器都是一个回调模块。且事件管理器实质上是一个{Module,State} 组成的列表,Module是事件处理器,State为该事件处理器内部状态。
2.事件处理器
不多废话,直接上代码,以下为一个事件处理器标准模板,具体函数将在后面做出详细解释。事件处理器可以有多个。
-module(info_logger).
-behaviour(gen_event).
%% gen_event callbacks
-export([init/1, handle_event/2, handle_call/2, handle_info/2, terminate/2,
code_change/3]).
-define(SERVER, ?MODULE).
%%%===================================================================
%%% gen_event callbacks
%%%===================================================================
init(State) ->
io:format("**** info_logger init success ****"),
{ok,State }.
handle_event(Event, State) ->
io:format("**** info_logger handle_event **** ~n Event =~p~n",[Event]),
{ok, State}.
handle_call(Request, State) ->
io:format("**** info_logger handle_call **** ~n Request =~p~n",[Request]),
Reply = Request,
{ok, Reply, State}.
handle_info(_Info, State ) ->
{ok, State}.
terminate(Args, _State) ->
io:format("**** info_logger exit success **** ~n Args =~p~n ",[Args]),
ok.
code_change(_OldVsn, State , _Extra) ->
{ok, State}.
2.1 回调函数
- Module:init(InitArgs) -> {ok,State} | {ok,State,hibernate} | {error,Reason}
InitArgs = Args | {Args,Term}
每当一个新的事件处理器添加到一个事件管理器时,这个函数将被调用来初始化这个事件处理器。
如果通过调用gen_event:add_handler/3或gen_event:add_sup_handler/3来添加事件处理器。InitArgs以Args作为参数。
如果事件处理器是通过调用gen_event:swap_handler/3或gen_event:swap_sup_handler来替换另一个事件处理器,InitArgs以{Args,Term}作为参数。
如果初始化成功,将返回{ok,State} | {ok,State,hibernate}.
如果返回{ok,State,hibernate},事件管理器将进入’hibernate’状态,并等待下一个事件发生。
- Module:handle_event(Event, State) -> Result
Result = {ok,NewS