Skip to content

Commit 810a435

Browse files
Add documentation for channel_request_lookahead
1 parent f4ba1c2 commit 810a435

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/arguments.rst

+14
Original file line numberDiff line numberDiff line change
@@ -314,3 +314,17 @@ url_prefix
314314
be stripped of the prefix.
315315

316316
Default: ``''``
317+
318+
channel_request_lookahead
319+
Sets the amount of requests we can continue to read from the socket, while
320+
we are processing current requests. The default value won't allow any
321+
lookahead, increase it above ``0`` to enable.
322+
323+
When enabled this inserts a callable ``waitress.client_disconnected`` into
324+
the environment that allows the task to check if the client disconnected
325+
while waiting for the response at strategic points in the execution and to
326+
cancel the operation.
327+
328+
Default: ``0``
329+
330+
.. versionadded:: 2.0.0

0 commit comments

Comments
 (0)