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

Document unit for options that are in bytes

Browse source
This commit is contained in:
Loïc Hoguin 2019-09-06 11:50:58 +02:00
parent d5814a59f4
commit d14c59d905
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
2 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

34
doc/src/manual/cowboy_http2.asciidoc
View file

@ -59,7 +59,7 @@ Whether the connection process also acts as a supervisor.
connection_window_margin_size (65535):: connection_window_margin_size (65535)::
Extra amount to be added to the window size when Extra amount in bytes to be added to the window size when
updating the connection window. This is used to updating the connection window. This is used to
ensure that there is always some space available in ensure that there is always some space available in
the window. the window.
@ -67,8 +67,8 @@ the window.
connection_window_update_threshold (163840):: connection_window_update_threshold (163840)::
The connection window will only get updated when its size The connection window will only get updated when its size
becomes lower than this threshold. This is to avoid sending becomes lower than this threshold, in bytes. This is to
too many `WINDOW_UPDATE` frames. avoid sending too many `WINDOW_UPDATE` frames.
enable_connect_protocol (false):: enable_connect_protocol (false)::
@ -86,7 +86,7 @@ Time in ms with nothing received at all before Cowboy closes the connection.
initial_connection_window_size (65535):: initial_connection_window_size (65535)::
Initial window size for the connection. This is the total amount Initial window size in bytes for the connection. This is the total amount
of data (from request bodies for example) that may be buffered of data (from request bodies for example) that may be buffered
by the connection across all streams before the user code by the connection across all streams before the user code
explicitly requests it. explicitly requests it.
@ -95,7 +95,7 @@ Note that this value cannot be lower than the default.
initial_stream_window_size (65535):: initial_stream_window_size (65535)::
Initial window size for new streams. This is the total amount Initial window size in bytes for new streams. This is the total amount
of data (from request bodies for example) that may be buffered of data (from request bodies for example) that may be buffered
by a single stream before the user code explicitly requests it. by a single stream before the user code explicitly requests it.
@ -105,31 +105,31 @@ Maximum number of concurrent streams allowed on the connection.
max_connection_window_size (16#7fffffff):: max_connection_window_size (16#7fffffff)::
Maximum connection window size. This is used as an upper bound Maximum connection window size in bytes. This is used as an upper bound
when calculating the window size, either when reading the request when calculating the window size, either when reading the request
body or receiving said body. body or receiving said body.
max_decode_table_size (4096):: max_decode_table_size (4096)::
Maximum header table size used by the decoder. This is the value advertised Maximum header table size in bytes used by the decoder. This is the value
to the client. The client can then choose a header table size equal or lower advertised to the client. The client can then choose a header table size
to the advertised value. equal or lower to the advertised value.
max_encode_table_size (4096):: max_encode_table_size (4096)::
Maximum header table size used by the encoder. The server will compare this Maximum header table size in bytes used by the encoder. The server will
value to what the client advertises and choose the smallest one as the compare this value to what the client advertises and choose the smallest
encoder's header table size. one as the encoder's header table size.
max_frame_size_received (16384):: max_frame_size_received (16384)::
Maximum size of the frames received by the server. This value is Maximum size in bytes of the frames received by the server. This value is
advertised to the remote endpoint which can then decide to use advertised to the remote endpoint which can then decide to use
any value lower or equal for its frame sizes. any value lower or equal for its frame sizes.
max_frame_size_sent (infinity):: max_frame_size_sent (infinity)::
Maximum size of the frames sent by the server. This option allows Maximum size in bytes of the frames sent by the server. This option allows
setting an upper limit to the frame sizes instead of blindly setting an upper limit to the frame sizes instead of blindly
following the client's advertised maximum. following the client's advertised maximum.
+ +
@ -138,7 +138,7 @@ there is not enough space left in the flow control window.
max_stream_window_size (16#7fffffff):: max_stream_window_size (16#7fffffff)::
Maximum stream window size. This is used as an upper bound Maximum stream window size in bytes. This is used as an upper bound
when calculating the window size, either when reading the request when calculating the window size, either when reading the request
body or receiving said body. body or receiving said body.
@ -168,7 +168,7 @@ Ordered list of stream handlers that will handle all stream events.
stream_window_margin_size (65535):: stream_window_margin_size (65535)::
Extra amount to be added to the window size when Extra amount in bytes to be added to the window size when
updating a stream's window. This is used to updating a stream's window. This is used to
ensure that there is always some space available in ensure that there is always some space available in
the window. the window.
@ -176,7 +176,7 @@ the window.
stream_window_update_threshold (163840):: stream_window_update_threshold (163840)::
A stream's window will only get updated when its size A stream's window will only get updated when its size
becomes lower than this threshold. This is to avoid sending becomes lower than this threshold, in bytes. This is to avoid sending
too many `WINDOW_UPDATE` frames. too many `WINDOW_UPDATE` frames.
== Changelog == Changelog

2
doc/src/manual/cowboy_websocket.asciidoc
View file

@ -195,7 +195,7 @@ the client.
max_frame_size (infinity):: max_frame_size (infinity)::
Maximum frame size allowed by this Websocket Maximum frame size in bytes allowed by this Websocket
handler. Cowboy will close the connection when handler. Cowboy will close the connection when
a client attempts to send a frame that goes over a client attempts to send a frame that goes over
this limit. For fragmented frames this applies this limit. For fragmented frames this applies