1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
``tornado.websocket`` --- Bidirectional communication to the browser
====================================================================
.. testsetup::
import tornado
.. automodule:: tornado.websocket
.. autoclass:: WebSocketHandler
Event handlers
--------------
.. automethod:: WebSocketHandler.open
.. automethod:: WebSocketHandler.on_message
.. automethod:: WebSocketHandler.on_close
.. automethod:: WebSocketHandler.select_subprotocol
.. autoattribute:: WebSocketHandler.selected_subprotocol
.. automethod:: WebSocketHandler.on_ping
Output
------
.. automethod:: WebSocketHandler.write_message
.. automethod:: WebSocketHandler.close
Configuration
-------------
.. automethod:: WebSocketHandler.check_origin
.. automethod:: WebSocketHandler.get_compression_options
.. automethod:: WebSocketHandler.set_nodelay
Other
-----
.. automethod:: WebSocketHandler.ping
.. automethod:: WebSocketHandler.on_pong
.. autoexception:: WebSocketClosedError
Client-side support
-------------------
.. autofunction:: websocket_connect
.. autoclass:: WebSocketClientConnection
:members:
|