granicus.if.org Git - apache/blob - docs/manual/mod/mod_reqtimeout.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_reqtimeout - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
  27 </td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.15 and later</td></tr></table>
  32 </div>
  33 <div id="quickview"><h3 class="directives">Directives</h3>
  34 <ul id="toc">
  35 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
  36 </ul>
  37 <h3>Topics</h3>
  38 <ul id="topics">
  39 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  40 </ul></div>
  41 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  42 <div class="section">
  43 <h2><a name="examples" id="examples">Examples</a></h2>
  44
  45     <ol>
  46       <li>
  47         Allow 10 seconds to receive the request including the headers and
  48         30 seconds for receiving the request body:
  49
  50         <div class="example"><p><code>
  51           RequestReadTimeout header=10 body=30
  52         </code></p></div>
  53       </li>
  54
  55       <li>
  56         Allow at least 10 seconds to receive the request body.
  57         If the client sends data, increase the timeout by 1 second for every
  58         1000 bytes received, with no upper limit for the timeout (exept for
  59         the limit given indirectly by
  60         <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
  61
  62         <div class="example"><p><code>
  63           RequestReadTimeout body=10,MinRate=1000
  64         </code></p></div>
  65       </li>
  66
  67       <li>
  68         Allow at least 10 seconds to receive the request including the headers.
  69         If the client sends data, increase the timeout by 1 second for every
  70         500 bytes received. But do not allow more than 30 seconds for the
  71         request including the headers:
  72
  73         <div class="example"><p><code>
  74           RequestReadTimeout header=10-30,MinRate=500
  75         </code></p></div>
  76       </li>
  77
  78     </ol>
  79 </div>
  80 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
  82 <table class="directive">
  83 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
  84 </td></tr>
  85 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
  86 [header=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
  87 [body=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>]
  88 </code></td></tr>
  89 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; no limit</code></td></tr>
  90 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  91 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  92 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
  93 </table>
  94     <p>This directive can set various timeouts for receiving the request headers
  95     and the request body from the client. If the client fails to send headers or
  96     body within the configured time, a <code>408 REQUEST TIME OUT</code> error
  97     is sent.</p>
  98
  99     <p>For SSL virtual hosts, the header timeout values include the time needed
 100     to do the initial SSL handshake. The body timeout values include the time
 101     needed for SSL renegotiation (if necessary).</p>
 102
 103     <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
 104     (usually the case on Linux and FreeBSD), the socket is not sent to the
 105     server process before at least one byte (or the whole request for
 106     <code>httpready</code>) is received. The header timeout configured with
 107     <code>RequestReadTimeout</code> is only effective after the server process has
 108     received the socket.</p>
 109
 110     <p>For each of the two timeout types (header or body), there are three ways
 111     to specify the timeout:
 112     </p>
 113
 114     <ul>
 115
 116     <li><strong>Fixed timeout value</strong>:<br />
 117
 118     <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
 119
 120     <p>The time in seconds allowed for reading all of the request headers or
 121     body, respectively. A value of 0 means no limit.</p>
 122     </li>
 123
 124     <li><strong>Timeout value that is increased when data is
 125     received</strong>:<br />
 126     <div class="example"><p><code>
 127     <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
 128     </code></p></div>
 129
 130     <p>Same as above, but whenever data is received, the timeout value is
 131     increased according to the specified minimum data rate (in bytes per
 132     second).</p>
 133     </li>
 134
 135     <li><strong>Timeout value that is increased when data is received, with an
 136     upper bound</strong>:<br />
 137     <div class="example"><p><code>
 138     <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
 139     </code></p></div>
 140
 141     <p>Same as above, but the timeout will not be increased above the second
 142     value of the specified timeout range.</p>
 143     </li>
 144
 145     </ul>
 146
 147
 148 </div>
 149 </div>
 150 <div class="bottomlang">
 151 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
 152 </div><div id="footer">
 153 <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>
 154 <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>
 155 </body></html>