Skip to content

Commit

Permalink
Add documentation for channel_request_lookahead
Browse files Browse the repository at this point in the history
  • Loading branch information
digitalresistor committed Oct 27, 2024
1 parent f4ba1c2 commit 810a435
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,3 +314,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

0 comments on commit 810a435

Please sign in to comment.