Module ocs_diameter_3gpp_ro_nrf_app_cb

Description
Data Types
Function Index
Function Details

This gen_server behaviour callback module receives diameter messages for the 3GPP Ro application and interworks with a rating function (RF) over the 3GPP Re interface using the Nrf Open API.

References

3GPP TS 29.299 Diameter charging applications
RFC4006 - DIAMETER Credit-Control Application
Nrf_Rating

Description

This gen_server behaviour callback module receives diameter messages for the 3GPP Ro application and interworks with a rating function (RF) over the 3GPP Re interface using the Nrf Open API.

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/4	Invoked when the peer connection is available.
peer_down/4	Invoked when the peer connection is not available.
pick_peer/5	Invoked as a consequence of a call to diameter:call/4 to select a destination peer for an outgoing request.
prepare_request/4	Invoked to return a request for encoding and transport.
prepare_retransmit/4	Invoked to return a request for encoding and retransmission.
handle_answer/5	Invoked when an answer message is received from a peer.
handle_error/5	Invoked when an error occurs before an answer message is received in response to an outgoing request.
handle_request/4	Invoked when a request message is received from the peer.
request/4*	Handle received request.
errors/4*	Handle errors in requests.
process_request/5*	Process a received DIAMETER Accounting packet.
subscriber_id/3*	Get filtered subscriber IDs in priority order.
post_request_ecur/10*	POST ECUR rating data to a Nrf Rating Server.
post_request_iec/8*	POST IEC rating data to a Nrf Rating Server.
post_request_scur/9*	POST SCUR rating data to a Nrf Rating Server.
get_destination/1*	Get Requested Party Address.
get_service_location/1*	Get MCC and MNC location information.
insert_ref/3*	Insert a rating Data ref.
build_mscc/2*	Build a list of CCA MSCCs.
map_service_rating/2*	Convert a service rating struct list to list of maps.
tariff_element/2*
build_container/1*	Build a container for CCR MSCC.
iec_service_rating/4*
used_unit/1*
used_unit1/2*
used_unit2/2*
used_unit3/2*
used_unit4/2*
reserved_unit/1*
reserved_unit1/2*
reserved_unit2/2*
reserved_unit3/2*
reserved_unit4/2*
update_service_rating/3*
final_service_rating/3*
match_tariff/2*	Match a Tariff object with an MSCC.
fui/1*	Parse redirect server address.
accounting_event_type/1*	Converts CC-Request-Type integer value to a readable atom.

Function Details

peer_up/4

peer_up(ServiceName, Peer, State, Config) -> NewState

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

Invoked when the peer connection is available

peer_down/4

peer_down(ServiceName, Peer, State, Config) -> NewState

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

Invoked when the peer connection is not available

pick_peer/5

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

LocalCandidates = [peer()]
RemoteCandidates = [peer()]
ServiceName = diameter:service_name()
State = state()
Config = map()
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/4

prepare_request(Packet, ServiceName, Peer, Config) -> Action

Packet = packet()
ServiceName = diameter:service_name()
Peer = peer()
Config = map()
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/4

prepare_retransmit(Packet, ServiceName, Peer, Config) -> Action

Packet = packet()
ServiceName = diameter:service_name()
Peer = peer()
Config = map()
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/5

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

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

Invoked when an answer message is received from a peer.

handle_error/5

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

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

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

handle_request/4

handle_request(Packet, ServiceName, Peer, Config) -> Action

Packet = packet()
ServiceName = term()
Peer = peer()
Config = map()
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/4 *

request(Svc, Capabilities, Request, Config) -> Action

Svc = atom()
Capabilities = capabilities()
Request = message()
Config = map()
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 accounting port server matching the service the request was received on.

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/5 *

process_request(IpAddress, Port, Caps, Request, Config) -> Result

IpAddress = inet:ip_address()
Port = inet:port_number()
Request = #'3gpp_ro_CCR'{}
Config = map()
Caps = capabilities()
Result = packet() | message()

Process a received DIAMETER Accounting packet.

subscriber_id/3 *

subscriber_id(SubscriptionIDs, UserName, SubIdTypes) -> Result

SubscriptionIDs = [#'3gpp_ro_Subscription-Id'{}]
UserName = [binary()]
SubIdTypes = [SubIdType] | undefined
SubIdType = imsi | msisdn | nai | sip | private
Result = {SubscriberIDs, SubscriptionIds}
SubscriberIDs = [binary()]
SubscriptionIds = [string()]

Get filtered subscriber IDs in priority order.

post_request_ecur/10 *

post_request_ecur(ServiceName, SubscriptionId, ServiceContextId, SessionId, ServiceRatingData, Amounts, Location, Destination, URL, Flag) -> Result

ServiceName = {IpAddress, Port}
IpAddress = inet:ip_address()
Port = inet:port_number()
SubscriptionId = [string()]
ServiceContextId = binary()
SessionId = binary()
ServiceRatingData = [MSCC] | [PLA]
MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]
PLA = map()
Amounts = [{ServiceIdentifier, RatingGroup, UsedAmounts, ReserveAmounts}] | []
ServiceIdentifier = [pos_integer()]
RatingGroup = [pos_integer()]
UsedAmounts = [{Units, pos_integer()}]
ReserveAmounts = [{Units, pos_integer()}]
Units = octets | seconds | messages
Location = [tuple()] | undefined
Flag = {initial, Class} | interim | final
Class = a | b
Destination = string()
URL = string()
Result = {ok, Body} | {error, Reason}
Body = string()
Reason = term()

POST ECUR rating data to a Nrf Rating Server.

post_request_iec/8 *

post_request_iec(ServiceName, SubscriptionId, ServiceContextId, SessionId, MSCC, Location, Destination, URL) -> Result

ServiceName = {IpAddress, Port}
IpAddress = inet:ip_address()
Port = inet:port_number()
SubscriptionId = [string()]
ServiceContextId = binary()
SessionId = binary()
MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}] | []
Location = [tuple()]
Destination = string()
URL = string()
Result = {ok, Body} | {error, Reason}
Body = string()
Reason = term()

POST IEC rating data to a Nrf Rating Server.

post_request_scur/9 *

post_request_scur(ServiceName, SubscriptionId, ServiceContextId, SessionId, ServiceRatingData, Amounts, Location, URL, Flag) -> Result

ServiceName = {IpAddress, Port}
IpAddress = inet:ip_address()
Port = inet:port_number()
SubscriptionId = [string()]
ServiceContextId = binary()
SessionId = binary()
ServiceRatingData = [MSCC] | [PLA] | undefined
MSCC = #'3gpp_ro_Multiple-Services-Credit-Control'{}
PLA = map()
Amounts = [{ServiceIdentifier, RatingGroup, UsedAmounts, ReserveAmounts}] | []
ServiceIdentifier = [pos_integer()]
RatingGroup = [pos_integer()]
UsedAmounts = [{Units, pos_integer()}]
ReserveAmounts = [{Units, pos_integer()}]
Units = octets | seconds | messages
Location = [tuple()] | []
URL = string()
Flag = {initial, Class} | interim | final
Class = a | b
Result = {ok, Body} | {error, Reason}
Body = string()
Reason = term()

POST SCUR rating data to a Nrf Rating Server.

get_destination/1 *

get_destination(ServiceInformation) -> RequestedPartyAddress

ServiceInformation = [#'3gpp_ro_Service-Information'{}]
RequestedPartyAddress = string()

Get Requested Party Address.

get_service_location/1 *

get_service_location(ServiceInformation) -> ServiceInformation

ServiceInformation = [#'3gpp_ro_Service-Information'{}] | tuple()

Get MCC and MNC location information.

insert_ref/3 *

insert_ref(SessionId, SessionState, PLAs) -> Result

SessionId = binary()
SessionState = Location | ServiceRatings
PLAs = [PLA] | undefined
PLA = map()
Location = string()
ServiceRatings = [Tariff]
Tariff = #{destinationId => string(), lastModified := integer(), ratingFunction := string(), ratingGroup => 0..4294967295, serviceId => 0..4294967295, serviceContextId := string(), expiryTime => 0..4294967295, currentTariff := TariffElement, nextTariff => TariffElement}
TariffElement = #{currencyCode => integer(), rateElements := RateElement}
RateElement = #{unitType := UnitType, unitSize := UnitSize, unitCost := UnitCost}
UnitSize = #{valueDigits := pos_integer(), exponent => integer()}
UnitCost = #{valueDigits := integer(), exponent => integer()}
UnitType = octets | seconds | messages
Result = ok | {error, Reason}
Reason = term()

Insert a rating Data ref.

build_mscc/2 *

build_mscc(ServiceRatings, Container) -> Result

ServiceRatings = [ServiceRating]
ServiceRating = #{finalResultCode => pos_integer(), grantedUnit => #'3gpp_ro_Granted-Service-Unit'{}, consumedUnit => #'3gpp_ro_Used-Service-Unit'{}, ratingGroup => pos_integer(), resultCode => pos_integer(), serviceId => pos_integer(), serviceContextId => string()}
Container = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]
Result = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]

Build a list of CCA MSCCs

map_service_rating/2 *

map_service_rating(ServiceRating, SessionId) -> Result

ServiceRating = [{struct, [tuple()]}]
SessionId = binary() | undefined
Result = {[map()], ResultCode}
ResultCode = integer()

Convert a service rating struct list to list of maps.

tariff_element/2 *

tariff_element(T, Acc) -> any()

build_container/1 *

build_container(MSCC) -> MSCC

MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]

Build a container for CCR MSCC.

iec_service_rating/4 *

iec_service_rating(MSCC, ServiceContextId, ServiceInformation, Destination) -> ServiceRating

MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]
ServiceContextId = list()
ServiceInformation = [tuple()]
Destination = string()
ServiceRating = [{struct, [tuple()]}]
Destination = string()

used_unit/1 *

used_unit(UsedServiceUnits) -> Result

UsedServiceUnits = [#'3gpp_ro_Used-Service-Unit'{}] | []
Result = [{Units, Value}] | []
Units = [Unit]
Unit = time | downlinkVolume | uplinkVolume | totalVolume | serviceSpecificUnit
Value = pos_integer()

RequestedServiceUnits = [#'3gpp_ro_Requested-Service-Unit'{}] | []
Result = [{Units, Value}] | []
Units = [Unit]
Unit = time | downlinkVolume | uplinkVolume | totalVolume | serviceSpecificUnit
Value = pos_integer()

MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]
ServiceContextId = string()
ServiceInformation = [tuple()]
ServiceRating = [{struct, [tuple()]}]

final_service_rating/3 *

final_service_rating(MSCC, ServiceContextId, ServiceInformation) -> ServiceRating

MSCC = [#'3gpp_ro_Multiple-Services-Credit-Control'{}]
ServiceContextId = string()
ServiceInformation = [tuple()]
ServiceRating = [{struct, [tuple()]}]

match_tariff/2 *

match_tariff(Tariffs, MSCCs) -> Result

Tariffs = [map()]
MSCCs = [{ServiceIdentifier, RatingGroup, UsedAmounts, ReserveAmounts}]
ServiceIdentifier = [pos_integer()]
RatingGroup = [pos_integer()]
UsedAmounts = [{Units, pos_integer()}]
ReserveAmounts = [{Units, pos_integer()}]
Units = octets | seconds | messages
Result = Prices | {error, missing_tariff}
Prices = [Price]
Price = map()

Match a Tariff object with an MSCC

fui/1 *

fui(RedirectServerAddress) -> Result

RedirectServerAddress = string()
Result = [#'3gpp_ro_Final-Unit-Indication'{}]

Parse redirect server address.

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