From 6e84ba43a344599ec94852086f40f9b0eacc2c32 Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Sun, 29 Jul 2012 02:29:55 +0200
Subject: Update documentation

---
 lib/diameter/doc/src/diameter.xml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'lib/diameter/doc/src/diameter.xml')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 93e2603c10..ec7bd2012e 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -764,15 +764,45 @@ Defaults to <c>diameter_tcp</c> if unspecified.</p>
 <p>
 The interface required of a transport module is documented in <seealso
 marker="diameter_transport">diameter_transport(3)</seealso>.</p>
+
+<p>
+Multiple <c>transport_module</c> and <c>transport_config</c>
+options are allowed.
+The order of these is significant in this case (and only in this case),
+a <c>transport_module</c> being paired with the first
+<c>transport_config</c> following it in the options list, or the
+default value for trailing modules.
+Transport starts will be attempted with each of the
+modules in order until one establishes a connection within the
+corresponding timeout (see <c>transport_config</c> below) or all fail.</p>
 </item>
 
 <tag><c>{transport_config, term()}</c></tag>
+<tag><c>{transport_config, term(), Unsigned32()}</c></tag>
 <item>
 <p>
 A term passed as the third argument to the <seealso
 marker="diameter_transport#start">start/3</seealso> function of
 the relevant <c>transport_module</c> in order to start a transport process.
 Defaults to the empty list if unspecified.</p>
+
+<p>
+The 3-tuple form additionally specifies an interval, in milliseconds,
+after which a started transport process should be terminated if it has
+not yet established a connection.
+For example, the following options on a connecting transport
+request a connection with one peer over SCTP or another
+(typically the same) over TCP.</p>
+
+<code>
+{transport_module, diameter_sctp}
+{transport_config, SctpOpts, 5000}
+{transport_module, diameter_tcp}
+{transport_config, TcpOpts}
+</code>
+
+<p>
+To listen on both SCTP and TCP, define one transport for each.</p>
 </item>
 
 <tag><c>{applications, [application_alias()]}</c></tag>
-- 
cgit v1.2.3