Rooba
/
tornado
mirror of https://github.com/tornadoweb/tornado.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tornado/docs/websocket.rst

49 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Add titles to table of contents
2011-06-11 21:48:46 +00:00
``tornado.websocket`` --- Bidirectional communication to the browser
====================================================================
Skeletal autogenerated reference documentation
2011-06-09 06:58:58 +00:00
Make many doc code blocks into sphinx doctests.
2015-02-09 05:19:47 +00:00
.. testsetup::
import tornado.websocket
Skeletal autogenerated reference documentation
2011-06-09 06:58:58 +00:00
.. automodule:: tornado.websocket
Update docs for recent websocket changes
2012-01-08 08:01:18 +00:00
.. autoclass:: WebSocketHandler
Doc updates
2012-01-23 01:52:43 +00:00
Event handlers
--------------
.. automethod:: WebSocketHandler.open
.. automethod:: WebSocketHandler.on_message
.. automethod:: WebSocketHandler.on_close
.. automethod:: WebSocketHandler.select_subprotocol
websocket: Improve subprotocol support - Add client-side subprotocol option - Add selected_subprotocol attribute to client and server objects - Call select_subprotocol exactly once instead of only on non-empty - Fix bug in previous select_subprotocol change when multiple subprotocols are offered - Add tests Updates #2281
2018-05-12 18:43:58 +00:00
.. autoattribute:: WebSocketHandler.selected_subprotocol
docs: Add uncovered function
2017-04-10 03:18:31 +00:00
.. automethod:: WebSocketHandler.on_ping
Doc updates
2012-01-23 01:52:43 +00:00
Output
------
.. automethod:: WebSocketHandler.write_message
.. automethod:: WebSocketHandler.close
Configuration
-------------
Release note updates.
2014-06-20 04:37:11 +00:00
.. automethod:: WebSocketHandler.check_origin
Start the next-release notes doc.
2014-08-07 02:48:20 +00:00
.. automethod:: WebSocketHandler.get_compression_options
Release note and doc updates
2013-05-12 22:08:23 +00:00
.. automethod:: WebSocketHandler.set_nodelay
Doc updates
2012-01-23 01:52:43 +00:00
Other
-----
Doc coverage updates
2012-09-29 23:57:04 +00:00
.. automethod:: WebSocketHandler.ping
.. automethod:: WebSocketHandler.on_pong
Update next-release notes.
2013-11-04 02:10:56 +00:00
.. autoexception:: WebSocketClosedError
Rename WebSocketConnect to websocket_connect. Add docs for undocumented functions and modules.
2013-03-15 03:45:48 +00:00
Client-side support
-------------------
.. autofunction:: websocket_connect
.. autoclass:: WebSocketClientConnection
:members: