aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-06-04 08:40:31 +0200
committerLoïc Hoguin <[email protected]>2018-06-04 08:40:31 +0200
commit93c88fdc541c3f8a4ebbae3699bee90d00dc637f (patch)
tree236d186d109db248821674ead9e3148617d3e5d1 /doc/src/guide
parent1be0151ec7b6a98064e648d5598f56cbdec65dc7 (diff)
downloadgun-93c88fdc541c3f8a4ebbae3699bee90d00dc637f.tar.gz
gun-93c88fdc541c3f8a4ebbae3699bee90d00dc637f.tar.bz2
gun-93c88fdc541c3f8a4ebbae3699bee90d00dc637f.zip
Remove the dependency on Ranch
We instead of two new modules, gun_tcp and gun_tls. They only have 6 functions so far, much less than what Ranch provided before. Also renames ssl to tls where applicable. It's still possible to use the ssl transport option but it's now undocumented.
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/connect.asciidoc8
-rw-r--r--doc/src/guide/start.asciidoc2
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/src/guide/connect.asciidoc b/doc/src/guide/connect.asciidoc
index e0b09d6..f7983bc 100644
--- a/doc/src/guide/connect.asciidoc
+++ b/doc/src/guide/connect.asciidoc
@@ -34,9 +34,9 @@ The `gun:open/{2,3}` function must be used to open a connection.
{ok, ConnPid} = gun:open("example.org", 443).
If the port given is 443, Gun will attempt to connect using
-SSL. The protocol will be selected automatically using the
+TLS. The protocol will be selected automatically using the
ALPN extension for TLS. By default Gun supports HTTP/2
-and HTTP/1.1 when connecting using SSL.
+and HTTP/1.1 when connecting using TLS.
For any other port, Gun will attempt to connect using TCP
and will use the HTTP/1.1 protocol.
@@ -47,10 +47,10 @@ options. The manual documents all available options.
Options can be provided as a third argument, and take the
form of a map.
-.Opening an SSL connection to example.org on port 8443
+.Opening a TLS connection to example.org on port 8443
[source,erlang]
-{ok, ConnPid} = gun:open("example.org", 8443, #{transport=>ssl}).
+{ok, ConnPid} = gun:open("example.org", 8443, #{transport => tls}).
=== Waiting for the connection to be established
diff --git a/doc/src/guide/start.asciidoc b/doc/src/guide/start.asciidoc
index 6d93e2e..17cbe87 100644
--- a/doc/src/guide/start.asciidoc
+++ b/doc/src/guide/start.asciidoc
@@ -27,7 +27,7 @@ use it.
[source,erlang]
----
1> application:ensure_all_started(gun).
-{ok,[ranch,crypto,cowlib,asn1,public_key,ssl,gun]}
+{ok,[crypto,cowlib,asn1,public_key,ssl,gun]}
----
=== Stopping