diff options
author | Loïc Hoguin <[email protected]> | 2019-09-22 15:04:37 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2019-09-22 16:46:45 +0200 |
commit | 37b771210f94b9b692d0417d79483b9927d46ba2 (patch) | |
tree | 9081a202c1323028f15828a0520e53b6a2074d5e /doc/src/manual/gun.await_up.asciidoc | |
parent | 0a5879ceffa3a96666ed8406c1557759811d8a16 (diff) | |
download | gun-37b771210f94b9b692d0417d79483b9927d46ba2.tar.gz gun-37b771210f94b9b692d0417d79483b9927d46ba2.tar.bz2 gun-37b771210f94b9b692d0417d79483b9927d46ba2.zip |
Document Socks support
Also correct various Socks related types. This commit also
adds a new gun:protocols/0 type as a simpler way of describing
preferred protocols. The protocol/opts tuple is also documented.
This commit also fixes an issue with the default value for the
preferred protocols when using CONNECT over TLS. It was
mistakenly not enabling http2 by default.
Diffstat (limited to 'doc/src/manual/gun.await_up.asciidoc')
-rw-r--r-- | doc/src/manual/gun.await_up.asciidoc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/src/manual/gun.await_up.asciidoc b/doc/src/manual/gun.await_up.asciidoc index dfd4da9..d9934b5 100644 --- a/doc/src/manual/gun.await_up.asciidoc +++ b/doc/src/manual/gun.await_up.asciidoc @@ -23,7 +23,7 @@ await_up(ConnPid, Timeout, MonitorRef) ConnPid :: pid() MonitorRef :: reference() Timeout :: timeout() -Protocol :: http | http2 +Protocol :: http | http2 | socks Reason :: {down, any()} | timeout ---- @@ -71,4 +71,5 @@ may also be returned when a timeout or an error occur. link:man:gun(3)[gun(3)], link:man:gun:open(3)[gun:open(3)], link:man:gun:open_unix(3)[gun:open_unix(3)], +link:man:gun_socks_up(3)[gun_socks_up(3)], link:man:gun_up(3)[gun_up(3)] |