From 6e84ba43a344599ec94852086f40f9b0eacc2c32 Mon Sep 17 00:00:00 2001
From: Anders Svensson
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 diameter_tcp if unspecified.
The interface required of a transport module is documented in diameter_transport(3).
+
+
+Multiple transport_module and transport_config
+options are allowed.
+The order of these is significant in this case (and only in this case),
+a transport_module being paired with the first
+transport_config 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 transport_config below) or all fail.
{transport_config, term()}
+{transport_config, term(), Unsigned32()}
-
A term passed as the third argument to the start/3 function of
the relevant transport_module in order to start a transport process.
Defaults to the empty list if unspecified.
+
+
+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.
+
+
+{transport_module, diameter_sctp}
+{transport_config, SctpOpts, 5000}
+{transport_module, diameter_tcp}
+{transport_config, TcpOpts}
+
+
+
+To listen on both SCTP and TCP, define one transport for each.
{applications, [application_alias()]}
--
cgit v1.2.3