mod_reqtimeout.html.en revision 7f0952c0239ea2d6e37b472db6fde4ef2718343d
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This file is generated from xml source: DO NOT EDIT
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<title>mod_reqtimeout - Apache HTTP Server</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link href="/images/favicon.ico" rel="shortcut icon" /></head>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<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>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p class="apache">Apache HTTP Server Version 2.3</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<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>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
01a939641aeb0a095851921879620c3fab295cb2Robert Wapshott<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
01a939641aeb0a095851921879620c3fab295cb2Robert Wapshott<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_reqtimeout.c</td></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.15 and later</td></tr></table>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div id="quickview"><h3 class="directives">Directives</h3>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<li><img alt="" src="/images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott<h2><a name="examples" id="examples">Examples</a></h2>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Allow 10 seconds to receive the request including the headers and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster 30 seconds for receiving the request body:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster RequestReadTimeout header=10 body=30
01a939641aeb0a095851921879620c3fab295cb2Robert Wapshott Allow at least 10 seconds to receive the request body.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster If the client sends data, increase the timeout by 1 second for every
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster 1000 bytes received, with no upper limit for the timeout (exept for
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the limit given indirectly by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster RequestReadTimeout body=10,MinRate=1000
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott Allow at least 10 seconds to receive the request including the headers.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster If the client sends data, increase the timeout by 1 second for every
01a939641aeb0a095851921879620c3fab295cb2Robert Wapshott 500 bytes received. But do not allow more than 30 seconds for the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster request including the headers:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster RequestReadTimeout header=10-30,MinRate=500
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Usually, a server should have both header and body timeouts configured.
01a939641aeb0a095851921879620c3fab295cb2Robert Wapshott If a common configuration is used for http and https virtual hosts, the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster timeouts should not be set too low:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster[header=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster[body=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; no limit</code></td></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>This directive can set various timeouts for receiving the request headers
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster and the request body from the client. If the client fails to send headers or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster body within the configured time, a <code>408 REQUEST TIME OUT</code> error
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster is sent.</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>For SSL virtual hosts, the header timeout values include the time needed
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to do the initial SSL handshake. If the user's browser is configured to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster query certificate revocation lists and the CRL server is not reachable, the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster initial SSL handshake may take a significant time until the browser gives up
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster waiting for the CRL. Therefore the header timeout values should not be set
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to very low values for SSL virtual hosts.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The body timeout values include the time needed for SSL renegotiation
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster (if necessary).</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>When an <code class="directive"><a href="/mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster (usually the case on Linux and FreeBSD), the socket is not sent to the
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott server process before at least one byte (or the whole request for
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code>httpready</code>) is received. The header timeout configured with
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code>RequestReadTimeout</code> is only effective after the server process has
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster received the socket.</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>For each of the two timeout types (header or body), there are three ways
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to specify the timeout:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <li><strong>Fixed timeout value</strong>:<br />
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>The time in seconds allowed for reading all of the request headers or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster body, respectively. A value of 0 means no limit.</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <li><strong>Timeout value that is increased when data is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>Same as above, but whenever data is received, the timeout value is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster increased according to the specified minimum data rate (in bytes per
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster second).</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <li><strong>Timeout value that is increased when data is received, with an
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <p>Same as above, but the timeout will not be increased above the second
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster value of the specified timeout range.</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p class="apache">Copyright 2011 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>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<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>