aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc/src
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2019-03-18 18:02:32 +0100
committerErlang/OTP <[email protected]>2019-03-18 18:02:32 +0100
commit7b4f3319aa8cbe242c5e0ad7ef9730a3727a1333 (patch)
treea53189d5bafa10cb6c76428b45c77e97831f9e38 /lib/ssl/doc/src
parentd4266651c5662c3b6addcea291bc6bffffbb7fb5 (diff)
parent5a7cfb2d571d95829848cfa6e20066d19c9a4800 (diff)
downloadotp-7b4f3319aa8cbe242c5e0ad7ef9730a3727a1333.tar.gz
otp-7b4f3319aa8cbe242c5e0ad7ef9730a3727a1333.tar.bz2
otp-7b4f3319aa8cbe242c5e0ad7ef9730a3727a1333.zip
Merge branch 'ingela/ssl/transport-transparance/ERL-861/OTP-15679' into maint-21
* ingela/ssl/transport-transparance/ERL-861/OTP-15679: ssl: Fix transport transparancy
Diffstat (limited to 'lib/ssl/doc/src')
-rw-r--r--lib/ssl/doc/src/ssl.xml25
1 files changed, 15 insertions, 10 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 90a9181ede..24d063e1bd 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -101,16 +101,21 @@
<datatype>
<name name="transport_option"/>
<desc>
- <p>Defaults to <c>{gen_tcp, tcp, tcp_closed, tcp_error}</c>
- for TLS and <c>{gen_udp, udp, udp_closed, udp_error}</c> for
- DTLS. Can be used to customize the transport layer. The tag
- values should be the values used by the underlying transport
- in its active mode messages. For TLS the callback module must implement a
- reliable transport protocol, behave as <c>gen_tcp</c>, and have functions
- corresponding to <c>inet:setopts/2</c>, <c>inet:getopts/2</c>,
- <c>inet:peername/1</c>, <c>inet:sockname/1</c>, and <c>inet:port/1</c>.
- The callback <c>gen_tcp</c> is treated specially and calls <c>inet</c>
- directly. For DTLS this feature must be considered exprimental.
+ <p>Defaults to <c>{gen_tcp, tcp, tcp_closed, tcp_error,
+ tcp_passive}</c> for TLS (for backward compatibility a four
+ tuple will be converted to a five tuple with the last element
+ "second_element"_passive) and <c>{gen_udp, udp, udp_closed,
+ udp_error}</c> for DTLS (might also be changed to five tuple in
+ the future). Can be used to customize the transport layer. The
+ tag values should be the values used by the underlying
+ transport in its active mode messages. For TLS the callback
+ module must implement a reliable transport protocol, behave as
+ <c>gen_tcp</c>, and have functions corresponding to
+ <c>inet:setopts/2</c>, <c>inet:getopts/2</c>,
+ <c>inet:peername/1</c>, <c>inet:sockname/1</c>, and
+ <c>inet:port/1</c>. The callback <c>gen_tcp</c> is treated
+ specially and calls <c>inet</c> directly. For DTLS this
+ feature must be considered exprimental.
</p>
</desc>
</datatype>