aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-09-26 18:19:54 +0200
committerLoïc Hoguin <[email protected]>2019-09-26 18:21:02 +0200
commit70522ac15a6a3fbcbe8471dcdfb43baff6fd5902 (patch)
tree076828259730decd5d78ae315f0fe82a87c2d48a /doc/src/manual
parent1b7501163cff86b9f2996e3266a1bfb68f534f0a (diff)
downloadgun-70522ac15a6a3fbcbe8471dcdfb43baff6fd5902.tar.gz
gun-70522ac15a6a3fbcbe8471dcdfb43baff6fd5902.tar.bz2
gun-70522ac15a6a3fbcbe8471dcdfb43baff6fd5902.zip
Document the cow_http2_machine options
The details are not given for now. The best would be to document them in Cowlib and refer to that documentation instead of duplicating the information in both the Gun and Cowboy manuals.
Diffstat (limited to 'doc/src/manual')
-rw-r--r--doc/src/manual/gun.asciidoc23
1 files changed, 20 insertions, 3 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc
index 9670e2e..c22f1ef 100644
--- a/doc/src/manual/gun.asciidoc
+++ b/doc/src/manual/gun.asciidoc
@@ -201,7 +201,26 @@ HTTP version to use.
http2_opts() :: #{
closing_timeout => timeout(),
flow => pos_integer(),
- keepalive => timeout()
+ keepalive => timeout(),
+
+ %% HTTP/2 state machine configuration.
+ connection_window_margin_size => 0..16#7fffffff,
+ connection_window_update_threshold => 0..16#7fffffff,
+ enable_connect_protocol => boolean(),
+ initial_connection_window_size => 65535..16#7fffffff,
+ initial_stream_window_size => 0..16#7fffffff,
+ max_concurrent_streams => non_neg_integer() | infinity,
+ max_connection_window_size => 0..16#7fffffff,
+ max_decode_table_size => non_neg_integer(),
+ max_encode_table_size => non_neg_integer(),
+ max_frame_size_received => 16384..16777215,
+ max_frame_size_sent => 16384..16777215 | infinity,
+ max_stream_buffer_size => non_neg_integer(),
+ max_stream_window_size => 0..16#7fffffff,
+ preface_timeout => timeout(),
+ settings_timeout => timeout(),
+ stream_window_margin_size => 0..16#7fffffff,
+ stream_window_update_threshold => 0..16#7fffffff
}
----
@@ -226,8 +245,6 @@ keepalive (5000)::
Time between pings in milliseconds.
-// @todo Allow and document max_frame_size_sent.
-
=== opts()
[source,erlang]