tornado::websocket Namespace Reference

Classes
class	WebSocketClientConnection
class	WebSocketClosedError
class	WebSocketError
class	WebSocketHandler
class	WebSocketProtocol
class	WebSocketProtocol13
Functions
def	_wrap_method
def	websocket_connect
Variables
	xrange = range

---

Detailed Description

Implementation of the WebSocket protocol.

`WebSockets <http://dev.w3.org/html5/websockets/>`_ allow for bidirectional
communication between the browser and server.

WebSockets are supported in the current versions of all major browsers,
although older versions that do not support WebSockets are still in use
(refer to http://caniuse.com/websockets for details).

This module implements the final version of the WebSocket protocol as
defined in `RFC 6455 <http://tools.ietf.org/html/rfc6455>`_.  Certain
browser versions (notably Safari 5.x) implemented an earlier draft of
the protocol (known as "draft 76") and are not compatible with this module.

.. versionchanged:: 4.0
   Removed support for the draft 76 protocol version.

---

Function Documentation

def tornado.websocket._wrap_method

(

method

)

[private]

Definition at line 340 of file websocket.py.

def tornado.websocket.websocket_connect	(		url,
			io_loop = None,
			callback = None,
			connect_timeout = None
	)

Client-side websocket support.

Takes a url and returns a Future whose result is a
`WebSocketClientConnection`.

.. versionchanged:: 3.2
   Also accepts ``HTTPRequest`` objects in place of urls.

Definition at line 780 of file websocket.py.

---

Variable Documentation

tornado::websocket::xrange = range

Definition at line 48 of file websocket.py.