Module ocs_diameter_3gpp_swm_application_cb

Description
Data Types
Function Index
Function Details

This diameter_app behaviour callback module handles diameter messages for the 3GPP DIAMETER SWm application in the cse application.

References

3GPP TS TS 29.273 EPS AAA Interfaces
3GPP TS TS 33.402 Security Aspects of non-3GPP Accesses

Description

This diameter_app behaviour callback module handles diameter messages for the 3GPP DIAMETER SWm application in the cse application.

Data Types

capabilities()

capabilities() = #diameter_caps{}

message()

message() = tuple() | list()

packet()

packet() = #diameter_packet{}

peer()

peer() = {Peer_Ref::term(), Capabilities::capabilities()}

state()

state() = #state{}

Function Index

peer_up/3	Invoked when the peer connection is available.
peer_down/3	Invoked when the peer connection is not available.
pick_peer/4	Invoked as a consequence of a call to diameter:call/4 to select a destination peer for an outgoing request.
prepare_request/3	Invoked to return a request for encoding and transport.
prepare_retransmit/3	Invoked to return a request for encoding and retransmission.
handle_answer/4	Invoked when an answer message is received from a peer.
handle_error/4	Invoked when an error occurs before an answer message is received in response to an outgoing request.
handle_request/3	Invoked when a request message is received from the peer.
request/3*	Handle received request.
process_request/7*	Process a received DIAMETER Authorization packet.
errors/4*	Handle errors in requests.

Function Details

peer_up/3

peer_up(ServiceName, Peer, State) -> NewState

ServiceName = diameter:service_name()
Peer = peer()
State = state()
NewState = state()

Invoked when the peer connection is available

peer_down/3

peer_down(ServiceName, Peer, State) -> NewState

ServiceName = diameter:service_name()
Peer = peer()
State = state()
NewState = state()

Invoked when the peer connection is not available

pick_peer/4

pick_peer(LocalCandidates, RemoteCandidates, ServiceName, State) -> Result

LocalCandidates = [peer()]
RemoteCandidates = [peer()]
ServiceName = diameter:service_name()
State = state()
NewState = state()
Selection = {ok, Peer} | {Peer, NewState}
Peer = peer() | false
Result = Selection | false

Invoked as a consequence of a call to diameter:call/4 to select a destination peer for an outgoing request.

prepare_request/3

prepare_request(Packet, ServiceName, Peer) -> Action

Packet = packet()
ServiceName = diameter:service_name()
Peer = peer()
Action = Send | Discard | {eval_packet, Action, PostF}
Send = {send, packet() | message()}
Discard = {discard, Reason} | discard
Reason = term()
PostF = diameter:evaluable()

Invoked to return a request for encoding and transport

prepare_retransmit/3

prepare_retransmit(Packet, ServiceName, Peer) -> Action

Packet = packet()
ServiceName = diameter:service_name()
Peer = peer()
Action = Send | Discard | {eval_packet, Action, PostF}
Send = {send, packet() | message()}
Discard = {discard, Reason} | discard
Reason = term()
PostF = diameter:evaluable()

Invoked to return a request for encoding and retransmission. In case of peer connection is lost alternate peer is selected.

handle_answer/4

handle_answer(Packet, Request, ServiceName, Peer) -> Result

Packet = packet()
Request = message()
ServiceName = diameter:service_name()
Peer = peer()
Result = term()

Invoked when an answer message is received from a peer.

handle_error/4

handle_error(Reason, Request, ServiceName, Peer) -> Result

Reason = timeout | failover | term()
Request = message()
ServiceName = diameter:service_name()
Peer = peer()
Result = term()

Invoked when an error occurs before an answer message is received in response to an outgoing request.

handle_request/3

handle_request(Packet, ServiceName, Peer) -> Action

Packet = packet()
ServiceName = term()
Peer = peer()
Action = Reply | {relay, [Opt]} | discard | {eval | eval_packet, Action, PostF}
Reply = {reply, packet() | message()} | {answer_message, 3000..3999 | 5000..5999} | {protocol_error, 3000..3999}
Opt = diameter:call_opt()
PostF = diameter:evaluable()

Invoked when a request message is received from the peer.

request/3 *

request(ServiceName, Capabilities, Request) -> Action

ServiceName = term()
Capabilities = capabilities()
Request = message()
Action = Reply | {relay, [Opt]} | discard | {eval | eval_packet, Action, PostF}
Reply = {reply, packet() | message()} | {answer_message, 3000..3999 | 5000..5999} | {protocol_error, 3000..3999}
Opt = diameter:call_opt()
PostF = diameter:evaluable()

Handle received request. Authorize client then forward capabilities and request to the authorization port server matching the service the request was received on.

process_request/7 *

process_request(ServiceName, Capabilities, ServerAddress, ServerPort, ClientAddress, Trusted, Request) -> Result

ServiceName = term()
Capabilities = capabilities()
ServerAddress = inet:ip_address()
ServerPort = inet:ip_port()
ClientAddress = inet:ip_address()
Trusted = boolean() | undefined
Request = #'3gpp_swm_DER'{} | #'3gpp_swm_STR'{}
Result = {reply, packet()} | discard

Process a received DIAMETER Authorization packet.

errors/4 *

errors(ServiceName, Capabilities, Request, Errors) -> Action

ServiceName = term()
Capabilities = capabilities()
Request = message()
Errors = [Error]
Error = {Code, #diameter_avp{}} | Code
Code = 0..4294967295
Action = Reply | {relay, [Opt]} | discard | {eval | eval_packet, Action, PostF}
Reply = {reply, packet() | message()} | {answer_message, 3000..3999 | 5000..5999} | {protocol_error, 3000..3999}
Opt = diameter:call_opt()
PostF = diameter:evaluable()

Handle errors in requests.

Generated by EDoc