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