mod_reqtimeout.html.en revision 2e545ce2450a9953665f701bb05350f0d3f26275
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<?xml version="1.0" encoding="ISO-8859-1"?>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
a78048ccbdb6256da15e6b0e7e95355e480c2301nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
a78048ccbdb6256da15e6b0e7e95355e480c2301nd This file is generated from xml source: DO NOT EDIT
a78048ccbdb6256da15e6b0e7e95355e480c2301nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
a78048ccbdb6256da15e6b0e7e95355e480c2301nd -->
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<title>mod_reqtimeout - Apache HTTP Server</title>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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" />
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<script src="/style/scripts/prettify.min.js" type="text/javascript">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</script>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<body>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div id="page-header">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<p class="apache">Apache HTTP Server Version 2.5</p>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<img alt="" src="/images/feather.gif" /></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div id="path">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div id="page-content">
11495c9f0bd33e51a25b4d532beadfbcf9b944a3nilgun<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="toplang">
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</div>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_reqtimeout.c</td></tr></table>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div id="quickview"><h3 class="directives">Directives</h3>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<ul id="toc">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</ul>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<h3>Topics</h3>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<ul id="topics">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="section">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<h2><a name="examples" id="examples">Examples</a></h2>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <ol>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Allow 10 seconds to receive the request including the headers and
a78048ccbdb6256da15e6b0e7e95355e480c2301nd 30 seconds for receiving the request body:
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <pre class="prettyprint lang-config">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd RequestReadTimeout header=10 body=30
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </pre>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Allow at least 10 seconds to receive the request body.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd If the client sends data, increase the timeout by 1 second for every
a78048ccbdb6256da15e6b0e7e95355e480c2301nd 1000 bytes received, with no upper limit for the timeout (except for
a78048ccbdb6256da15e6b0e7e95355e480c2301nd the limit given indirectly by
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <pre class="prettyprint lang-config">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd RequestReadTimeout body=10,MinRate=1000
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </pre>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Allow at least 10 seconds to receive the request including the headers.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd If the client sends data, increase the timeout by 1 second for every
a78048ccbdb6256da15e6b0e7e95355e480c2301nd 500 bytes received. But do not allow more than 30 seconds for the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd request including the headers:
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <pre class="prettyprint lang-config">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd RequestReadTimeout header=10-30,MinRate=500
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </pre>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Usually, a server should have both header and body timeouts configured.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd If a common configuration is used for http and https virtual hosts, the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd timeouts should not be set too low:
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <pre class="prettyprint lang-config">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </pre>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </li>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </ol>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<table class="directive">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
a78048ccbdb6256da15e6b0e7e95355e480c2301nd[header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
a78048ccbdb6256da15e6b0e7e95355e480c2301nd[body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</code></td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<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>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in
a78048ccbdb6256da15e6b0e7e95355e480c2301ndversion 2.3.14 and earlier.</td></tr>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd</table>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>This directive can set various timeouts for receiving the request headers
a78048ccbdb6256da15e6b0e7e95355e480c2301nd and the request body from the client. If the client fails to send headers or
a78048ccbdb6256da15e6b0e7e95355e480c2301nd body within the configured time, a <code>408 REQUEST TIME OUT</code> error
a78048ccbdb6256da15e6b0e7e95355e480c2301nd is sent.</p>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>For SSL virtual hosts, the header timeout values include the time needed
a78048ccbdb6256da15e6b0e7e95355e480c2301nd to do the initial SSL handshake. If the user's browser is configured to
a78048ccbdb6256da15e6b0e7e95355e480c2301nd query certificate revocation lists and the CRL server is not reachable, the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd initial SSL handshake may take a significant time until the browser gives up
a78048ccbdb6256da15e6b0e7e95355e480c2301nd waiting for the CRL. Therefore the header timeout values should not be set
a78048ccbdb6256da15e6b0e7e95355e480c2301nd to very low values for SSL virtual hosts.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd The body timeout values include the time needed for SSL renegotiation
a78048ccbdb6256da15e6b0e7e95355e480c2301nd (if necessary).</p>
11495c9f0bd33e51a25b4d532beadfbcf9b944a3nilgun
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <p>When an <code class="directive"><a href="/mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung (usually the case on Linux and FreeBSD), the socket is not sent to the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd server process before at least one byte (or the whole request for
9c1260efa52c82c2a58e5b5f20cd6902563d95f5rbowen <code>httpready</code>) is received. The header timeout configured with
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <code>RequestReadTimeout</code> is only effective after the server process has
a78048ccbdb6256da15e6b0e7e95355e480c2301nd 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/trunk/mod/mod_reqtimeout.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/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 2014 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/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[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>