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 Version 2.5</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.min.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/quickreference.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></table>
  34 </div>
  35 <div id="quickview"><h3 class="directives">Directives</h3>
  36 <ul id="toc">
  37 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
  38 </ul>
  39 <h3>Topics</h3>
  40 <ul id="topics">
  41 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  42 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  43 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  44 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
  45 <table class="directive">
  46 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
  47 </td></tr>
  48 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
  49 [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
  50 [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
  51 </code></td></tr>
  52 <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>
  53 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  54 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  55 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
  56 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in
  57 version 2.3.14 and earlier.</td></tr>
  58 </table>
  59     <p>This directive can set various timeouts for receiving the request headers
  60     and the request body from the client. If the client fails to send headers or
  61     body within the configured time, a <code>408 REQUEST TIME OUT</code> error
  62     is sent.</p>
  63
  64     <p>For SSL virtual hosts, the header timeout values include the time needed
  65     to do the initial SSL handshake.  If the user's browser is configured to
  66     query certificate revocation lists and the CRL server is not reachable, the
  67     initial SSL handshake may take a significant time until the browser gives up
  68     waiting for the CRL.  Therefore the header timeout values should not be set
  69     to very low values for SSL virtual hosts.
  70     The body timeout values include the time needed for SSL renegotiation
  71     (if necessary).</p>
  72
  73     <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
  74     (usually the case on Linux and FreeBSD), the socket is not sent to the
  75     server process before at least one byte (or the whole request for
  76     <code>httpready</code>) is received. The header timeout configured with
  77     <code>RequestReadTimeout</code> is only effective after the server process has
  78     received the socket.</p>
  79
  80     <p>For each of the two timeout types (header or body), there are three ways
  81     to specify the timeout:
  82     </p>
  83
  84     <ul>
  85
  86     <li><strong>Fixed timeout value</strong>:<br />
  87
  88     <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
  89
  90     <p>The time in seconds allowed for reading all of the request headers or
  91     body, respectively. A value of 0 means no limit.</p>
  92     </li>
  93
  94     <li><strong>Disable module for a vhost:</strong>:<br />
  95
  96     <div class="example"><p><code>header=0 body=0</code></p></div>
  97
  98     <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p>
  99     </li>
 100
 101     <li><strong>Timeout value that is increased when data is
 102     received</strong>:<br />
 103     <div class="example"><p><code>
 104     <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
 105     </code></p></div>
 106
 107     <p>Same as above, but whenever data is received, the timeout value is
 108     increased according to the specified minimum data rate (in bytes per
 109     second).</p>
 110     </li>
 111
 112     <li><strong>Timeout value that is increased when data is received, with an
 113     upper bound</strong>:<br />
 114     <div class="example"><p><code>
 115     <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
 116     </code></p></div>
 117
 118     <p>Same as above, but the timeout will not be increased above the second
 119     value of the specified timeout range.</p>
 120     </li>
 121
 122     </ul>
 123
 124
 125 </div>
 126 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 127 <div class="section">
 128 <h2><a name="examples" id="examples">Examples</a></h2>
 129
 130     <ol>
 131       <li>
 132         Allow 10 seconds to receive the request including the headers and
 133         30 seconds for receiving the request body:
 134
 135         <pre class="prettyprint lang-config">RequestReadTimeout header=10 body=30</pre>
 136
 137       </li>
 138
 139       <li>
 140         Allow at least 10 seconds to receive the request body.
 141         If the client sends data, increase the timeout by 1 second for every
 142         1000 bytes received, with no upper limit for the timeout (except for
 143         the limit given indirectly by
 144         <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
 145
 146         <pre class="prettyprint lang-config">RequestReadTimeout body=10,MinRate=1000</pre>
 147
 148       </li>
 149
 150       <li>
 151         Allow at least 10 seconds to receive the request including the headers.
 152         If the client sends data, increase the timeout by 1 second for every
 153         500 bytes received. But do not allow more than 30 seconds for the
 154         request including the headers:
 155
 156         <pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre>
 157
 158       </li>
 159
 160       <li>
 161         Usually, a server should have both header and body timeouts configured.
 162         If a common configuration is used for http and https virtual hosts, the
 163         timeouts should not be set too low:
 164
 165         <pre class="prettyprint lang-config">RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500</pre>
 166
 167       </li>
 168
 169     </ol>
 170 </div>
 171 </div>
 172 <div class="bottomlang">
 173 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
 174 </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>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 175 <script type="text/javascript"><!--//--><![CDATA[//><!--
 176 var comments_shortname = 'httpd';
 177 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
 178 (function(w, d) {
 179     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 180         d.write('<div id="comments_thread"><\/div>');
 181         var s = d.createElement('script');
 182         s.type = 'text/javascript';
 183         s.async = true;
 184         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 185         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 186     }
 187     else {
 188         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 189     }
 190 })(window, document);
 191 //--><!]]></script></div><div id="footer">
 192 <p class="apache">Copyright 2015 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>
 193 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
 194 if (typeof(prettyPrint) !== 'undefined') {
 195     prettyPrint();
 196 }
 197 //--><!]]></script>
 198 </body></html>