Module ocs_pgw_fsm

Description
Data Types
Function Index
Function Details

This gen_fsm behaviour callback module implements procedures for user authorization initiated by PDN Gateway (PGW).

Behaviours: gen_fsm.

References

3GPP TS 29.273 - 3GPP EPS AAA interfaces

Description

This gen_fsm behaviour callback module implements procedures for user authorization initiated by PDN Gateway (PGW).

statedata() = #statedata{identity = binary() | undefined, imsi = binary() | undefined, user_profile = #'3gpp_swx_Non-3GPP-User-Data'{} | undefined, orig_host = diameter:'OctetString'(), orig_realm = diameter:'OctetString'(), server_address = inet:ip_address(), server_port = pos_integer(), client_address = inet:ip_address(), client_port = pos_integer(), service = tuple(), hss_realm = diameter:'OctetString'() | undefined, hss_host = [diameter:'OctetString'()], pgw_realm = diameter:'OctetString'() | undefined, pgw_host = diameter:'OctetString'(), pgw_id = [#'3gpp_swx_MIP6-Agent-Info'{}], pgw_plmn = [diameter:'OctetString'()], request = #'3gpp_s6b_AAR'{} | undefined, session_id = string(), apn_context = pos_integer() | undefined, apn_name = string() | undefined, from = {pid(), reference()} | undefined}

Function Index

init/1	Initialize the ocs_pgw_fsm finite state machine.
idle/3	Handle events sent with gen_fsm:sync_send_event/2 in the idle state.
register/2	Handle events sent with gen_fsm:send_event/2 in the register state.
profile/2	Handle events sent with gen_fsm:send_event/2 in the profile 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.
pgw_id/1*	Get the PGWID hostname.
agent_info/1*

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_pgw_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

register/2

register(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 register state. @see //stdlib/gen_fsm:StateName/2

profile/2

profile(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 profile 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.