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