comparison xml/en/docs/http/ngx_http_v2_module.xml @ 2654:d13341d3c54a

Marked some directives as obsolete in HTTP/2. The following directives are marked as obsolete: http2_idle_timeout, http2_max_field_size, http2_max_header_size, http2_max_requests, http2_recv_timeout.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 16 Feb 2021 14:17:10 +0000
parents 4f3494d80949
children b74f2038f2b5
comparison
equal deleted inserted replaced
2653:9fc25ea7a92c 2654:d13341d3c54a
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_v2_module" 9 <module name="Module ngx_http_v2_module"
10 link="/en/docs/http/ngx_http_v2_module.html" 10 link="/en/docs/http/ngx_http_v2_module.html"
11 lang="en" 11 lang="en"
12 rev="13"> 12 rev="14">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides 17 The <literal>ngx_http_v2_module</literal> module (1.9.5) provides
125 <default>3m</default> 125 <default>3m</default>
126 <context>http</context> 126 <context>http</context>
127 <context>server</context> 127 <context>server</context>
128 128
129 <para> 129 <para>
130 <note>
131 This directive is obsolete since version 1.19.7.
132 The <link doc="ngx_http_core_module.xml" id="keepalive_timeout"/>
133 directive should be used instead.
134 </note>
135 </para>
136
137 <para>
130 Sets the timeout of inactivity after which the connection is closed. 138 Sets the timeout of inactivity after which the connection is closed.
131 </para> 139 </para>
132 140
133 </directive> 141 </directive>
134 142
165 <directive name="http2_max_field_size"> 173 <directive name="http2_max_field_size">
166 <syntax><value>size</value></syntax> 174 <syntax><value>size</value></syntax>
167 <default>4k</default> 175 <default>4k</default>
168 <context>http</context> 176 <context>http</context>
169 <context>server</context> 177 <context>server</context>
178
179 <para>
180 <note>
181 This directive is obsolete since version 1.19.7.
182 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/>
183 directive should be used instead.
184 </note>
185 </para>
170 186
171 <para> 187 <para>
172 Limits the maximum size of 188 Limits the maximum size of
173 an <link url="https://tools.ietf.org/html/rfc7541">HPACK</link>-compressed 189 an <link url="https://tools.ietf.org/html/rfc7541">HPACK</link>-compressed
174 request header field. 190 request header field.
186 <default>16k</default> 202 <default>16k</default>
187 <context>http</context> 203 <context>http</context>
188 <context>server</context> 204 <context>server</context>
189 205
190 <para> 206 <para>
207 <note>
208 This directive is obsolete since version 1.19.7.
209 The <link doc="ngx_http_core_module.xml" id="large_client_header_buffers"/>
210 directive should be used instead.
211 </note>
212 </para>
213
214 <para>
191 Limits the maximum size of the entire request header list after 215 Limits the maximum size of the entire request header list after
192 <link url="https://tools.ietf.org/html/rfc7541">HPACK</link> decompression. 216 <link url="https://tools.ietf.org/html/rfc7541">HPACK</link> decompression.
193 For most requests, the default limit should be enough. 217 For most requests, the default limit should be enough.
194 </para> 218 </para>
195 219
200 <syntax><value>number</value></syntax> 224 <syntax><value>number</value></syntax>
201 <default>1000</default> 225 <default>1000</default>
202 <context>http</context> 226 <context>http</context>
203 <context>server</context> 227 <context>server</context>
204 <appeared-in>1.11.6</appeared-in> 228 <appeared-in>1.11.6</appeared-in>
229
230 <para>
231 <note>
232 This directive is obsolete since version 1.19.7.
233 The <link doc="ngx_http_core_module.xml" id="keepalive_requests"/>
234 directive should be used instead.
235 </note>
236 </para>
205 237
206 <para> 238 <para>
207 Sets the maximum number of requests (including 239 Sets the maximum number of requests (including
208 <link id="http2_push">push</link> requests) that can be served 240 <link id="http2_push">push</link> requests) that can be served
209 through one HTTP/2 connection, 241 through one HTTP/2 connection,
292 <default>30s</default> 324 <default>30s</default>
293 <context>http</context> 325 <context>http</context>
294 <context>server</context> 326 <context>server</context>
295 327
296 <para> 328 <para>
329 <note>
330 This directive is obsolete since version 1.19.7.
331 The <link doc="ngx_http_core_module.xml" id="client_header_timeout"/>
332 directive should be used instead.
333 </note>
334 </para>
335
336 <para>
297 Sets the timeout for expecting more data from the client, 337 Sets the timeout for expecting more data from the client,
298 after which the connection is closed. 338 after which the connection is closed.
299 </para> 339 </para>
300 340
301 </directive> 341 </directive>