umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 13:10:24 +00:00
Code Issues Wiki Activity

Document cowboy_stream_h/cowboy_compress_h

Browse source
This commit is contained in:
Loïc Hoguin 2018-11-18 23:03:30 +01:00
parent 8d6d78575f
commit 6cc3b0ccca
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
7 changed files with 153 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/src/manual/cowboy_http.asciidoc
View file

@ -11,7 +11,7 @@ as a Ranch protocol.
== Options
// @todo Might be worth moving cowboy_clear/tls/stream_h options
// @todo Might be worth moving cowboy_clear/tls options
// to their respective manual, when they are added.
[source,erlang]
@ -19,7 +19,6 @@ as a Ranch protocol.
opts() :: #{
chunked => boolean(),
connection_type => worker | supervisor,
env => cowboy_middleware:env(),
http10_keepalive => boolean(),
idle_timeout => timeout(),
inactivity_timeout => timeout(),
@ -32,11 +31,9 @@ opts() :: #{
max_method_length => non_neg_integer(),
max_request_line_length => non_neg_integer(),
max_skip_body_length => non_neg_integer(),
middlewares => [module()],
proxy_header => boolean(),
request_timeout => timeout(),
sendfile => boolean(),
shutdown_timeout => timeout(),
stream_handlers => [module()]
}
----
@ -63,10 +60,6 @@ connection_type (supervisor)::
Whether the connection process also acts as a supervisor.
env (#{})::
Middleware environment.
http10_keepalive (true)::
Whether keep-alive is enabled for HTTP/1.0 connections.
@ -118,10 +111,6 @@ max_skip_body_length (1000000)::
Maximum length Cowboy is willing to skip when the user code did not read the body fully.
When the remaining length is too large or unknown Cowboy will close the connection.
middlewares ([cowboy_router, cowboy_handler])::
Middlewares to run for every request.
proxy_header (false)::
Whether incoming connections have a PROXY protocol header. The
@ -138,10 +127,6 @@ Whether the sendfile syscall may be used. It can be useful to disable
it on systems where the syscall has a buggy implementation, for example
under VirtualBox when using shared folders.
shutdown_timeout (5000)::
Time in ms Cowboy will wait for child processes to shut down before killing them.
stream_handlers ([cowboy_stream_h])::
Ordered list of stream handlers that will handle all stream events.