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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_reqtimeout - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
  32 </td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr></table>
  36 </div>
  37 <div id="quickview"><h3>Topics</h3>
  38 <ul id="topics">
  39 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  40 </ul><h3 class="directives">Directives</h3>
  41 <ul id="toc">
  42 <li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
  43 </ul>
  44 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_reqtimeout">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_reqtimeout">Report a bug</a></li></ul><h3>See also</h3>
  45 <ul class="seealso">
  46 <li><a href="#comments_section">Comments</a></li></ul></div>
  47 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  48 <div class="section">
  49 <h2><a name="examples" id="examples">Examples</a></h2>
  50
  51     <ol>
  52       <li>
  53         Allow 10 seconds to receive the request including the headers and
  54         30 seconds for receiving the request body:
  55
  56         <pre class="prettyprint lang-config">RequestReadTimeout header=10 body=30</pre>
  57
  58       </li>
  59
  60       <li>
  61         Allow at least 10 seconds to receive the request body.
  62         If the client sends data, increase the timeout by 1 second for every
  63         1000 bytes received, with no upper limit for the timeout (except for
  64         the limit given indirectly by
  65         <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
  66
  67         <pre class="prettyprint lang-config">RequestReadTimeout body=10,MinRate=1000</pre>
  68
  69       </li>
  70
  71       <li>
  72         Allow at least 10 seconds to receive the request including the headers.
  73         If the client sends data, increase the timeout by 1 second for every
  74         500 bytes received. But do not allow more than 30 seconds for the
  75         request including the headers:
  76
  77         <pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre>
  78
  79       </li>
  80
  81       <li>
  82         Usually, a server should have both header and body timeouts configured.
  83         If a common configuration is used for http and https virtual hosts, the
  84         timeouts should not be set too low:
  85
  86         <pre class="prettyprint lang-config">RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500</pre>
  87
  88       </li>
  89
  90     </ol>
  91 </div>
  92 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  93 <div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2>
  94 <table class="directive">
  95 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client.
  96 </td></tr>
  97 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
  98 [header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
  99 [body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
 100 </code></td></tr>
 101 <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>
 102 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 103 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 104 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
 105 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in
 106 version 2.3.14 and earlier.</td></tr>
 107 </table>
 108     <p>This directive can set various timeouts for receiving the request headers
 109     and the request body from the client. If the client fails to send headers or
 110     body within the configured time, a <code>408 REQUEST TIME OUT</code> error
 111     is sent.</p>
 112
 113     <p>For SSL virtual hosts, the header timeout values include the time needed
 114     to do the initial SSL handshake.  If the user's browser is configured to
 115     query certificate revocation lists and the CRL server is not reachable, the
 116     initial SSL handshake may take a significant time until the browser gives up
 117     waiting for the CRL.  Therefore the header timeout values should not be set
 118     to very low values for SSL virtual hosts.
 119     The body timeout values include the time needed for SSL renegotiation
 120     (if necessary).</p>
 121
 122     <p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
 123     (usually the case on Linux and FreeBSD), the socket is not sent to the
 124     server process before at least one byte (or the whole request for
 125     <code>httpready</code>) is received. The header timeout configured with
 126     <code>RequestReadTimeout</code> is only effective after the server process has
 127     received the socket.</p>
 128
 129     <p>For each of the two timeout types (header or body), there are three ways
 130     to specify the timeout:
 131     </p>
 132
 133     <ul>
 134
 135     <li><strong>Fixed timeout value</strong>:<br />
 136
 137     <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div>
 138
 139     <p>The time in seconds allowed for reading all of the request headers or
 140     body, respectively. A value of 0 means no limit.</p>
 141     </li>
 142
 143     <li><strong>Disable module for a vhost:</strong>:<br />
 144
 145     <div class="example"><p><code>header=0 body=0</code></p></div>
 146
 147     <p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely.</p>
 148     </li>
 149
 150     <li><strong>Timeout value that is increased when data is
 151     received</strong>:<br />
 152     <div class="example"><p><code>
 153     <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
 154     </code></p></div>
 155
 156     <p>Same as above, but whenever data is received, the timeout value is
 157     increased according to the specified minimum data rate (in bytes per
 158     second).</p>
 159     </li>
 160
 161     <li><strong>Timeout value that is increased when data is received, with an
 162     upper bound</strong>:<br />
 163     <div class="example"><p><code>
 164     <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
 165     </code></p></div>
 166
 167     <p>Same as above, but the timeout will not be increased above the second
 168     value of the specified timeout range.</p>
 169     </li>
 170
 171     </ul>
 172
 173
 174 </div>
 175 </div>
 176 <div class="bottomlang">
 177 <p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English">&nbsp;en&nbsp;</a></p>
 178 </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>
 179 <script type="text/javascript"><!--//--><![CDATA[//><!--
 180 var comments_shortname = 'httpd';
 181 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
 182 (function(w, d) {
 183     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 184         d.write('<div id="comments_thread"><\/div>');
 185         var s = d.createElement('script');
 186         s.type = 'text/javascript';
 187         s.async = true;
 188         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 189         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 190     }
 191     else {
 192         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 193     }
 194 })(window, document);
 195 //--><!]]></script></div><div id="footer">
 196 <p class="apache">Copyright 2016 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>
 197 <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[//><!--
 198 if (typeof(prettyPrint) !== 'undefined') {
 199     prettyPrint();
 200 }
 201 //--><!]]></script>
 202 </body></html>