From 2e87fc716360c3bdbfa2e5122fca37e1bc47ab53 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 15 Nov 2012 16:45:55 +0100 Subject: Minor doc fixes Presentation (order, cross-references), not content. --- lib/diameter/doc/src/diameter.xml | 180 +++++++++++++++++---------------- lib/diameter/doc/src/diameter_sctp.xml | 3 +- 2 files changed, 97 insertions(+), 86 deletions(-) (limited to 'lib/diameter/doc') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index b40161045d..64c983d4a6 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -693,7 +693,8 @@ well as the following.

Defines a Diameter application supported by the service.

-A service must configure one application for each Diameter +A service must configure one application for each Diameter application it intends to support. For an outgoing Diameter request, the relevant application_alias() is @@ -708,7 +709,7 @@ file.

| node | nodes | [node()] - | diameter:evaluable()} + | evaluable()}

Specifies the degree to which multiple transport connections to the @@ -718,10 +719,10 @@ same peer are accepted by the service.

If type [node()] then a connection is rejected if another already exists on any of the specified nodes. Values of type false, node, nodes or -diameter:evaluable() are equivalent to values [], -[node()], [node()|nodes()] and the evaluated value, -respectively, evaluation of each expression taking place whenever a -new connection is to be established. +evaluable() are equivalent to +values [], [node()], [node()|nodes()] and the +evaluated value, respectively, evaluation of each expression taking +place whenever a new connection is to be established. Note that false allows an unlimited number of connections to be established with the same peer.

@@ -734,14 +735,14 @@ Defaults to nodes.

 {sequence, {H,N} | diameter:evaluable()} + marker="#evaluable">evaluable()}

Specifies a constant value H for the topmost 32-N bits of of 32-bit End-to-End and Hop-by-Hop identifiers generated by the service, either explicity or as a return value of a function to be evaluated at diameter:start_service/2. +marker="#start_service">start_service/2. In particular, an identifier Id is mapped to a new identifier as follows.

@@ -775,53 +776,6 @@ marker="#add_transport">add_transport/2. Has one of the following types.

-{transport_module, atom()} - -

-A module implementing a transport process as defined in diameter_transport(3). -Defaults to diameter_tcp if unspecified.

- -

-Multiple transport_module and transport_config -options are allowed. -The order of these is significant in this case (and only in this case), -a transport_module being paired with the first -transport_config following it in the options list, or the -default value for trailing modules. -Transport starts will be attempted with each of the -modules in order until one establishes a connection within the -corresponding timeout (see below) or all fail.

- - -{transport_config, term()} -{transport_config, term(), Unsigned32()} - -

-A term passed as the third argument to the start/3 function of -the relevant transport_module in order to start a transport process. -Defaults to the empty list if unspecified.

- -

-The 3-tuple form additionally specifies an interval, in milliseconds, -after which a started transport process should be terminated if it has -not yet established a connection. -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.

- - {applications, [application_alias()]} @@ -890,7 +844,8 @@ Equivalent to returning 3010, DIAMETER_UNKNOWN_PEER.

Returning anything but ok or a 2xxx series result code causes the transport connection to be broken. -Multiple capabilities_cb options can be specified, in which +Multiple capabilities_cb +options can be specified, in which case the corresponding callbacks are applied until either all return ok or one does not.

 @@ -908,9 +863,9 @@ Applied to Reason=transport|service|application and the in question, Reason indicating whether the the diameter application is being stopped, the service in question is being stopped at diameter:stop_service/1 or +marker="#stop_service">stop_service/1 or the transport in question is being removed at diameter:remove_transport/2, +marker="#remove_transport">remove_transport/2, respectively.

@@ -966,7 +921,8 @@ Equivalent to not having configured the callback.

-Multiple disconnect_cb options can be specified, in which +Multiple disconnect_cb +options can be specified, in which case the corresponding callbacks are applied until one of them returns a value other than ignore. All callbacks returning ignore is equivalent to not having @@ -976,28 +932,6 @@ configured them.

Defaults to a single callback returning dpr.

 - -{watchdog_timer, TwInit} - - -TwInit = Unsigned32() - | {M,F,A} - - -

-The RFC 3539 watchdog timer. -An integer value is interpreted as the RFC's TwInit in milliseconds, -a jitter of ± 2 seconds being added at each rearming of the -timer to compute the RFC's Tw. -An MFA is expected to return the RFC's Tw directly, with jitter -applied, allowing the jitter calculation to be performed by -the callback.

- -

-An integer value must be at least 6000 as required by RFC 3539. -Defaults to 30000 if unspecified.

- - {reconnect_timer, Tc} @@ -1010,8 +944,9 @@ For a connecting transport, the RFC 3588 Tc timer, in milliseconds. Note that this timer determines the frequency with which a transport will attempt to establish a connection with its peer only before an initial connection is established: once there is an initial -connection it's watchdog_timer that determines the frequency of -reconnection attempts, as required by RFC 3539.

+connection it's watchdog_timer that determines the +frequency of reconnection attempts, as required by RFC 3539.

For a listening transport, the timer specifies the time after which a @@ -1019,14 +954,89 @@ previously connected peer will be forgotten: a connection after this time is regarded as an initial connection rather than a reestablishment, causing the RFC 3539 state machine to pass to state OKAY rather than REOPEN. -Note that these semantics are not goverened by the RFC and -that a listening transport's reconnect_timer should be greater +Note that these semantics are not governed by the RFC and +that a listening transport's reconnect_timer should be greater than its peer's Tw plus jitter.

Defaults to 30000 for a connecting transport and 60000 for a listening transport.

+ + +{transport_config, term()} +{transport_config, term(), Unsigned32()} + +

+A term passed as the third argument to the start/3 function of +the relevant transport_module in order to +start a transport process. +Defaults to the empty list if unspecified.

+ +

+The 3-tuple form additionally specifies an interval, in milliseconds, +after which a started transport process should be terminated if it has +not yet established a connection. +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.

+ + + +{transport_module, atom()} + +

+A module implementing a transport process as defined in diameter_transport(3). +Defaults to diameter_tcp if unspecified.

+ +

+Multiple transport_module and transport_config +options are allowed. +The order of these is significant in this case (and only in this case), +a transport_module being paired with the first +transport_config +following it in the options list, or the default value for trailing +modules. +Transport starts will be attempted with each of the +modules in order until one establishes a connection within the +corresponding timeout (see below) or all fail.

+ + + +{watchdog_timer, TwInit} + + +TwInit = Unsigned32() + | {M,F,A} + + +

+The RFC 3539 watchdog timer. +An integer value is interpreted as the RFC's TwInit in milliseconds, +a jitter of ± 2 seconds being added at each rearming of the +timer to compute the RFC's Tw. +An MFA is expected to return the RFC's Tw directly, with jitter +applied, allowing the jitter calculation to be performed by +the callback.

+ +

+An integer value must be at least 6000 as required by RFC 3539. +Defaults to 30000 if unspecified.

 diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 955169349c..709b17c0d2 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -38,7 +38,8 @@ under the License.

-This module implements diameter transport over SCTP using gen_sctp. +This module implements diameter transport over SCTP using gen_sctp. It can be specified as the value of a transport_module option to diameter:add_transport/2 -- cgit v1.2.3