aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-04-04 17:23:37 +0200
committerLoïc Hoguin <[email protected]>2018-04-04 17:23:37 +0200
commitbbfc1569ccffab060c4c2b402a45119fb1f57495 (patch)
treea027f5e43ea26e1ceebefba27888c808ac4cd525 /doc/src/manual
parenta7b06f2e138c0c03c2511ed9fe6803fc9ebf3401 (diff)
downloadcowboy-bbfc1569ccffab060c4c2b402a45119fb1f57495.tar.gz
cowboy-bbfc1569ccffab060c4c2b402a45119fb1f57495.tar.bz2
cowboy-bbfc1569ccffab060c4c2b402a45119fb1f57495.zip
Add initial implementation of Websocket over HTTP/2
Using the current draft: https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01
Diffstat (limited to 'doc/src/manual')
-rw-r--r--doc/src/manual/cowboy_http2.asciidoc19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc
index 517879f..793c6a1 100644
--- a/doc/src/manual/cowboy_http2.asciidoc
+++ b/doc/src/manual/cowboy_http2.asciidoc
@@ -17,13 +17,14 @@ as a Ranch protocol.
[source,erlang]
----
opts() :: #{
- connection_type => worker | supervisor,
- env => cowboy_middleware:env(),
- inactivity_timeout => timeout(),
- middlewares => [module()],
- preface_timeout => timeout(),
- shutdown_timeout => timeout(),
- stream_handlers => [module()]
+ connection_type => worker | supervisor,
+ enable_connect_protocol => boolean(),
+ env => cowboy_middleware:env(),
+ inactivity_timeout => timeout(),
+ middlewares => [module()],
+ preface_timeout => timeout(),
+ shutdown_timeout => timeout(),
+ stream_handlers => [module()]
}
----
@@ -41,6 +42,10 @@ The default value is given next to the option name:
connection_type (supervisor)::
Whether the connection process also acts as a supervisor.
+enable_connect_protocol (false)::
+ Whether to enable the extended CONNECT method to allow
+ protocols like Websocket to be used over an HTTP/2 stream.
+
env (#{})::
Middleware environment.