aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaria Scott <[email protected]>2021-09-09 09:39:39 +0200
committerMaria Scott <[email protected]>2021-09-09 09:40:25 +0200
commitebf216e91ef2ae54d378234062db949d95f01c0d (patch)
tree787d4b2628a30518f2983d9403c620c4fc412335
parent0868586c43c20363759a7459b51e111b739178e6 (diff)
downloadranch-ebf216e91ef2ae54d378234062db949d95f01c0d.tar.gz
ranch-ebf216e91ef2ae54d378234062db949d95f01c0d.tar.bz2
ranch-ebf216e91ef2ae54d378234062db949d95f01c0d.zip
Mention that ranch_ssl must be used after socket upgrade2.1.0
-rw-r--r--doc/src/guide/transports.asciidoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/src/guide/transports.asciidoc b/doc/src/guide/transports.asciidoc
index 9167225..73747fd 100644
--- a/doc/src/guide/transports.asciidoc
+++ b/doc/src/guide/transports.asciidoc
@@ -153,9 +153,12 @@ A connected TCP socket can be upgraded to a SSL socket via the function
before telling the client that the server is ready to upgrade in order
to avoid race conditions.
+IMPORTANT: The new socket received from `ranch_ssl:handshake/3` must be
+used via the `ranch_ssl` transport.
+
.Performing a TLS handshake on a TCP socket
[source,erlang]
-{ok, NewSocket} = ranch_ssl:handshake(Socket, SslOpts, 5000).
+{ok, SslSocket} = ranch_ssl:handshake(TcpSocket, SslOpts, 5000).
=== Writing a transport handler