mod_reqtimeout.html.en revision ba4c888b67368c21daa6a84921bc6644cdb80cb5
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<?xml version="1.0" encoding="ISO-8859-1"?>
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 -->
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<title>mod_reqtimeout - Apache HTTP Server</title>
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<body>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div id="page-header">
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<p class="apache">Apache HTTP Server Version 2.3</p>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<img alt="" src="/images/feather.gif" /></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div id="path">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div id="page-content">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div class="toplang">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</div>
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
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</td></tr>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</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>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div id="quickview"><h3 class="directives">Directives</h3>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<ul id="toc">
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf<li><img alt="" src="/images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</ul>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<h3>Topics</h3>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<ul id="topics">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</ul></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div class="section">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<h2><a name="examples" id="examples">Examples</a></h2>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <ol>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf Allow 10 seconds to receive the request including the headers and
af4381d113faafc97340eaaa008840c7fcbcc8fdsf 30 seconds for receiving the request body:
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <div class="example"><p><code>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf RequestReadTimeout header=10 body=30
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <li>
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>):
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <div class="example"><p><code>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf RequestReadTimeout body=10,MinRate=1000
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <li>
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:
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <div class="example"><p><code>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf RequestReadTimeout header=10-30,MinRate=500
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf </ol>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</div>
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<table class="directive">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</td></tr>
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>]
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</code></td></tr>
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>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</table>
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
af4381d113faafc97340eaaa008840c7fcbcc8fdsf <p>For SSL virtual hosts, the header timeout values include the time needed
2e0e3814627be5f1f08d890663cfa6c1f7671a4crpluem to do the initial SSL handshake. The body timeout values include the time
2e0e3814627be5f1f08d890663cfa6c1f7671a4crpluem needed for SSL renegotiation (if necessary).</p>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
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>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <p>For each of the two timeout types (header or body), there are three ways
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf to specify the timeout:
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf </p>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <ul>
2e0e3814627be5f1f08d890663cfa6c1f7671a4crpluem
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <li><strong>Fixed timeout value</strong>:<br />
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
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 </li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <li><strong>Timeout value that is increased when data is
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf received</strong>:<br />
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <div class="example"><p><code>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf </code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
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>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <li><strong>Timeout value that is increased when data is received, with an
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf upper bound</strong>:<br />
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <div class="example"><p><code>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf </code></p></div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf <p>Same as above, but the timeout will not be increased above the second
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf value of the specified timeout range.</p>
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf </li>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
efb3a31a4ca193ac8629a4c039d481c29171d6e0sf </ul>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</div>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<div class="bottomlang">
af4381d113faafc97340eaaa008840c7fcbcc8fdsf<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</div><div id="footer">
50039065d571fe01fd458a3f031c995a1fd53c22rbowen<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>
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>
af4381d113faafc97340eaaa008840c7fcbcc8fdsf</body></html>