mod_reqtimeout.html.en revision cb8646cb564e6b2f7b1580b01ba4fbfd26231253
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<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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/images/favicon.ico" rel="shortcut icon" /></head>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/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.3</a> > <a href="./">Modules</a></div>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<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>Experimental</td></tr>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
7f0952c0239ea2d6e37b472db6fde4ef2718343dsf<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_reqtimeout.c</td></tr>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.15 and later</td></tr></table>
46f74e65e6051e6e9391c8e17c5116317210facetakashi<div id="quickview"><h3 class="directives">Directives</h3>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<li><img alt="" src="/images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<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>
9a58dc6a2b26ec128b1270cf48810e705f1a90dbsf Allow 10 seconds to receive the request including the headers and
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin 30 seconds for receiving the request body:
9a58dc6a2b26ec128b1270cf48810e705f1a90dbsf RequestReadTimeout header=10 body=30
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
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin 1000 bytes received, with no upper limit for the timeout (exept for
c1e61f5534383913a1cb952f927348037b1c1922minfrin the limit given indirectly by
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin RequestReadTimeout body=10,MinRate=1000
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
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin request including the headers:
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin RequestReadTimeout header=10-30,MinRate=500
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
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin timeouts should not be set too low:
9a58dc6a2b26ec128b1270cf48810e705f1a90dbsf RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
9a58dc6a2b26ec128b1270cf48810e705f1a90dbsf<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.
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin[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>Unset; no limit</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>Experimental</td></tr>
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
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
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin to very low values for SSL virtual hosts.
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin The body timeout values include the time needed for SSL renegotiation
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin (if necessary).</p>
c1e61f5534383913a1cb952f927348037b1c1922minfrin <p>When an <code class="directive"><a href="/mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin (usually the case on Linux and FreeBSD), the socket is not sent to the
c1e61f5534383913a1cb952f927348037b1c1922minfrin server process before at least one byte (or the whole request for
c1e61f5534383913a1cb952f927348037b1c1922minfrin <code>httpready</code>) is received. The header timeout configured with
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <code>RequestReadTimeout</code> is only effective after the server process has
c1e61f5534383913a1cb952f927348037b1c1922minfrin received the socket.</p>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <p>For each of the two timeout types (header or body), there are three ways
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin 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>Timeout value that is increased when data is
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
c1e61f5534383913a1cb952f927348037b1c1922minfrin <p>Same as above, but whenever data is received, the timeout value is
fac8c35bfb158112226ab43ddf84d59daca5dc30nd increased according to the specified minimum data rate (in bytes per
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin second).</p>
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin <li><strong>Timeout value that is increased when data is received, with an
c1e61f5534383913a1cb952f927348037b1c1922minfrin <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
4277c95b5a9454a5c25f8d8762634fcff37aa840minfrin <p>Same as above, but the timeout will not be increased above the second
c1e61f5534383913a1cb952f927348037b1c1922minfrin 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>
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin<p class="apache">Copyright 2010 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>
6cb5ba7ba62cc211ade9e6b76f82eaae64a3a5d2minfrin<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>