mod_reqtimeout.html.en revision af33a4994ae2ff15bc67d19ff1a7feb906745bf8
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
cfbca4e518f4981f435e93e434f17271e6efc138rbowen XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
cfbca4e518f4981f435e93e434f17271e6efc138rbowen This file is generated from xml source: DO NOT EDIT
cfbca4e518f4981f435e93e434f17271e6efc138rbowen XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<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" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.js" type="text/javascript">
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<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>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<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>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_reqtimeout.c</td></tr></table>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<div id="quickview"><h3 class="directives">Directives</h3>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<li><img alt="" src="/images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
cfbca4e518f4981f435e93e434f17271e6efc138rbowen<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<h2><a name="examples" id="examples">Examples</a></h2>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri Allow 10 seconds to receive the request including the headers and
cfbca4e518f4981f435e93e434f17271e6efc138rbowen 30 seconds for receiving the request body:
cfbca4e518f4981f435e93e434f17271e6efc138rbowen RequestReadTimeout header=10 body=30
9546947d8f7082fb4b70e1659feb5460502b73e4rbowen Allow at least 10 seconds to receive the request body.
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen If the client sends data, increase the timeout by 1 second for every
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen 1000 bytes received, with no upper limit for the timeout (except for
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen the limit given indirectly by
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
cfbca4e518f4981f435e93e434f17271e6efc138rbowen RequestReadTimeout body=10,MinRate=1000
c3c937a1510d6ff9cfa28ef3713e787f0e1a39c9coar Allow at least 10 seconds to receive the request including the headers.
aaed4ebc116f5862aff2610a809a9a9e9a28f50ecoar If the client sends data, increase the timeout by 1 second for every
aaed4ebc116f5862aff2610a809a9a9e9a28f50ecoar 500 bytes received. But do not allow more than 30 seconds for the
430b9854ae290aa3f76164c93193c6c11ace5c0crbowen request including the headers:
cfbca4e518f4981f435e93e434f17271e6efc138rbowen RequestReadTimeout header=10-30,MinRate=500
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen Usually, a server should have both header and body timeouts configured.
4aa603e6448b99f9371397d439795c91a93637eand If a common configuration is used for http and https virtual hosts, the
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen timeouts should not be set too low:
4aa603e6448b99f9371397d439795c91a93637eand RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen[header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen[body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
d5e8240ee767cced65a45a2b9d590ca08b3d3859rbowen<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>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
6bd107eca11c1c863fbb036f657ed774f27ccb1bigalic<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <p>This directive can set various timeouts for receiving the request headers
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen and the request body from the client. If the client fails to send headers or
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen body within the configured time, a <code>408 REQUEST TIME OUT</code> error
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen is sent.</p>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <p>For SSL virtual hosts, the header timeout values include the time needed
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen to do the initial SSL handshake. If the user's browser is configured to
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen query certificate revocation lists and the CRL server is not reachable, the
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen initial SSL handshake may take a significant time until the browser gives up
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen waiting for the CRL. Therefore the header timeout values should not be set
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen to very low values for SSL virtual hosts.
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen The body timeout values include the time needed for SSL renegotiation
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen (if necessary).</p>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <p>When an <code class="directive"><a href="/mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
4aa603e6448b99f9371397d439795c91a93637eand (usually the case on Linux and FreeBSD), the socket is not sent to the
c3c937a1510d6ff9cfa28ef3713e787f0e1a39c9coar server process before at least one byte (or the whole request for
4aa603e6448b99f9371397d439795c91a93637eand <code>httpready</code>) is received. The header timeout configured with
cfbca4e518f4981f435e93e434f17271e6efc138rbowen <code>RequestReadTimeout</code> is only effective after the server process has
cfbca4e518f4981f435e93e434f17271e6efc138rbowen received the socket.</p>
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <p>For each of the two timeout types (header or body), there are three ways
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen to specify the timeout:
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
4aa603e6448b99f9371397d439795c91a93637eand <p>The time in seconds allowed for reading all of the request headers or
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen body, respectively. A value of 0 means no limit.</p>
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <li><strong>Disable module for a vhost:</strong>:<br />
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <div class="example"><p><code>header=0 body=0</code></p></div>
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <p>This disables <code class="module"><a href="/mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <li><strong>Timeout value that is increased when data is
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <p>Same as above, but whenever data is received, the timeout value is
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen increased according to the specified minimum data rate (in bytes per
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen second).</p>
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen <li><strong>Timeout value that is increased when data is received, with an
4aa603e6448b99f9371397d439795c91a93637eand <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen <p>Same as above, but the timeout will not be increased above the second
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen value of the specified timeout range.</p>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen</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>
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen<script type="text/javascript"><!--//--><![CDATA[//><!--
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowenvar comments_shortname = 'httpd';
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowenvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen(function(w, d) {
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
4aa603e6448b99f9371397d439795c91a93637eand d.write('<div id="comments_thread"><\/div>');
11a346d1a1cdd14cbc7b75e971fc22dc1358c28drbowen var s = d.createElement('script');
3b35091b9c1ae36ee3d0e64ebbfdba58062290ffrbowen s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar})(window, document);
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<p class="apache">Copyright 2013 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>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<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[//><!--
1f1b6bf13313fdd14a45e52e553d3ff28689b717coarif (typeof(prettyPrint) !== 'undefined') {
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar prettyPrint();