From b9f75367e58e8d0ece55f654c540b8c061c3f328 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 30 Aug 2012 09:39:48 +0200 Subject: Minor formatting fixes Type references enclosed in . --- lib/diameter/doc/src/diameter.xml | 57 +++++++++++++++-------------- lib/diameter/doc/src/diameter_transport.xml | 2 +- 2 files changed, 30 insertions(+), 29 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 0bfbf62cd3..38b3cdcba5 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -368,7 +368,8 @@ eval(F) ->

-Applying an evaluable() E to an argument list A +Applying an evaluable() +E to an argument list A is meant in the sense of eval([E|A]).

@@ -436,8 +437,8 @@ specified value, or all peers if the atom any.

{eval, evaluable()}

-Matches only those peers for which the specified evaluable() returns +Matches only those peers for which the specified evaluable() returns true on the connection's diameter_caps record. Any other return value or exception is equivalent to false.

 @@ -471,9 +472,9 @@ that matches no peer.

The host and realm filters examine the outgoing request as passed to call/4, -assuming that this is a record- or list-valued diameter_app:message(), and that -the message contains at most one of each AVP. +assuming that this is a record- or list-valued diameter_app:message(), +and that the message contains at most one of each AVP. If this is not the case then the {host|realm, DiameterIdentity()} filters must be used to achieve the desired result. @@ -675,7 +676,7 @@ that is somewhat unique.

An option passed to start_service/2. -Can be any capability() as +Can be any capability() as well as the following.

@@ -688,8 +689,8 @@ Defines a Diameter application supported by the service.

A service must configure one application for each Diameter application it intends to support. -For an outgoing Diameter request, the relevant application_alias() is +For an outgoing Diameter request, the relevant application_alias() is passed to call/4, while for an incoming request the application identifier in the message header determines the application, the identifier being specified in @@ -786,8 +787,8 @@ TLS is desired over TCP as implemented by A callback invoked upon reception of CER/CEA during capabilities exchange in order to ask whether or not the connection should be accepted. -Applied to the relevant transport_ref() and the +Applied to the relevant transport_ref() and the #diameter_caps{} record of the connection. Returning ok accepts the connection. Returning integer() causes an incoming @@ -1075,7 +1076,7 @@ outgoing messages.

The value returned is the number of seconds since 19680120T031408Z, -the first value that can be encoded as a Diameter Time(), +the first value that can be encoded as a Diameter Time(), at the time the diameter application was started.

@@ -1245,20 +1246,20 @@ An example return value with for a client service with Origin-Host

-Here ref is a transport_ref() and options -the corresponding transport_opt() list passed to ref is a transport_ref() and options +the corresponding transport_opt() list passed to add_transport/2. The watchdog entry shows the state of a connection's RFC 3539 watchdog state machine. -The peer entry identifies the diameter_app:peer_ref() for +The peer entry identifies the diameter_app:peer_ref() for which there will have been peer_up callbacks for the Diameter applications identified by the apps entry, -common being the application_alias(). +common being the application_alias(). The caps entry identifies the capabilities sent by the local node and received from the peer during capabilities exchange. The port entry displays socket-level information about the @@ -1277,8 +1278,8 @@ during the lifetime of the transport configuration.

A listening transport presents its information slightly differently -since there may be multiple accepted connections for the same transport_ref(). +since there may be multiple accepted connections for the same transport_ref(). The transport info returned by a server with a single client connection might look as follows.

@@ -1405,10 +1406,10 @@ contrast to transport info.

Return a {{Counter, Ref}, non_neg_integer()} list of counter values. -Ref can be either a transport_ref() -or a diameter_app:peer_ref(). +Ref can be either a transport_ref() +or a diameter_app:peer_ref(). Entries for the latter are folded into corresponding entries for the former as peer connections go down. Entries for both are removed at

-Subscribe to service_event() messages from +Subscribe to service_event() messages from a service.

diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index e852041278..f355107096 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -162,7 +162,7 @@ transport respectively. connection should be upgraded to TLS.

-If TLS is requested (Bool = true) then a connecting process should +If TLS is requested (Bool=true) then a connecting process should initiate a TLS handshake with the peer and an accepting process should prepare to accept a handshake. A successful handshake should be followed by a {diameter, {tls, Ref}} -- cgit v1.2.3