From deed57ed8da08e3262d61197da2ed00391b94be6 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Thu, 19 Mar 2015 23:57:43 +0100 Subject: Improve language consistency in diameter(1) Akin to commit 85d44b58. --- lib/diameter/doc/src/diameter.xml | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) (limited to 'lib/diameter/doc') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 638c1c4c2b..a5a99f7835 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -303,7 +303,7 @@ Defaults to none.

{timeout, &dict_Unsigned32;}

-The number of milliseconds after which the request should +Number of milliseconds after which the request should timeout. Defaults to 5000.

@@ -742,7 +742,7 @@ info fields of forms other than the above.

service_name() = term()

-The name of a service as passed to &start_service; and with which the +Name of a service as passed to &start_service; and with which the service is identified. There can be at most one service with a given name on a given node. Note that &make_ref; @@ -754,7 +754,7 @@ can be used to generate a service name that is somewhat unique.

service_opt()

-An option passed to &start_service;. +Option passed to &start_service;. Can be any &capability; as well as the following.

@@ -762,7 +762,7 @@ Can be any &capability; as well as the following.

{application, [&application_opt;]}

-Defines a Diameter application supported by the service.

+A Diameter application supported by the service.

A service must configure one tuple for each Diameter @@ -790,7 +790,7 @@ be matched by corresponding &capability; configuration, of | evaluable()}

-Specifies the degree to which the service allows multiple transport +The degree to which the service allows multiple transport connections to the same peer, as identified by its Origin-Host at capabilities exchange.

@@ -816,7 +816,7 @@ Defaults to nodes.

{sequence, {H,N} | &evaluable;}

-Specifies a constant value H for the topmost 32-N bits of +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 explicitly or as a return value of a function to be evaluated at &start_service;. @@ -851,7 +851,7 @@ outgoing requests.

{share_peers, boolean() | [node()] | evaluable()}

-Specifies nodes to which peer connections established on the local +Nodes to which peer connections established on the local Erlang node are communicated. Shared peers become available in the remote candidates list passed to &app_pick_peer; callbacks on remote nodes whose services are @@ -890,7 +890,7 @@ of a single Diameter node across multiple Erlang nodes.

{spawn_opt, [term()]}

-An options list passed to &spawn_opt; when spawning a process for an +Options list passed to &spawn_opt; when spawning a process for an incoming Diameter request, unless the transport in question specifies another value. Options monitor and link are ignored.

@@ -902,7 +902,7 @@ Defaults to the empty list.

{use_shared_peers, boolean() | [node()] | evaluable()}

-Specifies nodes from which communicated peers are made available in +Nodes from which communicated peers are made available in the remote candidates list of &app_pick_peer; callbacks.

@@ -942,7 +942,7 @@ each node from which requests are sent.

transport_opt()

-An option passed to &add_transport;. +Option passed to &add_transport;. Has one of the following types.

@@ -950,8 +950,7 @@ Has one of the following types.

{applications, [&application_alias;]}

-The list of Diameter applications to which the transport should be -restricted. +Diameter applications to which the transport should be restricted. Defaults to all applications configured on the service in question. Applications not configured on the service in question are ignored.

@@ -984,7 +983,7 @@ TLS is desired over TCP as implemented by &man_tcp;.

{capabilities_cb, &evaluable;}

-A callback invoked upon reception of CER/CEA during capabilities +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 &transport_ref; and @@ -1207,7 +1206,7 @@ the same peer.

{spawn_opt, [term()]}

-Options list passed to &spawn_opt; when spawning a process for an +Options passed to &spawn_opt; when spawning a process for an incoming Diameter request. Options monitor and link are ignored.

-- cgit v1.2.3