diff options
author | Anders Svensson <[email protected]> | 2012-08-28 15:05:09 +0200 |
---|---|---|
committer | Anders Svensson <[email protected]> | 2012-08-28 15:05:09 +0200 |
commit | f7036408ed27781cc5d060d6966f07cb2a5e00f6 (patch) | |
tree | 078078420f98329f7a088043a17e1fb9686cb647 /lib/diameter/doc | |
parent | d4eccdc4b544215f3706408bdeabe8c231780065 (diff) | |
parent | a907e66c93e54ffd9b4c8c84f500cd267a28ddd8 (diff) | |
download | otp-f7036408ed27781cc5d060d6966f07cb2a5e00f6.tar.gz otp-f7036408ed27781cc5d060d6966f07cb2a5e00f6.tar.bz2 otp-f7036408ed27781cc5d060d6966f07cb2a5e00f6.zip |
Merge branch 'anders/diameter/multiple_transport_modules/OTP-9885' into maint
* anders/diameter/multiple_transport_modules/OTP-9885:
Maintain service_info callback data in process dictionary
Maintain pid of started transport process in process dictionary
Minor spec and backwards compatibility fix
Update example code
Update documentation
Add diameter_transport for transport start indirection
Allow multiple transport_module and transport_config
Diffstat (limited to 'lib/diameter/doc')
-rw-r--r-- | lib/diameter/doc/src/diameter.xml | 30 |
1 files changed, 30 insertions, 0 deletions
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> |