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.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <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"> en </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 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 <div class="example"><p><code> 54 RequestReadTimeout header=10 body=30 55 </code></p></div> 56 </li> 57 58 <li> 59 Allow at least 10 seconds to receive the request body. 60 If the client sends data, increase the timeout by 1 second for every 61 1000 bytes received, with no upper limit for the timeout (exept for 62 the limit given indirectly by 63 <code class="directive"><a href="/mod/core.html#limitrequestbody">LimitRequestBody</a></code>): 64 65 <div class="example"><p><code> 66 RequestReadTimeout body=10,MinRate=1000 67 </code></p></div> 68 </li> 69 70 <li> 71 Allow at least 10 seconds to receive the request including the headers. 72 If the client sends data, increase the timeout by 1 second for every 73 500 bytes received. But do not allow more than 30 seconds for the 74 request including the headers: 75 76 <div class="example"><p><code> 77 RequestReadTimeout header=10-30,MinRate=500 78 </code></p></div> 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 <div class="example"><p><code> 87 RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500 88 </code></p></div> 89 </li> 90 91 </ol> 92</div> 93<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 94<div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a></h2> 95<table class="directive"> 96<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for receiving request headers and body from client. 97</td></tr> 98<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout 99[header=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>] 100[body=<var>timeout</var>[[-<var>maxtimeout</var>],MinRate=<var>rate</var>] 101</code></td></tr> 102<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; no limit</code></td></tr> 103<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> 104<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 105<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr> 106</table> 107 <p>This directive can set various timeouts for receiving the request headers 108 and the request body from the client. If the client fails to send headers or 109 body within the configured time, a <code>408 REQUEST TIME OUT</code> error 110 is sent.</p> 111 112 <p>For SSL virtual hosts, the header timeout values include the time needed 113 to do the initial SSL handshake. If the user's browser is configured to 114 query certificate revocation lists and the CRL server is not reachable, the 115 initial SSL handshake may take a significant time until the browser gives up 116 waiting for the CRL. Therefore the header timeout values should not be set 117 to very low values for SSL virtual hosts. 118 The body timeout values include the time needed for SSL renegotiation 119 (if necessary).</p> 120 121 <p>When an <code class="directive"><a href="/mod/core.html#acceptfilter">AcceptFilter</a></code> is in use 122 (usually the case on Linux and FreeBSD), the socket is not sent to the 123 server process before at least one byte (or the whole request for 124 <code>httpready</code>) is received. The header timeout configured with 125 <code>RequestReadTimeout</code> is only effective after the server process has 126 received the socket.</p> 127 128 <p>For each of the two timeout types (header or body), there are three ways 129 to specify the timeout: 130 </p> 131 132 <ul> 133 134 <li><strong>Fixed timeout value</strong>:<br /> 135 136 <div class="example"><p><code><var>type</var>=<var>timeout</var></code></p></div> 137 138 <p>The time in seconds allowed for reading all of the request headers or 139 body, respectively. A value of 0 means no limit.</p> 140 </li> 141 142 <li><strong>Timeout value that is increased when data is 143 received</strong>:<br /> 144 <div class="example"><p><code> 145 <var>type</var>=<var>timeout</var>,MinRate=<var>data_rate</var> 146 </code></p></div> 147 148 <p>Same as above, but whenever data is received, the timeout value is 149 increased according to the specified minimum data rate (in bytes per 150 second).</p> 151 </li> 152 153 <li><strong>Timeout value that is increased when data is received, with an 154 upper bound</strong>:<br /> 155 <div class="example"><p><code> 156 <var>type</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var> 157 </code></p></div> 158 159 <p>Same as above, but the timeout will not be increased above the second 160 value of the specified timeout range.</p> 161 </li> 162 163 </ul> 164 165 166</div> 167</div> 168<div class="bottomlang"> 169<p><span>Available Languages: </span><a href="/en/mod/mod_reqtimeout.html" title="English"> en </a></p> 170</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&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> 171<script type="text/javascript"><!--//--><![CDATA[//><!-- 172var comments_shortname = 'httpd'; 173var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_reqtimeout.html'; 174(function(w, d) { 175 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 176 d.write('<div id="comments_thread"><\/div>'); 177 var s = d.createElement('script'); 178 s.type = 'text/javascript'; 179 s.async = true; 180 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 181 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 182 } 183 else { 184 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 185 } 186})(window, document); 187//--><!]]></script></div><div id="footer"> 188<p class="apache">Copyright 2013 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> 189<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[//><!-- 190if (typeof(prettyPrint) !== 'undefined') { 191 prettyPrint(); 192} 193//--><!]]></script> 194</body></html>
