Document websocket error handling change (and StreamClosedError).
This commit is contained in:
parent
60693e011c
commit
6237407174
|
@ -43,3 +43,8 @@
|
||||||
|
|
||||||
.. autoclass:: PipeIOStream
|
.. autoclass:: PipeIOStream
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
Exceptions
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. autoexception:: StreamClosedError
|
||||||
|
|
|
@ -229,6 +229,9 @@ Multiple modules
|
||||||
`tornado.websocket`
|
`tornado.websocket`
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
* `.WebSocketHandler` now catches `.StreamClosedError` and runs
|
||||||
|
`~.WebSocketHandler.on_close` immediately instead of logging a
|
||||||
|
stack trace.
|
||||||
* New method `.WebSocketHandler.set_nodelay` can be used to set the
|
* New method `.WebSocketHandler.set_nodelay` can be used to set the
|
||||||
``TCP_NODELAY`` flag.
|
``TCP_NODELAY`` flag.
|
||||||
|
|
||||||
|
|
|
@ -48,6 +48,12 @@ except ImportError:
|
||||||
|
|
||||||
|
|
||||||
class StreamClosedError(IOError):
|
class StreamClosedError(IOError):
|
||||||
|
"""Exception raised by `IOStream` methods when the stream is closed.
|
||||||
|
|
||||||
|
Note that the close callback is scheduled to run *after* other
|
||||||
|
callbacks on the stream (to allow for buffered data to be processed),
|
||||||
|
so you may see this error before you see the close callback.
|
||||||
|
"""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue