Module ocs_deregister_fsm

Description
Data Types
Function Index
Function Details

This gen_fsm behaviour callback module implements procedures for deregistration of user equipment (UE) in non-3GPP access networks.

Behaviours: gen_fsm.

References

3GPP TS 29.273 - 3GPP EPS AAA interfaces

Description

This gen_fsm behaviour callback module implements procedures for deregistration of user equipment (UE) in non-3GPP access networks.

statedata() = #statedata{identity = binary() | undefined, imsi = binary() | undefined, origin_host = binary(), origin_realm = binary(), server_address = inet:ip_address(), server_port = pos_integer(), client_address = undefined | inet:ip_address(), client_port = undefined | pos_integer(), service = tuple() | undefined, hss_realm = string() | undefined, hss_host = string() | undefined, request = #'3gpp_swx_RTR'{} | undefined, session_id = string(), sessions = [#session{id = diameter:'OctetString'() | radius_attributes:attributes(), imsi = binary(), identity = binary() | undefined, application = pos_integer() | undefined, nas_host = string() | undefined, nas_realm = string() | undefined, nas_address = inet:ip_address() | undefined, hss_host = string() | undefined, hss_realm = string() | undefined, user_profile = tuple() | undefined, last_modified = tuple() | undefined}] | undefined, from = {pid(), reference()} | undefined}

Function Index

init/1	Initialize the ocs_deregister_fsm finite state machine.
idle/3	Handle events sent with gen_fsm:sync_send_event/2 in the idle state.
abort/2	Handle events sent with gen_fsm:send_event/2 in the abort state.
handle_event/3	Handle an event sent with gen_fsm:send_all_state_event/2.
handle_sync_event/4	Handle an event sent with gen_fsm:sync_send_all_state_event/2,3.
handle_info/3	Handle a received message.
terminate/3	Cleanup and exit.
code_change/4	Update internal state data during a release upgrade/downgrade.

Function Details

init/1

init(Args) -> Result

Args = list()
Result = {ok, StateName, StateData} | {ok, StateName, StateData, Timeout} | {ok, StateName, StateData, hibernate} | {stop, Reason} | ignore
StateName = atom()
StateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = term()

Initialize the ocs_deregister_fsm finite state machine.

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

idle/3

idle(Event, From, StateData) -> Result

Event = timeout | term()
From = {pid(), reference()}
StateData = statedata()
Result = {reply, Reply, NextStateName, NewStateData} | {reply, Reply, NextStateName, NewStateData, Timeout} | {reply, Reply, NextStateName, NewStateData, hibernate} | {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, Reply, NewStateData} | {stop, Reason, NewStateData}
Reply = term()
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle events sent with gen_fsm:sync_send_event/2 in the idle state. @see //stdlib/gen_fsm:StateName/3

abort/2

abort(Event, StateData) -> Result

Event = timeout | term()
StateData = statedata()
Result = {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, NewStateData}
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle events sent with gen_fsm:send_event/2 in the abort state. @see //stdlib/gen_fsm:StateName/2

handle_event/3

handle_event(Event, StateName, StateData) -> Result

Event = term()
StateName = atom()
StateData = statedata()
Result = {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, NewStateData}
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle an event sent with gen_fsm:send_all_state_event/2.

See also: //stdlib/gen_fsm:handle_event/3.

handle_sync_event/4

handle_sync_event(Event, From, StateName, StateData) -> Result

Event = term()
From = {Pid, Tag}
Pid = pid()
Tag = term()
StateName = atom()
StateData = statedata()
Result = {reply, Reply, NextStateName, NewStateData} | {reply, Reply, NextStateName, NewStateData, Timeout} | {reply, Reply, NextStateName, NewStateData, hibernate} | {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, Reply, NewStateData} | {stop, Reason, NewStateData}
Reply = term()
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle an event sent with gen_fsm:sync_send_all_state_event/2,3.

handle_info/3

handle_info(Info, StateName, StateData) -> Result

Info = term()
StateName = atom()
StateData = statedata()
Result = {next_state, NextStateName, NewStateData} | {next_state, NextStateName, NewStateData, Timeout} | {next_state, NextStateName, NewStateData, hibernate} | {stop, Reason, NewStateData}
NextStateName = atom()
NewStateData = statedata()
Timeout = non_neg_integer() | infinity
Reason = normal | term()

Handle a received message.

See also: //stdlib/gen_fsm:handle_info/3.

terminate/3

terminate(Reason, StateName, StateData) -> any()

Reason = normal | shutdown | term()
StateName = atom()
StateData = statedata()

Cleanup and exit.

See also: //stdlib/gen_fsm:terminate/3.

code_change/4

code_change(OldVsn, StateName, StateData, Extra) -> Result

OldVsn = Vsn | {down, Vsn}
Vsn = term()
StateName = atom()
StateData = statedata()
Extra = term()
Result = {ok, NextStateName, NewStateData}
NextStateName = atom()
NewStateData = statedata()

Update internal state data during a release upgrade/downgrade.

See also: //stdlib/gen_fsm:code_change/4.

Generated by EDoc