From c516dad4f749d1b1b1c675680a76c1f6d2523857 Mon Sep 17 00:00:00 2001 From: Delta Regeer Date: Sat, 26 Oct 2024 22:22:32 -0600 Subject: [PATCH] Add documentation for channel_request_lookahead CVE: CVE-2024-49768 Upstream-Status: Backport [https://github.com/Pylons/waitress/commit/810a435f9e9e293bd3446a5ce2df86f59c4e7b1b] Signed-off-by: Gyorgy Sarvari --- docs/arguments.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/arguments.rst b/docs/arguments.rst index f9b9310..ba1797a 100644 --- a/docs/arguments.rst +++ b/docs/arguments.rst @@ -301,3 +301,17 @@ url_prefix be stripped of the prefix. Default: ``''`` + +channel_request_lookahead + Sets the amount of requests we can continue to read from the socket, while + we are processing current requests. The default value won't allow any + lookahead, increase it above ``0`` to enable. + + When enabled this inserts a callable ``waitress.client_disconnected`` into + the environment that allows the task to check if the client disconnected + while waiting for the response at strategic points in the execution and to + cancel the operation. + + Default: ``0`` + + .. versionadded:: 2.0.0