From: Ben Darnell Date: Tue, 22 Apr 2025 17:28:59 +0000 (-0400) Subject: websocket: Small doc updates X-Git-Tag: v6.5.0b1~11^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3483%2Fhead;p=thirdparty%2Ftornado.git websocket: Small doc updates - Mention units for ping settings (#2655) - Remove obsolete reference to 30s default timeout - Link to a more recent version of python docs --- diff --git a/tornado/websocket.py b/tornado/websocket.py index 4fbb2da1..a7089c81 100644 --- a/tornado/websocket.py +++ b/tornado/websocket.py @@ -204,6 +204,8 @@ class WebSocketHandler(tornado.web.RequestHandler): If the application setting ``websocket_ping_interval`` has a non-zero value, a ping will be sent periodically, and the connection will be closed if a response is not received before the ``websocket_ping_timeout``. + Both settings are in seconds; floating point values are allowed. + The default timeout is equal to the interval. Messages larger than the ``websocket_max_message_size`` application setting (default 10MiB) will not be accepted. @@ -308,7 +310,7 @@ class WebSocketHandler(tornado.web.RequestHandler): Set ``websocket_ping_timeout = 0`` to disable the ping timeout. - Default: ``min(ping_interval, 30)`` + Default: equal to the ``ping_interval``. .. versionchanged:: 6.5.0 Default changed from the max of 3 pings or 30 seconds. @@ -406,8 +408,8 @@ class WebSocketHandler(tornado.web.RequestHandler): ``mem_level`` specifies the amount of memory used for the internal compression state. - These parameters are documented in details here: - https://docs.python.org/3.6/library/zlib.html#zlib.compressobj + These parameters are documented in detail here: + https://docs.python.org/3.13/library/zlib.html#zlib.compressobj .. versionadded:: 4.1