mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-08-06 23:27:04 +02:00
Code Issues Projects Releases Wiki Activity

DOC: configuration: clarify http-request wait-for-body

Browse Source 
Make it more explicit what happens in the various scenarios that cause
HAProxy to stop waiting when "http-request wait-for-body" is used.

Also fix a couple of grammatical errors.

Fixes: #2410
Signed-Off-By: Thayne McCombs <astrothayne@gmail.com>
This commit is contained in:
Thayne McCombs 2024-01-28 22:07:32 -07:00 committed by Willy Tarreau
parent 535b247bf6
commit 001bddf48c
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/configuration.txt
View File

@ -15229,13 +15229,21 @@ wait-for-body time <time> [ at-least <bytes> ]
Usable in: TCP RqCon| RqSes| RqCnt| RsCnt| HTTP Req| Res| Aft Usable in: TCP RqCon| RqSes| RqCnt| RsCnt| HTTP Req| Res| Aft
- | - | - | - | X | X | - - | - | - | - | X | X | -
This will delay the processing of the request or response waiting for the This will delay the processing of the request or response until one of the
payload for at most <time> milliseconds. if "at-least" argument is specified, following conditions occurs:
HAProxy stops waiting for the payload when the first <bytes> bytes are - The full request body is received, in which case processing proceeds
received. 0 means no limit, it is the default value. Regardless the normally.
"at-least" argument value, HAProxy stops to wait if the whole payload is - <bytes> bytes have been received, when the "at-least" argument is given and
received or if the request buffer is full. This action may be used as a <bytes> is non-zero, in which case processing proceeds normally.
replacement to "option http-buffer-request". - The request buffer is full, in which case processing proceeds normally. The
size of this buffer is determined by the "tune.bufsize" option.
- The request has been waiting for more than <time> milliseconds. In this
case HAProxy will respond with a 408 "Request Timeout" error to the client
and stop processing the request. Note that if any of the other conditions
happens first, this timeout will not occur even if the full body has
not yet been recieved.
This action may be used as a replacement for "option http-buffer-request".
Arguments : Arguments :
@ -15244,7 +15252,7 @@ wait-for-body time <time> [ at-least <bytes> ]
<bytes> is optional. It is the minimum payload size to receive to stop to <bytes> is optional. It is the minimum payload size to receive to stop to
wait. It follows the HAProxy size format and is expressed in wait. It follows the HAProxy size format and is expressed in
bytes. bytes. A value of 0 (the default) means no limit.
Example: Example:
http-request wait-for-body time 1s at-least 1k if METH_POST http-request wait-for-body time 1s at-least 1k if METH_POST