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