mirror of
https://github.com/apache/httpd.git
synced 2025-04-18 22:24:07 +03:00
01055edef2
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1907148 13f79535-47bb-0310-9956-ffa450edef68
227 lines
13 KiB
XML
227 lines
13 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
<!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_reqtimeout - Apache HTTP Server Version 2.5</title>
|
||
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
||
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
||
<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" />
|
||
<script src="../style/scripts/prettify.min.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<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>
|
||
<p class="apache">Apache HTTP Server Version 2.5</p>
|
||
<img alt="" src="../images/feather.png" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<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.5</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_reqtimeout</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Set timeout and minimum data rate for receiving requests
|
||
</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>reqtimeout_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_reqtimeout.c</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
<p>This module provides a convenient way to set timeouts and minimum data
|
||
rates for receiving requests. Should a timeout occur or a data rate be
|
||
to low, the corresponding connection will be closed by the server.</p>
|
||
|
||
<p>This is logged at <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code>
|
||
<code>info</code>.</p>
|
||
|
||
<p>If needed, the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> directive
|
||
can be tweaked to explicitly log it:</p>
|
||
<pre class="prettyprint lang-config">LogLevel reqtimeout:info</pre>
|
||
|
||
</div>
|
||
<div id="quickview"><h3>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
|
||
</ul><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#requestreadtimeout">RequestReadTimeout</a></li>
|
||
</ul>
|
||
<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__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_reqtimeout">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_reqtimeout">Report a bug</a></li></ul><h3>See also</h3>
|
||
<ul class="seealso">
|
||
<li><a href="#comments_section">Comments</a></li></ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="examples" id="examples">Examples</a> <a title="Permanent link" href="#examples" class="permalink">¶</a></h2>
|
||
|
||
<ol>
|
||
<li>
|
||
Allow for 5 seconds to complete the TLS handshake, 10 seconds to
|
||
receive the request headers and 30 seconds for receiving the
|
||
request body:
|
||
|
||
<pre class="prettyprint lang-config">RequestReadTimeout handshake=5 header=10 body=30</pre>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
Allow at least 10 seconds to receive the request body.
|
||
If the client sends data, increase the timeout by 1 second for every
|
||
1000 bytes received, with no upper limit for the timeout (except for
|
||
the limit given indirectly by
|
||
<code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code>):
|
||
|
||
<pre class="prettyprint lang-config">RequestReadTimeout body=10,MinRate=1000</pre>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
Allow at least 10 seconds to receive the request headers.
|
||
If the client sends data, increase the timeout by 1 second for every
|
||
500 bytes received. But do not allow more than 30 seconds for the
|
||
request headers:
|
||
|
||
<pre class="prettyprint lang-config">RequestReadTimeout header=10-30,MinRate=500</pre>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
Usually, a server should have both header and body timeouts configured.
|
||
If a common configuration is used for http and https virtual hosts, the
|
||
timeouts should not be set too low:
|
||
|
||
<pre class="prettyprint lang-config">RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500</pre>
|
||
|
||
</li>
|
||
|
||
</ol>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="RequestReadTimeout" id="RequestReadTimeout">RequestReadTimeout</a> <a name="requestreadtimeout" id="requestreadtimeout">Directive</a> <a title="Permanent link" href="#requestreadtimeout" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set timeout values for completing the TLS handshake, receiving
|
||
the request headers and/or body from client.
|
||
</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestReadTimeout
|
||
[handshake=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
|
||
[header=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
|
||
[body=<var>timeout</var>[-<var>maxtimeout</var>][,MinRate=<var>rate</var>]
|
||
</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RequestReadTimeout handshake=0 header=20-40,MinRate=500 body=20,MinRate=500</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_reqtimeout</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Defaulted to disabled in version 2.3.14 and earlier. The
|
||
<code>handshake</code> stage is available since version 2.4.39.
|
||
</td></tr>
|
||
</table>
|
||
<p>This directive can set various timeouts for completing the TLS handshake,
|
||
receiving the request headers and/or the request body from the client.
|
||
If the client fails to complete each of these stages within the configured
|
||
time, a <code>408 REQUEST TIME OUT</code> error is sent.</p>
|
||
|
||
<p>For SSL virtual hosts, the <code>handshake</code> timeout values is the time
|
||
needed to do the initial SSL handshake. If the user's browser is configured to
|
||
query certificate revocation lists and the CRL server is not reachable, the
|
||
initial SSL handshake may take a significant time until the browser gives up
|
||
waiting for the CRL. Therefore the <code>handshake</code> timeout should take
|
||
this possible overhead into consideration for SSL virtual hosts (if necessary).
|
||
The body timeout values include the time needed for SSL renegotiation
|
||
(if necessary).</p>
|
||
|
||
<p>When an <code class="directive"><a href="../mod/core.html#acceptfilter">AcceptFilter</a></code> is in use
|
||
(usually the case on Linux and FreeBSD), the socket is not sent to the
|
||
server process before at least one byte (or the whole request for
|
||
<code>httpready</code>) is received. The handshake and header timeouts
|
||
configured with <code class="directive">RequestReadTimeout</code> are only effective
|
||
after the server process has received the socket.</p>
|
||
|
||
<p>When waiting for a subsequent request on a kept-alive
|
||
connection, the timeout configured by <code class="directive"><a href="../mod/core.html#keepalivetimeout">KeepAliveTimeout</a></code> applies regardless of
|
||
whether <code class="directive">RequestReadTimeout</code> is also
|
||
used.</p>
|
||
|
||
<p>For each of the three timeout stages (handshake, header or body), there are
|
||
three ways to specify the timeout:
|
||
</p>
|
||
|
||
<ul>
|
||
|
||
<li><strong>Fixed timeout value</strong>:<br />
|
||
|
||
<div class="example"><p><code><var>stage</var>=<var>timeout</var></code></p></div>
|
||
|
||
<p>The time in seconds allowed for completing the whole stage (handshaking,
|
||
reading all of the request headers or body). A value of 0 means no limit.</p>
|
||
</li>
|
||
|
||
<li><strong>Disable module for a vhost</strong>:<br />
|
||
|
||
<div class="example"><p><code>handshake=0 header=0 body=0</code></p></div>
|
||
|
||
<p>This disables <code class="module"><a href="../mod/mod_reqtimeout.html">mod_reqtimeout</a></code> completely (note that
|
||
<code>handshake=0</code> is the default already and could be omitted).</p>
|
||
</li>
|
||
|
||
<li><strong>Timeout value that is increased when data is
|
||
received</strong>:<br />
|
||
<div class="example"><p><code>
|
||
<var>stage</var>=<var>timeout</var>,MinRate=<var>data_rate</var>
|
||
</code></p></div>
|
||
|
||
<p>Same as above, but whenever data is received, the timeout value is
|
||
increased according to the specified minimum data rate (in bytes per
|
||
second).</p>
|
||
</li>
|
||
|
||
<li><strong>Timeout value that is increased when data is received, with an
|
||
upper bound</strong>:<br />
|
||
<div class="example"><p><code>
|
||
<var>stage</var>=<var>timeout</var>-<var>maxtimeout</var>,MinRate=<var>data_rate</var>
|
||
</code></p></div>
|
||
|
||
<p>Same as above, but the timeout will not be increased above the second
|
||
value of the specified timeout range.</p>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_reqtimeout.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_reqtimeout.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</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 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
|
||
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
var comments_shortname = 'httpd';
|
||
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_reqtimeout.html';
|
||
(function(w, d) {
|
||
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
|
||
d.write('<div id="comments_thread"><\/div>');
|
||
var s = d.createElement('script');
|
||
s.type = 'text/javascript';
|
||
s.async = true;
|
||
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
|
||
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
||
}
|
||
else {
|
||
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
|
||
}
|
||
})(window, document);
|
||
//--><!]]></script></div><div id="footer">
|
||
<p class="apache">Copyright 2023 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>
|
||
<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[//><!--
|
||
if (typeof(prettyPrint) !== 'undefined') {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |