1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_reqtimeout - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> |
30 <a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr></table>
39 <p>This module provides a convenient way to set timeouts and minimum data
40 rates for receiving requests. Should a timeout occur or a data rate be
41 to low, the corresponding connection will be closed by the server.</p>
43 <p>This is logged at <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code>
44 <code>info</code>.</p>
46 <p>If needed, the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> directive
47 can be tweaked to explicitly log it:</p>
48 <pre class="prettyprint lang-config">LogLevel reqtimeout:info</pre>
51 <div id="quickview"><h3>Topics</h3>
53 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
54 </ul><h3 class="directives">Directives</h3>
56 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
58 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_reqtimeout">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_reqtimeout">Report a bug</a></li></ul><h3>See also</h3>
60 <li><a href="#comments_section">Comments</a></li></ul></div>
61 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
63 <h2><a name="examples" id="examples">Examples</a><a title="Permanent link" href="#examples" class="permalink">¶</a></h2>
67 Allow 10 seconds to receive the request including the headers and
68 30 seconds for receiving the request body:
70 <pre class="prettyprint lang-config">RequestReadTimeout header=10 body=30</pre>
75 Allow at least 10 seconds to receive the request body.
76 If the client sends data, increase the timeout by 1 second for every
77 1000 bytes received, with no upper limit for the timeout (except for
78 the limit given indirectly by
79 <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
81 <pre class="prettyprint lang-config">RequestReadTimeout body=10,MinRate=1000</pre>
86 Allow at least 10 seconds to receive the request including the headers.
87 If the client sends data, increase the timeout by 1 second for every
88 500 bytes received. But do not allow more than 30 seconds for the
89 request including the headers:
91 <pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre>
96 Usually, a server should have both header and body timeouts configured.
97 If a common configuration is used for http and https virtual hosts, the
98 timeouts should not be set too low:
100 <pre class="prettyprint lang-config">RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500</pre>
106 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
107 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a><a title="Permanent link" href="#requestreadtimeout" class="permalink">¶</a></h2>
108 <table class="directive">
109 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
111 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
112 [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
113 [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
115 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr>
116 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
117 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
118 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
119 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in
120 version 2.3.14 and earlier.</td></tr>
122 <p>This directive can set various timeouts for receiving the request headers
123 and the request body from the client. If the client fails to send headers or
124 body within the configured time, a <code>408 REQUEST TIME OUT</code> error
127 <p>For SSL virtual hosts, the header timeout values include the time needed
128 to do the initial SSL handshake. If the user's browser is configured to
129 query certificate revocation lists and the CRL server is not reachable, the
130 initial SSL handshake may take a significant time until the browser gives up
131 waiting for the CRL. Therefore the header timeout values should not be set
132 to very low values for SSL virtual hosts.
133 The body timeout values include the time needed for SSL renegotiation
136 <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
137 (usually the case on Linux and FreeBSD), the socket is not sent to the
138 server process before at least one byte (or the whole request for
139 <code>httpready</code>) is received. The header timeout configured with
140 <code class="directive">RequestReadTimeout</code> is only effective after the server process has
141 received the socket.</p>
143 <p>For each of the two timeout types (header or body), there are three ways
144 to specify the timeout:
149 <li><strong>Fixed timeout value</strong>:<br />
151 <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
153 <p>The time in seconds allowed for reading all of the request headers or
154 body, respectively. A value of 0 means no limit.</p>
157 <li><strong>Disable module for a vhost</strong>:<br />
159 <div class="example"><p><code>header=0 body=0</code></p></div>
161 <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p>
164 <li><strong>Timeout value that is increased when data is
165 received</strong>:<br />
166 <div class="example"><p><code>
167 <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
170 <p>Same as above, but whenever data is received, the timeout value is
171 increased according to the specified minimum data rate (in bytes per
175 <li><strong>Timeout value that is increased when data is received, with an
176 upper bound</strong>:<br />
177 <div class="example"><p><code>
178 <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
181 <p>Same as above, but the timeout will not be increased above the second
182 value of the specified timeout range.</p>
190 <div class="bottomlang">
191 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> |
192 <a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
193 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
194 <script type="text/javascript"><!--//--><![CDATA[//><!--
195 var comments_shortname = 'httpd';
196 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
198 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
199 d.write('<div id="comments_thread"><\/div>');
200 var s = d.createElement('script');
201 s.type = 'text/javascript';
203 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
204 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
207 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
209 })(window, document);
210 //--><!]]></script></div><div id="footer">
211 <p class="apache">Copyright 2018 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
212 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
213 if (typeof(prettyPrint) !== 'undefined') {