From 8317fec82dc677f299e3772d3d644639f936857a Mon Sep 17 00:00:00 2001
From: Anders Svensson ->
in documentation
The former doesn't allow seealso content, which erl_docgen doesn't
enforce, resulting in mangled PDF.
---
lib/diameter/doc/src/diameter.xml | 76 ++++++++++++++---------------
lib/diameter/doc/src/diameter_app.xml | 8 ++--
lib/diameter/doc/src/diameter_dict.xml | 88 +++++++++++++++++-----------------
3 files changed, 86 insertions(+), 86 deletions(-)
(limited to 'lib')
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index c93a7b2c67..ea540562af 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -110,10 +110,10 @@ defined by the application.
+
Mod = atom()
ExtraArgs = list()
-
+
A module implementing the callback interface defined in
+
eval([{M,F,A} | T]) ->
apply(M, F, T ++ A);
eval([[F|A] | T]) ->
@@ -366,7 +366,7 @@ eval([F|A]) ->
apply(F, A);
eval(F) ->
eval([F]).
-
+
Applying an
+
Ref = transport_ref()
Peer = diameter_app:peer()
Config = {connect|listen, [transport_opt() ]}
Pkt = #diameter_packet{}
-
+
The RFC 3539 watchdog state machine has @@ -556,10 +556,10 @@ respect to individual Diameter applications.
+
Ref = transport_ref()
Opts = [transport_opt() ]
-
+
A connecting transport is attempting to establish/reestablish a @@ -571,10 +571,10 @@ expiry.
+
Ref = transport_ref()
Config = {connect|listen, [transport_opt() ]}
-
+
Capabilities exchange has failed.
@@ -584,13 +584,13 @@ Capabilities exchange has failed.
An incoming CER has been answered with the indicated result code or
@@ -604,11 +604,11 @@ contains the rejecting callback.
An incoming CER contained errors and has been answered with the
@@ -627,12 +627,12 @@ connection establishment.
An incoming CEA has been rejected for the indicated reason.
@@ -647,10 +647,10 @@ contains the rejecting callback.
An incoming CEA contained errors and has been rejected.
@@ -671,12 +671,12 @@ of connection establishment.
An RFC 3539 watchdog state machine has changed state.
+
+
Result = ResultCode | {capabilities_cb, CB, ResultCode|discard}
Caps = #diameter_caps{}
Pkt = #diameter_packet{}
ResultCode = integer()
CB =
+
+
ResultCode = integer()
Caps = #diameter_caps{}
Pkt = #diameter_packet{}
-
+
+
Result = integer() | atom() | {capabilities_cb, CB, ResultCode|discard}
Caps = #diameter_caps{}
Pkt = #diameter_packet{}
ResultCode = integer()
-
+
+
Caps = #diameter_caps{}
Pkt = #diameter_packet{}
-
+
+
Ref =
+
(H bsl N) bor (Id band ((1 bsl N) - 1))
-
+
Note that RFC 3588 requires that End-to-End identifiers remain unique
for a period of at least 4 minutes and that this and the call rate
@@ -980,9 +980,9 @@ Defaults to a single callback returning
+
Tc = Unsigned32()
-
+
For a connecting transport, the RFC 3588 Tc timer, in milliseconds. @@ -1029,12 +1029,12 @@ For example, the following options on a connecting transport request a connection with one peer over SCTP or another (typically the same) over TCP.
-
+
{transport_module, diameter_sctp}
{transport_config, SctpOpts, 5000}
{transport_module, diameter_tcp}
{transport_config, TcpOpts}
-
+
To listen on both SCTP and TCP, define one transport for each.
@@ -1065,10 +1065,10 @@ corresponding timeout (see below) or all fail.
+
TwInit = Unsigned32()
| {M,F,A}
-
+
The RFC 3539 watchdog timer.
@@ -1334,7 +1334,7 @@ marker="#add_transport">add_transport/2 and
+
Pred = fun(transport_ref(), list()): fun(Ref, _, Opts) -> Pred(Ref, Opts) end
Pred = fun(list()): fun(_, _, Opts) -> Pred(Opts) end
Pred = transport_ref(): fun(Ref, _, _) -> Pred == Ref end
@@ -1342,7 +1342,7 @@ Pred = list(): fun(_, _, Opts) -> [] == Pred -- Opts end
Pred = true: fun(_, _, _) -> true end
Pred = false: fun(_, _, _) -> false end
Pred = {M,F,A}: fun(Ref, Type, Opts) -> apply(M, F, [Ref, Type, Opts | A]) end
-
+
Removing a transport causes the corresponding transport processes to @@ -1425,7 +1425,7 @@ An example return value with for a client service with Origin-Host "client.example.com" configured with a single transport connected to "server.example.com" might look as follows.
-
+
[[{ref,#Ref<0.0.0.93>},
{type,connect},
{options,[{transport_module,diameter_tcp},
@@ -1470,7 +1470,7 @@ An example return value with for a client service with Origin-Host
{{{0,258,0},recv,{'Result-Code',2001}},3},
{{{0,280,1},recv},2},
{{{0,280,0},send},2}]}]]
-
+
Here
+
[[{ref,#Ref<0.0.0.61>},
{type,listen},
{options,[{transport_module,diameter_tcp},
@@ -1557,7 +1557,7 @@ connection might look as follows.
{{{0,280,0},send},5},
{{{0,257,1},recv},1},
{{{0,257,0},send},1}]}]]
-
+
The information presented here is as in the
+
[[{ref,#Ref<0.0.0.61>},
{type,accept},
{options,[{transport_module,diameter_tcp},
@@ -1622,7 +1622,7 @@ A return value for the server above might look as follows.
{{{0,280,0},send},66},
{{{0,257,1},recv},1},
{{{0,257,0},send},1}]}]]
-
+
Note that there may be multiple entries with the same
+
[{ref,#Ref<0.0.0.61>},
{type,accept},
{options,[{transport_module,diameter_tcp},
{transport_config,[{reuseaddr,true},
{ip,{127,0,0,1}},
{port,3868}]}]}]
-
+
The argument
+
#diameter_packet{header = #diameter_header{},
avps = [#diameter_avp{}],
msg = record() | undefined,
errors = [Unsigned32() | {Unsigned32() , #diameter_avp{}}],
bin = binary(),
transport_data = term()}
-
+
The
+
{reply, ['answer-message' | Avps]
-
+
where
Example:
-
+
@id 16777231
-
+
Example:
-
+
@name etsi_e2
-
+
Example:
-
+
@prefix etsi_e2
-
+
Example:
-
+
@vendor 13019 ETSI
-
+
Example:
-
+
@avp_vendor_id 2937
WWW-Auth
Domain-Index
Region-Set
-
+
Example:
-
+
@inherits diameter_gen_base_rfc3588
-
+
@@ -268,12 +268,12 @@ none are to be set.
Example:
-
+
@avp_types
Location-Information 350 Grouped MV
Requested-Information 353 Enumerated V
-
+
@@ -298,11 +298,11 @@ encode/decode.
Example:
-
+
@custom_types rfc4005_avps
Framed-IP-Address
-
+
Example:
-
+
@codecs rfc4005_avps
Framed-IP-Address
-
+
+
@messages
RTR ::= < Diameter Header: 287, REQ, PXY >
@@ -363,7 +363,7 @@ RTA ::= < Diameter Header: 287, PXY >
* [ Proxy-Info ]
* [ Route-Record ]
* [ AVP ]
-
+
@@ -378,14 +378,14 @@ section 4.4 of RFC 3588, "Grouped AVP Values".
Example:
-
+
@grouped
SIP-Deregistration-Reason ::= < AVP Header: 383 >
{ SIP-Reason-Code }
[ SIP-Reason-Info ]
* [ AVP ]
-
+
Specifying a Vendor-Id in the definition of a grouped AVP is @@ -408,14 +408,14 @@ otherwise defined in another dictionary.
Example:
-
+
@enum SIP-Reason-Code
PERMANENT_TERMINATION 0
NEW_SIP_SERVER_ASSIGNED 1
SIP_SERVER_CHANGE 2
REMOVE_SIP_SERVER 3
-
+
+
SIP-Deregistration-Reason ::= < AVP Header: 383 >
{ SIP-Reason-Code }
[ SIP-Reason-Info ]
* [ AVP ]
-
+
will result in the following record definition given an empty prefix.
-
+
-record('SIP-Deregistration-Reason' {'SIP-Reason-Code',
'SIP-Reason-Info',
'AVP'}).
-
+
The values encoded in the fields of generated records depends on the @@ -507,7 +507,7 @@ callback upon reception of an incoming request.
+
OctetString() = [0..255]
Integer32() = -2147483647..2147483647
Integer64() = -9223372036854775807..9223372036854775807
@@ -516,7 +516,7 @@ Unsigned64() = 0..18446744073709551615
Float32() = '-infinity' | float() | infinity
Float64() = '-infinity' | float() | infinity
Grouped() = record()
-
+
On encode, an OctetString() can be specified as an iolist(), @@ -530,10 +530,10 @@ section.
Derived AVP Data Formats
+
Address() = OctetString()
| tuple()
-
+
On encode, an OctetString() IPv4 address is parsed in the usual @@ -545,7 +545,7 @@ An IPv6 tuple() has length 8 and contains values of type 0..65535. The tuple representation is used on decode.
+
Time() = {date(), time()}
where
@@ -559,7 +559,7 @@ where
Hour = 0..23
Minute = 0..59
Second = 0..59
-
+
Additionally, values that can be encoded are
@@ -569,9 +569,9 @@ In particular, only values between
+
UTF8String() = [integer()]
-
+
List elements are the UTF-8 encodings of the individual characters @@ -579,15 +579,15 @@ in the string. Invalid codepoints will result in encode/decode failure.
+
DiameterIdentity() = OctetString()
-
+
A value must have length at least 1.
+
DiameterURI() = OctetString()
| #diameter_URI{type = Type,
fqdn = FQDN,
@@ -602,7 +602,7 @@ where
Port = integer()
Transport = sctp | tcp
Protocol = diameter | radius | 'tacacs+'
-
+
On encode, fields port, transport and protocol default to 3868, sctp @@ -612,9 +612,9 @@ section 4.3 of RFC 3588. The record representation is used on decode.
+
Enumerated() = Integer32()
-
+
On encode, values can be specified using the macros defined in a @@ -622,10 +622,10 @@ dictionary's hrl file.
+
IPFilterRule() = OctetString()
QoSFilterRule() = OctetString()
-
+
Values of these types are not currently parsed by diameter.
-- cgit v1.2.3