diff options
| author | Anders Svensson <[email protected]> | 2013-03-28 00:44:50 +0100 |
|---|---|---|
| committer | Anders Svensson <[email protected]> | 2013-04-11 16:18:56 +0200 |
| commit | 1b377b3d24596cbfb5b7ce20705dc9fce9aac0b6 (patch) | |
| tree | 9148c22c2bc7fd3d739a915c6c3bd9e8d2050c8a /lib/diameter/doc/src/diameter_tcp.xml | |
| parent | 2e848e9290c2c912df46a7f9b4cd93ce002e9ba9 (diff) | |
| download | otp-1b377b3d24596cbfb5b7ce20705dc9fce9aac0b6.tar.gz otp-1b377b3d24596cbfb5b7ce20705dc9fce9aac0b6.tar.bz2 otp-1b377b3d24596cbfb5b7ce20705dc9fce9aac0b6.zip | |
Make explicit local address to diameter_tcp:start/3 optional
Use the default address address (as selected by gen_tcp) if none is
configured, passing it in the new 'connected' message introduced by the
previous commit.
The corresponding update to diameter_sctp has to wait until problems
with inet:sockname/1 are resolved: the function currently only returns
one address, and sometimes {0,0,0,0}. See OTP-11018.
Diffstat (limited to 'lib/diameter/doc/src/diameter_tcp.xml')
| -rw-r--r-- | lib/diameter/doc/src/diameter_tcp.xml | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index 01c781d553..8e509aa829 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -1,5 +1,6 @@ <?xml version="1.0" encoding="latin1" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd" [ + <!ENTITY start '<seealso marker="#start-3">start/3</seealso>'> <!ENTITY gen_tcp_connect3 '<seealso marker="kernel:gen_tcp#connect-3">gen_tcp:connect/3</seealso>'> <!ENTITY gen_tcp_listen2 @@ -81,7 +82,9 @@ before configuring TLS capability on diameter transports.</p> <func> <name>start({Type, Ref}, Svc, [Opt]) - -> {ok, Pid, [LAddr]} | {error, Reason}</name> + -> {ok, Pid} + | {ok, Pid, [LAddr]} + | {error, Reason}</name> <fsummary>Start a transport process.</fsummary> <type> <v>Type = connect | accept</v> @@ -153,13 +156,14 @@ that will not be forthcoming, which will eventually cause the RFC 3539 watchdog to take down the connection.</p> <p> -If the <c>#diameter_service{}</c> record has more than one -<c>Host-IP-Address</c> and option <c>ip</c> is unspecified then the -first of the these addresses is used as the local address.</p> - -<p> -The returned local address list has length one.</p> - +If an <c>ip</c> option is not specified then the first element of a +non-empty <c>Host-IP-Address</c> list in <c>Svc</c> provides the local +IP address. +If neither is specified then the default address selected by &gen_tcp; +is used. +In all cases, the selected address is either returned from +&start; or passed in a <c>connected</c> message over the transport +interface.</p> </desc> </func> |