From dc259b62ef0190b80537d1028d85dfef73119130 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 13 Dec 2012 19:43:32 +0100 Subject: Minor documentation fixes --- lib/diameter/doc/src/diameter.xml | 49 +++++++++++++++++++++-------------- lib/diameter/doc/src/diameter_tcp.xml | 7 +++-- lib/diameter/doc/src/seealso.ent | 1 + 3 files changed, 33 insertions(+), 24 deletions(-) (limited to 'lib/diameter/doc') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index b7669b760b..f7d95844ba 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -69,8 +69,8 @@ Incoming Diameter requests are communicated as callbacks to a specified in the service configuration.

-Beware the difference between diameter (not capitalised) and -Diameter (capitalised). +Beware the difference between diameter (not capitalized) and +Diameter (capitalized). The former refers to the Erlang application named diameter whose main api is defined here, the latter to Diameter protocol in the sense of &the_rfc;.

@@ -488,16 +488,23 @@ candidates list.

- -service_event() = #diameter_event{} +service_event() = #diameter_event{service = &service_name;, + info = &service_event_info;}

An event message sent to processes that have subscribed to these using &subscribe;.

+ + + +service_event_info() = term() + + +

-The info field of the event record can have one of the -following types.

+The info field of a &service_event; record. +Can have one of the following types.

@@ -534,9 +541,9 @@ Otherwise a connection has reestablished without the loss or connectivity.

-Note that a single up/down event for a given peer -corresponds to one &app_peer_up;/&app_peer_down; -callback for each of the Diameter applications negotiated during +Note that a single up or down event for a given peer +corresponds to multiple &app_peer_up; or &app_peer_down; +callbacks, one for each of the Diameter applications negotiated during capablilities exchange. That is, the event communicates connectivity with the peer as a whole while the callbacks communicate connectivity with @@ -582,7 +589,7 @@ CB = &evaluable;

An incoming CER has been answered with the indicated result code or discarded. -Caps contains pairs of values for the the local node and remote +Caps contains pairs of values for the local node and remote peer. Pkt contains the CER in question. In the case of rejection by a capabilities callback, the tuple @@ -600,7 +607,7 @@ Pkt = #diameter_packet{}

An incoming CER contained errors and has been answered with the indicated result code. -Caps contains only values for the the local node. +Caps contains only values for the local node. Pkt contains the CER in question.

 @@ -624,7 +631,7 @@ ResultCode = integer() An incoming CEA has been rejected for the indicated reason. An integer-valued Result indicates the result code sent by the peer. -Caps contains pairs of values for the the local node and remote +Caps contains pairs of values for the local node and remote peer. Pkt contains the CEA in question. In the case of rejection by a capabilities callback, the tuple @@ -640,7 +647,7 @@ Pkt = #diameter_packet{}

An incoming CEA contained errors and has been rejected. -Caps contains only values for the the local node. +Caps contains only values for the local node. Pkt contains the CEA in question.

@@ -667,11 +674,14 @@ Config = {connect|listen, [transport_opt()]} An RFC 3539 watchdog state machine has changed state.

- - +any() +

For forward compatibility, a subscriber should be prepared to receive info fields of forms other than the above.

+ + + @@ -858,9 +868,8 @@ case the corresponding callbacks are applied until either all return The number of milliseconds after which a transport process having an established transport connection will be terminated if the expected capabilities exchange message (CER or CEA) is not received from the peer. -For a connecting transport, the timing reconnection attempts is -governed by &watchdog_timer; or -&reconnect_timer; expiry. +For a connecting transport, the timing of reconnection attempts is +governed by &watchdog_timer; or &reconnect_timer; expiry. For a listening transport, the peer determines the timing.

@@ -877,7 +886,7 @@ transport connection having watchdog state OKAY. Applied to Reason=transport|service|application and the &transport_ref; and &app_peer; -in question, Reason indicating whether the the diameter +in question, Reason indicating whether the diameter application is being stopped, the service in question is being stopped at &stop_service; or the transport in question is being removed at &remove_transport;, @@ -1733,7 +1742,7 @@ a service.

It is not an error to subscribe to events from a service that does not yet exist. Doing so before adding transports is required to guarantee the -reception of all related events.

+reception of all transport-related events.

diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index e3b8c733b7..fe2389d57d 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -26,7 +26,7 @@
-20112012 +20112013 Ericsson AB. All Rights Reserved. @@ -65,9 +65,8 @@ It can be specified as the value of a transport_module option to &mod_add_transport; and implements the behaviour documented in &man_transport;. -TLS security is supported, both as an upgrade following -capabilities exchange as specified by &the_rfc; and -at connection establishment as in the current draft standard.

+TLS security is supported, either as an upgrade following +capabilities exchange or at connection establishment.

Note that the ssl application is required for TLS and must be started diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent index 4647c42f85..9945bcadd3 100644 --- a/lib/diameter/doc/src/seealso.ent +++ b/lib/diameter/doc/src/seealso.ent @@ -54,6 +54,7 @@ significant. diameter:evaluable()'> diameter:peer_filter()'> diameter:service_event()'> +diameter:service_event_info()'> diameter:service_name()'> diameter:service_opt()'> diameter:transport_opt()'> -- cgit v1.2.3