mod_reqtimeout.html.en revision 50039065d571fe01fd458a3f031c995a1fd53c22
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_reqtimeout - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body>
<div id="page-header">
<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>
<p class="apache">Apache HTTP Server Version 2.3</p>
<div id="path">
<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>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
</ul>
<h3>Topics</h3>
<ul id="topics">
</ul></div>
<div class="section">
<h2><a name="examples" id="examples">Examples</a></h2>
<ol>
<li>
Allow 10 seconds to receive the request including the headers and
30 seconds for receiving the request body:
<div class="example"><p><code>
RequestTimeout headerinit=10 bodyinit=30
</code></p></div>
</li>
<li>
Allow at least 10 seconds to receive the request including the headers.
If the client sends data, increase the timeout by 1 second for every
500 bytes received. But do not allow more than 30 seconds for the
request including the headers:
<div class="example"><p><code>
RequestTimeout headerinit=10 headerminrate=500 headermax=30
</code></p></div>
</li>
<li>
Allow at least 10 seconds to receive the request body.
If the client sends data, increase the timeout by 1 second for every
1000 bytes received, with no upper limit for the timeout (exept for
the limit given indirectly by
<div class="example"><p><code>
RequestTimeout bodyinit=10 bodyminrate=1000
</code></p></div>
</li>
</ol>
</div>
<div class="directive-section"><h2><a name="RequestTimeout" id="RequestTimeout">RequestTimeout</a> <a name="requesttimeout" id="requesttimeout">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
</td></tr>
[headerinit=<var>time</var>
[headerminrate=<var>rate</var> [headermax=<var>time</var>]]]
[bodyinit=<var>time</var>
[bodyminrate=<var>rate</var> [bodymax=<var>time</var>]]]
</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; all values 0</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
</table>
<p>This directive can set various timeouts for receiving the request headers
and the request body from the client. If the client fails to send headers or
body within the configured time, a <code>408 REQUEST TIME OUT</code> error
is sent.</p>
<p>For SSL virtual hosts, the header timeout values include the time needed
to do the initial SSL handshake. 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>RequestTimeout</code> is only effective after the server process has
received the socket.</p>
<p>For the timeout parameters, the value 0 means no limit.</p>
<dl>
<dt><code>headerinit</code></dt>
<dd>The initial timeout for receiving the request headers in seconds.
Also the timout for receiving the first byte of the request. If
<code>headerminrate</code> is not set, the request line and all headers
must be received within this time.</dd>
<dt><code>headerminrate</code></dt>
<dd>The minimum data rate for receiving the request headers in
according to this data rate.</dd>
<dt><code>headermax</code></dt>
<dd>The maximum timeout for receiving the request headers in seconds.
The timeout cannot be increased above this value by
<code>headerminrate</code>.</dd>
<dt><code>bodyinit</code></dt>
<dd>The initial timeout for receiving the request body in seconds.
Also the timout for receiving the first byte of the request body. If
<code>bodyminrate</code> is not set, the complete request body must be
received within this time.</dd>
<dt><code>bodyminrate</code></dt>
<dd>The minimum data rate for receiving the request body in
according to this data rate.</dd>
<dt><code>bodymax</code></dt>
<dd>The maximum timeout for receiving the request body in seconds.
The timeout cannot be increased above this value by
<code>bodyminrate</code></dd>
</dl>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
</div><div id="footer">
<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>
<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>
</body></html>