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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
  30 </td></tr>
  31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
  33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr>
  34 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTPD 2.2.15 and later</td></tr></table>
  35 </div>
  36 <div id="quickview"><h3 class="directives">Directives</h3>
  37 <ul id="toc">
  38 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
  39 </ul>
  40 <h3>Topics</h3>
  41 <ul id="topics">
  42 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  43 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  44 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  45 <div class="section">
  46 <h2><a name="examples" id="examples">Examples</a></h2>
  47
  48     <ol>
  49       <li>
  50         Allow 10 seconds to receive the request including the headers and
  51         30 seconds for receiving the request body:
  52
  53         <pre class="prettyprint lang-config">
  54           RequestReadTimeout header=10 body=30
  55         </pre>
  56
  57       </li>
  58
  59       <li>
  60         Allow at least 10 seconds to receive the request body.
  61         If the client sends data, increase the timeout by 1 second for every
  62         1000 bytes received, with no upper limit for the timeout (except for
  63         the limit given indirectly by
  64         <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
  65
  66         <pre class="prettyprint lang-config">
  67           RequestReadTimeout body=10,MinRate=1000
  68         </pre>
  69
  70       </li>
  71
  72       <li>
  73         Allow at least 10 seconds to receive the request including the headers.
  74         If the client sends data, increase the timeout by 1 second for every
  75         500 bytes received. But do not allow more than 30 seconds for the
  76         request including the headers:
  77
  78         <pre class="prettyprint lang-config">
  79           RequestReadTimeout header=10-30,MinRate=500
  80         </pre>
  81
  82       </li>
  83
  84       <li>
  85         Usually, a server should have both header and body timeouts configured.
  86         If a common configuration is used for http and https virtual hosts, the
  87         timeouts should not be set too low:
  88
  89         <pre class="prettyprint lang-config">
  90           RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
  91         </pre>
  92
  93       </li>
  94
  95     </ol>
  96 </div>
  97 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  98 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
  99 <table class="directive">
 100 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
 101 </td></tr>
 102 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
 103 [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 104 [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 105 </code></td></tr>
 106 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr>
 107 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 108 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 109 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
 110 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.2.15 and later; defaulted to disabled in
 111 version 2.3.14 and earlier.</td></tr>
 112 </table>
 113     <p>This directive can set various timeouts for receiving the request headers
 114     and the request body from the client. If the client fails to send headers or
 115     body within the configured time, a <code>408 REQUEST TIME OUT</code> error
 116     is sent.</p>
 117
 118     <p>For SSL virtual hosts, the header timeout values include the time needed
 119     to do the initial SSL handshake.  If the user's browser is configured to
 120     query certificate revocation lists and the CRL server is not reachable, the
 121     initial SSL handshake may take a significant time until the browser gives up
 122     waiting for the CRL.  Therefore the header timeout values should not be set
 123     to very low values for SSL virtual hosts.
 124     The body timeout values include the time needed for SSL renegotiation
 125     (if necessary).</p>
 126
 127     <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
 128     (usually the case on Linux and FreeBSD), the socket is not sent to the
 129     server process before at least one byte (or the whole request for
 130     <code>httpready</code>) is received. The header timeout configured with
 131     <code>RequestReadTimeout</code> is only effective after the server process has
 132     received the socket.</p>
 133
 134     <p>For each of the two timeout types (header or body), there are three ways
 135     to specify the timeout:
 136     </p>
 137
 138     <ul>
 139
 140     <li><strong>Fixed timeout value</strong>:<br />
 141
 142     <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
 143
 144     <p>The time in seconds allowed for reading all of the request headers or
 145     body, respectively. A value of 0 means no limit.</p>
 146     </li>
 147
 148     <li><strong>Disable module for a vhost:</strong>:<br />
 149
 150     <div class="example"><p><code>header=0 body=0</code></p></div>
 151
 152     <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p>
 153     </li>
 154
 155     <li><strong>Timeout value that is increased when data is
 156     received</strong>:<br />
 157     <div class="example"><p><code>
 158     <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
 159     </code></p></div>
 160
 161     <p>Same as above, but whenever data is received, the timeout value is
 162     increased according to the specified minimum data rate (in bytes per
 163     second).</p>
 164     </li>
 165
 166     <li><strong>Timeout value that is increased when data is received, with an
 167     upper bound</strong>:<br />
 168     <div class="example"><p><code>
 169     <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
 170     </code></p></div>
 171
 172     <p>Same as above, but the timeout will not be increased above the second
 173     value of the specified timeout range.</p>
 174     </li>
 175
 176     </ul>
 177
 178
 179 </div>
 180 </div>
 181 <div class="bottomlang">
 182 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
 183 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>This section is experimental!</strong><br />Comments placed here should not be expected
 184 to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
 185 <div id="disqus_thread">
 186 </div><script type="text/javascript"><!--//--><![CDATA[//><!--
 187 var lang = 'en';
 188 var disqus_shortname = 'httpd';
 189 var disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
 190 if (disqus_identifier.indexOf("httpd.apache.org") != -1) {
 191     (function() {
 192                 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
 193                 dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
 194             (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
 195         })();
 196 } else {
 197     var text = document.createTextNode("Comments have been disabled for offline viewing.");
 198     document.getElementById('disqus_thread').appendChild(text);
 199 }
 200 //--><!]]></script></div><div id="footer">
 201 <p class="apache">Copyright 2012 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>
 202 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 203 if (typeof(prettyPrint) !== undefined) {
 204     prettyPrint();
 205 }
 206 //--><!]]></script>
 207 </body></html>