manual/mod/mod_reqtimeout.html.en

	mod_reqtimeout.html.en revision 2e0e3814627be5f1f08d890663cfa6c1f7671a4c
47feede6777f217fb2e2dff71635da04898e0077nd<?xml version="1.0" encoding="ISO-8859-1"?>
47feede6777f217fb2e2dff71635da04898e0077nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
47feede6777f217fb2e2dff71635da04898e0077nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
47feede6777f217fb2e2dff71635da04898e0077nd        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
47feede6777f217fb2e2dff71635da04898e0077nd              This file is generated from xml source: DO NOT EDIT
47feede6777f217fb2e2dff71635da04898e0077nd        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
47feede6777f217fb2e2dff71635da04898e0077nd      -->
47feede6777f217fb2e2dff71635da04898e0077nd<title>mod_reqtimeout - Apache HTTP Server</title>
47feede6777f217fb2e2dff71635da04898e0077nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
47feede6777f217fb2e2dff71635da04898e0077nd<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>
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<body>
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<div id="page-header">
47feede6777f217fb2e2dff71635da04898e0077nd<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>
47feede6777f217fb2e2dff71635da04898e0077nd<p class="apache">Apache HTTP Server Version 2.3</p>
47feede6777f217fb2e2dff71635da04898e0077nd<img alt="" src="/images/feather.gif" /></div>
47feede6777f217fb2e2dff71635da04898e0077nd<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<div id="path">
47feede6777f217fb2e2dff71635da04898e0077nd<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>
47feede6777f217fb2e2dff71635da04898e0077nd<div id="page-content">
47feede6777f217fb2e2dff71635da04898e0077nd<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<div class="toplang">
47feede6777f217fb2e2dff71635da04898e0077nd<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
47feede6777f217fb2e2dff71635da04898e0077nd</div>
47feede6777f217fb2e2dff71635da04898e0077nd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung</td></tr>
47feede6777f217fb2e2dff71635da04898e0077nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>reqtimeout_module</td></tr>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_reqtimeout.c</td></tr>
47feede6777f217fb2e2dff71635da04898e0077nd<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
47feede6777f217fb2e2dff71635da04898e0077nd</div>
47feede6777f217fb2e2dff71635da04898e0077nd<div id="quickview"><h3 class="directives">Directives</h3>
47feede6777f217fb2e2dff71635da04898e0077nd<ul id="toc">
47feede6777f217fb2e2dff71635da04898e0077nd<li><img alt="" src="/images/down.gif" /> <a href="#requesttimeout">RequestTimeout</a></li>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener</ul>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<h3>Topics</h3>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<ul id="topics">
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener</ul></div>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener<div class="section">
47feede6777f217fb2e2dff71635da04898e0077nd<h2><a name="examples" id="examples">Examples</a></h2>
47feede6777f217fb2e2dff71635da04898e0077nd
47feede6777f217fb2e2dff71635da04898e0077nd    <ol>
47feede6777f217fb2e2dff71635da04898e0077nd      <li>
47feede6777f217fb2e2dff71635da04898e0077nd        Allow 10 seconds to receive the request including the headers and
47feede6777f217fb2e2dff71635da04898e0077nd        30 seconds for receiving the request body:
47feede6777f217fb2e2dff71635da04898e0077nd
47feede6777f217fb2e2dff71635da04898e0077nd        <div class="example"><p><code>
47feede6777f217fb2e2dff71635da04898e0077nd          RequestTimeout headerinit=10 bodyinit=30
47feede6777f217fb2e2dff71635da04898e0077nd        </code></p></div>
47feede6777f217fb2e2dff71635da04898e0077nd      </li>
47feede6777f217fb2e2dff71635da04898e0077nd
47feede6777f217fb2e2dff71635da04898e0077nd      <li>
47feede6777f217fb2e2dff71635da04898e0077nd        Allow at least 10 seconds to receive the request including the headers.
47feede6777f217fb2e2dff71635da04898e0077nd        If the client sends data, increase the timeout by 1 second for every
47feede6777f217fb2e2dff71635da04898e0077nd        500 bytes received. But do not allow more than 30 seconds for the
47feede6777f217fb2e2dff71635da04898e0077nd        request including the headers:
47feede6777f217fb2e2dff71635da04898e0077nd
47feede6777f217fb2e2dff71635da04898e0077nd        <div class="example"><p><code>
47feede6777f217fb2e2dff71635da04898e0077nd          RequestTimeout headerinit=10 headerminrate=500 headermax=30
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener        </code></p></div>
47feede6777f217fb2e2dff71635da04898e0077nd      </li>
47feede6777f217fb2e2dff71635da04898e0077nd
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener      <li>
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener        Allow at least 10 seconds to receive the request body.
707c2713ba8f1aa11c1f22f69d3ec73522054b9fcovener        If the client sends data, increase the timeout by 1 second for every
47feede6777f217fb2e2dff71635da04898e0077nd        1000 bytes received, with no upper limit for the timeout (exept for
47feede6777f217fb2e2dff71635da04898e0077nd        the limit given indirectly by
47feede6777f217fb2e2dff71635da04898e0077nd        <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
47feede6777f217fb2e2dff71635da04898e0077nd
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung        <div class="example"><p><code>
47feede6777f217fb2e2dff71635da04898e0077nd          RequestTimeout bodyinit=10 bodyminrate=1000
5effc8b39fae5cd169d17f342bfc265705840014rbowen        </code></p></div>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd      </li>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd    </ol>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd</div>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
47feede6777f217fb2e2dff71635da04898e0077nd<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestTimeout
[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>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</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 minumum data rate for receiving the request headers in
    bytes/second. Whenever data is received, the timeout is increased
    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 minumum data rate for receiving the request body in
    bytes/second. Whenever data is received, the timeout is increased
    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">&nbsp;en&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2009 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>