Module ocs_event_log

Description
Data Types
Function Index
Function Details

This gen_event behaviour callback module implements an event handler of the ocs application.

Behaviours: gen_event.

Description

This gen_event behaviour callback module implements an event handler of the ocs application.

Data Types

state()

state() = #state{profile = atom(), callback = string(), fsm = pid(), type = atom(), established = boolean(), pending = boolean(), options = [{atom(), term()}]}

Function Index

notify/2	Send a notification event.
init/1	Initialize the ocs_event_log server.
handle_event/2	Handle a request sent using gen_event:notify/2, gen_event:sync_notify/2.
handle_call/2	Handle a request sent using gen_event:call/3,4.
handle_info/2	Handle a received message.
terminate/2	Cleanup and exit.
code_change/3	Update internal state data during a release upgrade/downgrade.
pending_result/3	Handle async result of httpc:request/5 while session pending.
established_result/1	Handle async result of httpc:request/5 while session established.

Function Details

notify/2

notify(EventType, EventPayLoad) -> ok

EventType = ocs_auth | ocs_acct
EventPayLoad = ocs_log:auth_event() | ocs_log:acct_event()

Send a notification event.

The EventPayload should contain the entire new resource (create), the updated attributes only (attributeValueChange) or only id and href (remove).

init/1

init(Args) -> Result

Args = list()
Result = {ok, State} | {ok, State, hibernate} | {error, State::term()}
State = state()

Initialize the ocs_event_log server.

See also: //stdlib/gen_event:init/1.

handle_event/2

handle_event(Event, State) -> Result

Event = term()
State = state()
Result = {ok, NewState} | {ok, NewState, hibernate} | {swap_handler, Args1, NewState, Handler2, Args2} | remove_handler
NewState = state()
Args1 = term()
Args2 = term()
Handler2 = Module2 | {Module2, Id}
Module2 = atom()
Id = term()

Handle a request sent using gen_event:notify/2, gen_event:sync_notify/2.

handle_call/2

handle_call(Request, State) -> Result

Request = term()
State = state()
Result = {ok, Reply::term(), NewState} | {ok, Reply::term(), NewState, hibernate} | {swap_handler, Reply::term(), Args1::term(), NewState, Handler2::Module2 | {Module2, Id}, Args2::term()} | {remove_handler, Reply::term()}
NewState = state()
Module2 = atom()
Id = term()

Handle a request sent using gen_event:call/3,4.

See also: //stdlib/gen_event:handle_call/3.

handle_info/2

handle_info(Info, Fsm) -> Result

Info = term()
Fsm = pid()
Result = {ok, NewState::term()} | {ok, NewState::term(), hibernate} | {swap_handler, Args1::term(), NewState::term(), Handler2, Args2::term()} | remove_handler
Handler2 = Module2 | {Module2, Id}
Module2 = atom()
Id = term()

Handle a received message.

See also: //stdlib/gen_event:handle_info/2.