From 951e8fecc4641a2ab62653c56adc74d54fafd83a Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Tue, 20 Sep 2011 09:48:00 +0200 Subject: Minor documentation fixes Connector/listener -> connecting/listening transport. --- lib/diameter/doc/src/diameter_sctp.xml | 10 ++++++---- lib/diameter/doc/src/diameter_tcp.xml | 13 +++++++------ 2 files changed, 13 insertions(+), 10 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index d0377f4b38..c1e839b8e1 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -74,11 +74,12 @@ marker="diameter_transport#start">diameter_transport(3).

The only diameter_sctp-specific argument is the options list. Options raddr and rport specify the remote address -and port for a connector and not valid for a listener. +and port for a connecting transport and not valid for a listening +transport. The former is required while latter defaults to 3868 if unspecified. More than one raddr option can be specified, in which case the -connector in question attempts each in sequence until an association -is established. +connecting transport in question attempts each in sequence until +an association is established. Remaining options are any accepted by gen_sctp:open/1, with the exception of options mode, binary, list, active and sctp_events. @@ -89,7 +90,8 @@ and port respectively.

Multiple ip options can be specified for a multihomed peer. If none are specified then the values of Host-IP-Address on the service are used. (In particular, one of these must be specified.) -Option port defaults to 3868 for a listener and 0 for a connector.

+Option port defaults to 3868 for a listening transport and 0 for a +connecting transport.

diameter_sctp uses the transport_data field of diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index 5d6e07b1b8..a502e53972 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -74,13 +74,14 @@ marker="diameter_transport#start">diameter_transport(3).

The only diameter_tcp-specific argument is the options list. Options raddr and rport specify the remote address -and port for a connector and not valid for a listener. +and port for a connecting transport and not valid for a listening +transport. Remaining options are any accepted by gen_tcp:connect/3 for -a connector, or gen_tcp:listen/2 for a listener, with the exception -of binary, packet and active. -Also, option port can be specified for a listener to specify the -local listening port, the default being the standardized 3868 if -unspecified. +a connecting transport, or gen_tcp:listen/2 for a listening transport, +with the exception of binary, packet and active. +Also, option port can be specified for a listening transport +to specify the local listening port, the default being the standardized +3868 if unspecified. Note that option ip specifies the local address.

-- cgit v1.2.3