aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-11-03 18:55:40 +0100
committerLoïc Hoguin <[email protected]>2018-11-03 18:55:40 +0100
commitbe09711687218070ee670be7d549df8338b4ae92 (patch)
tree3fd0a125066b2d6eebbe4aee6190e426771c2ee4 /doc/src/manual
parent571719a164326eebdc792b43170fe27f123aac0d (diff)
downloadcowboy-be09711687218070ee670be7d549df8338b4ae92.tar.gz
cowboy-be09711687218070ee670be7d549df8338b4ae92.tar.bz2
cowboy-be09711687218070ee670be7d549df8338b4ae92.zip
Add an option to disable sendfile for a listener
Diffstat (limited to 'doc/src/manual')
-rw-r--r--doc/src/manual/cowboy_http.asciidoc7
-rw-r--r--doc/src/manual/cowboy_http2.asciidoc8
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_http.asciidoc b/doc/src/manual/cowboy_http.asciidoc
index 21a6d65..3592456 100644
--- a/doc/src/manual/cowboy_http.asciidoc
+++ b/doc/src/manual/cowboy_http.asciidoc
@@ -32,6 +32,7 @@ opts() :: #{
max_skip_body_length => non_neg_integer(),
middlewares => [module()],
request_timeout => timeout(),
+ sendfile => boolean(),
shutdown_timeout => timeout(),
stream_handlers => [module()]
}
@@ -96,6 +97,11 @@ middlewares ([cowboy_router, cowboy_handler])::
request_timeout (5000)::
Time in ms with no requests before Cowboy closes the connection.
+sendfile (true)::
+ 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.
@@ -104,6 +110,7 @@ stream_handlers ([cowboy_stream_h])::
== Changelog
+* *2.6*: The `sendfile` option was added.
* *2.5*: The `linger_timeout` option was added.
* *2.2*: The `max_skip_body_length` option was added.
* *2.0*: The `timeout` option was renamed `request_timeout`.
diff --git a/doc/src/manual/cowboy_http2.asciidoc b/doc/src/manual/cowboy_http2.asciidoc
index 8cba7b0..ea7110b 100644
--- a/doc/src/manual/cowboy_http2.asciidoc
+++ b/doc/src/manual/cowboy_http2.asciidoc
@@ -30,6 +30,7 @@ opts() :: #{
max_frame_size_sent => 16384..16777215 | infinity,
middlewares => [module()],
preface_timeout => timeout(),
+ sendfile => boolean(),
settings_timeout => timeout(),
shutdown_timeout => timeout(),
stream_handlers => [module()]
@@ -119,6 +120,12 @@ preface_timeout (5000)::
Time in ms Cowboy is willing to wait for the connection preface.
+sendfile (true)::
+
+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.
+
settings_timeout (5000)::
Time in ms Cowboy is willing to wait for a SETTINGS ack.
@@ -133,6 +140,7 @@ Ordered list of stream handlers that will handle all stream events.
== Changelog
+* *2.6*: The `sendfile` option was added.
* *2.4*: Add the options `initial_connection_window_size`,
`initial_stream_window_size`, `max_concurrent_streams`,
`max_decode_table_size`, `max_encode_table_size`,