diff options
Diffstat (limited to 'doc/src/manual/gun.asciidoc')
-rw-r--r-- | doc/src/manual/gun.asciidoc | 33 |
1 files changed, 27 insertions, 6 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc index acc1454..b9fbbc2 100644 --- a/doc/src/manual/gun.asciidoc +++ b/doc/src/manual/gun.asciidoc @@ -16,7 +16,7 @@ Connection: * link:man:gun:open(3)[gun:open(3)] - Open a connection to the given host and port * link:man:gun:open_unix(3)[gun:open_unix(3)] - Open a connection to the given Unix domain socket -// @todo * link:man:gun:shutdown(3)[gun:shutdown(3)] - Gracefully close the connection +* link:man:gun:shutdown(3)[gun:shutdown(3)] - Gracefully close the connection * link:man:gun:close(3)[gun:close(3)] - Brutally close the connection * link:man:gun:info(3)[gun:info(3)] - Obtain information about the connection @@ -144,6 +144,7 @@ Handshake timeout for tunneled TLS connections. [source,erlang] ---- http_opts() :: #{ + closing_timeout => timeout(), flow => pos_integer(), keepalive => timeout(), transform_header_name => fun((binary()) -> binary()), @@ -157,6 +158,12 @@ The default value is given next to the option name: // @todo Document content_handlers and gun_sse_h. +closing_timeout (15000):: + +Time to wait before brutally closing the connection when a +graceful shutdown was requested via a call to +link:man:gun:shutdown(3)[gun:shutdown(3)]. + flow - see below:: The initial flow control value for all HTTP/1.1 streams. @@ -188,8 +195,9 @@ HTTP version to use. [source,erlang] ---- http2_opts() :: #{ - flow => pos_integer(), - keepalive => timeout() + closing_timeout => timeout(), + flow => pos_integer(), + keepalive => timeout() } ---- @@ -199,6 +207,12 @@ The default value is given next to the option name: // @todo Document content_handlers and gun_sse_h. +closing_timeout (15000):: + +Time to wait before brutally closing the connection when a +graceful shutdown was requested either via a call to +link:man:gun:shutdown(3)[gun:shutdown(3)] or by the server. + flow - see below:: The initial flow control value for all HTTP/2 streams. @@ -364,9 +378,10 @@ The pid of the process that will receive the response messages. [source,erlang] ---- ws_opts() :: #{ - compress => boolean(), - flow => pos_integer(), - protocols => [{binary(), module()}] + closing_timeout => timeout(), + compress => boolean(), + flow => pos_integer(), + protocols => [{binary(), module()}] } ---- @@ -374,6 +389,12 @@ Configuration for the Websocket protocol. The default value is given next to the option name: +closing_timeout (15000):: + +Time to wait before brutally closing the connection when a +graceful shutdown was requested either via a call to +link:man:gun:shutdown(3)[gun:shutdown(3)] or by the server. + compress (false):: Whether to enable permessage-deflate compression. This does |