From: Stefan Fritsch Date: Tue, 6 Oct 2009 21:20:33 +0000 (+0000) Subject: Add some docs for mod_reqtimeout. X-Git-Tag: 2.3.3~191 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6cb0d5837a99fd435f844c7f8717060e9c6cdaeb;p=apache Add some docs for mod_reqtimeout. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@822509 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/allmodules.xml b/docs/manual/mod/allmodules.xml index ce7c13fbdb..39a51eef65 100644 --- a/docs/manual/mod/allmodules.xml +++ b/docs/manual/mod/allmodules.xml @@ -76,6 +76,7 @@ mod_proxy_http.xml mod_proxy_scgi.xml mod_remoteip.xml + mod_reqtimeout.xml mod_request.xml mod_rewrite.xml mod_sed.xml diff --git a/docs/manual/mod/mod_reqtimeout.xml b/docs/manual/mod/mod_reqtimeout.xml new file mode 100644 index 0000000000..01e3750549 --- /dev/null +++ b/docs/manual/mod/mod_reqtimeout.xml @@ -0,0 +1,141 @@ + + + + + + + + + +mod_reqtimeout +Set timeout and minimum data rate for receiving requests + +Experimental +mod_reqtimeout.c +reqtimeout_module +Available in Apache 2.3 and later + +
Examples + +
    +
  1. + Allow 10 seconds to receive the request including the headers and + 30 seconds for receiving the request body: + + + ReqTimeout headerinit=10 bodyinit=30 + +
    2. + +
  2. + Allow at least 10 seconds to receive the request including the 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 including the headers: + + + ReqTimeout headerinit=10 headerminrate=500 headermax=30 + +
    3. + +
  3. + 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 (exept for + the limit given indirectly by + LimitRequestBody): + + + ReqTimeout bodyinit=10 bodyminrate=1000 + +
    4. + +
+
+ + +ReqTimeout +Set timeout values for receiving request headers and body from client. + +ReqTimeout +[headerinit=time +[headerminrate=rate [headermax=time]]] +[bodyinit=time +[bodyminrate=rate [bodymax=time]]] + +Unset; all values 0 +server configvirtual host + + + +

This directive can set various timeouts for receiving the request headers + and the request body from the client. If the client fails to send headers or + body within the configured time, a 408 REQUEST TIME OUT error + is sent.

+ +

For SSL virtual hosts, the header timeout values include the time needed + to do the SSL handshake.

+ +

When an AcceptFilter 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 + httpready) is received. The header timeout configured with + ReqTimeout is only effective after the server process has + received the socket.

+ +
+ +
headerinit
+
The initial timeout for receiving the request headers in seconds. + Also the timout for receiving the first byte of the request. If + headerminrate is not set, the request line and all headers + must be received within this time.
+ +
headerminrate
+
The minumum data rate for receiving the request headers in + bytes/second. Whenever data is received, the timeout is increased + according to this data rate.
+ +
headermax
+
The maximum timeout for receiving the request headers in seconds. + The timeout cannot be increased above this value by + headerminrate.
+ +
bodyinit
+
The initial timeout for receiving the request body in seconds. + Also the timout for receiving the first byte of the request body. If + bodyminrate is not set, the complete request body must be + received within this time.
+ +
bodyminrate
+
The minumum data rate for receiving the request body in + bytes/second. Whenever data is received, the timeout is increased + according to this data rate.
+ +
bodymax
+
The maximum timeout for receiving the request body in seconds. + The timeout cannot be increased above this value by + bodyminrate
+ +
+ + + + + + diff --git a/docs/manual/mod/mod_reqtimeout.xml.meta b/docs/manual/mod/mod_reqtimeout.xml.meta new file mode 100644 index 0000000000..42accd8f96 --- /dev/null +++ b/docs/manual/mod/mod_reqtimeout.xml.meta @@ -0,0 +1,12 @@ + + + + + mod_reqtimeout + /mod/ + .. + + + en + +