Module ocs_diameter_3gpp_gx_application_cb

Description
Data Types
Function Index
Function Details

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

References

3GPP TS 29.212 Policy and Charging Control (PCC); Reference points

Description

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

Data Types

peer()

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

resource_char()

resource_char() = #resource_char{name = string() | undefined | '_', class_type = string() | undefined | '_', schema = string() | undefined | '_', value = term() | undefined | '_'}

resource_rel() = #resource_rel{id = string() | undefined | '_', href = string() | undefined | '_', name = string() | undefined | '$4' | '_', type = string() | undefined | '_', referred_type = string() | undefined | '_'}

specification_ref()

specification_ref() = #specification_ref{id = string() | undefined | '_' | '$3', href = string() | undefined | '_', name = string() | undefined | '_', version = string() | undefined | '_'}

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.
errors/4*	Handle errors in requests.
process_request/4	Process a received DIAMETER Accounting packet.
charging_rule/1*	Parse a list of PCRF polcies.
subscriber_id/2*	Get Subscribers From Diameter SubscriberId AVP.
accounting_event_type/1*	Converts CC-Request-Type integer value to a readable atom.

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.

errors/4 *

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

ServiceName = atom()
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.

process_request/4

process_request(Address, Port, Caps, Request) -> Result

Address = inet:ip_address()
Port = inet:port_number()
Request = #'3gpp_gx_CCR'{}
Caps = capabilities()
Result = packet() | message()

Process a received DIAMETER Accounting packet.

charging_rule/1 *

charging_rule(PolicyResList) -> Result

PolicyResList = [#resource{id = string() | undefined | '$1' | '_', href = string() | undefined | '_', name = string() | undefined | '_' | '$2', description = string() | undefined | '_', category = string() | undefined | '_', class_type = string() | undefined | '_', base_type = string() | undefined | '_', schema = string() | undefined | '_', state = string() | undefined | '_', substate = string() | undefined | '_', version = string() | undefined | '_', start_date = pos_integer() | undefined | '_', end_date = pos_integer() | undefined | '_', last_modified = {TS::pos_integer(), N::pos_integer()} | undefined | '_', related = [resource_rel()] | '_', specification = specification_ref() | undefined | '_', characteristic = [resource_char()] | '_'}]
Result = [#'3gpp_gx_Charging-Rule-Install'{}]

Parse a list of PCRF polcies

subscriber_id/2 *

subscriber_id(SubscriberIdAVPs, SubIdTypes) -> Subscriber

SubscriberIdAVPs = [#'3gpp_gx_Subscription-Id'{}]
SubIdTypes = [SubIdType] | undefined
SubIdType = imsi | msisdn | nai | sip | private
Subscriber = binary() | []

Get Subscribers From Diameter SubscriberId AVP.

accounting_event_type/1 *

accounting_event_type(RequestType) -> EventType

RequestType = 1..4
EventType = start | interim | stop | event

Converts CC-Request-Type integer value to a readable atom.

Generated by EDoc