tornado.websocket.WebSocketProtocol13 Class Reference

Inheritance diagram for tornado.websocket.WebSocketProtocol13:

List of all members.

Public Member Functions
def	__init__
def	accept_connection
def	close
def	write_message
def	write_ping
Static Public Member Functions
def	compute_accept_value
Public Attributes
	client_terminated
	mask_outgoing
	server_terminated
Private Member Functions
def	_accept_connection
def	_challenge_response
def	_handle_message
def	_handle_websocket_headers
def	_on_frame_data
def	_on_frame_length_16
def	_on_frame_length_64
def	_on_frame_start
def	_on_masked_frame_data
def	_on_masking_key
def	_receive_frame
def	_write_frame
Private Attributes
	_final_frame
	_fragmented_message_buffer
	_fragmented_message_opcode
	_frame_length
	_frame_mask
	_frame_opcode
	_frame_opcode_is_control
	_masked_frame
	_waiting

---

Detailed Description

Implementation of the WebSocket protocol from RFC 6455.

This class supports versions 7 and 8 of the protocol in addition to the
final version 13.

Definition at line 386 of file websocket.py.

---

Constructor & Destructor Documentation

def tornado.websocket.WebSocketProtocol13.__init__	(		self,
			handler,
			mask_outgoing = False
	)

Definition at line 392 of file websocket.py.

---

Member Function Documentation

def tornado.websocket.WebSocketProtocol13._accept_connection

(

self

)

[private]

Definition at line 437 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._challenge_response

(

self

)

[private]

Definition at line 433 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._handle_message	(		self,
			opcode,
			data
	)		[private]

Definition at line 603 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._handle_websocket_headers

(

self

)

[private]

Verifies all invariant- and required headers

If a header is missing or have an incorrect value ValueError will be
raised

Definition at line 413 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_frame_data	(		self,
			data
	)		[private]

Definition at line 566 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_frame_length_16	(		self,
			data
	)		[private]

Definition at line 536 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_frame_length_64	(		self,
			data
	)		[private]

Definition at line 546 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_frame_start	(		self,
			data
	)		[private]

Definition at line 506 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_masked_frame_data	(		self,
			data
	)		[private]

Definition at line 563 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._on_masking_key	(		self,
			data
	)		[private]

Definition at line 556 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._receive_frame

(

self

)

[private]

Definition at line 500 of file websocket.py.

def tornado.websocket.WebSocketProtocol13._write_frame	(		self,
			fin,
			opcode,
			data
	)		[private]

Definition at line 459 of file websocket.py.

def tornado.websocket.WebSocketProtocol13.accept_connection

(

self

)

Definition at line 404 of file websocket.py.

def tornado.websocket.WebSocketProtocol13.close	(		self,
			code = None,
			reason = None
	)

Closes the WebSocket connection.

Definition at line 635 of file websocket.py.

def tornado.websocket.WebSocketProtocol13.compute_accept_value

(

key

)

[static]

Computes the value for the Sec-WebSocket-Accept header,
given the value for Sec-WebSocket-Key.

Definition at line 424 of file websocket.py.

def tornado.websocket.WebSocketProtocol13.write_message	(		self,
			message,
			binary = False
	)

Sends the given message to the client of this Web Socket.

Definition at line 482 of file websocket.py.

def tornado.websocket.WebSocketProtocol13.write_ping	(		self,
			data
	)

Send ping frame.

Definition at line 495 of file websocket.py.

---

Member Data Documentation

tornado::websocket.WebSocketProtocol13::_final_frame [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_fragmented_message_buffer [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_fragmented_message_opcode [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_frame_length [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_frame_mask [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_frame_opcode [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_frame_opcode_is_control [private]

Definition at line 506 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_masked_frame [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::_waiting [private]

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::client_terminated

Reimplemented from tornado.websocket.WebSocketProtocol.

Definition at line 603 of file websocket.py.

tornado::websocket.WebSocketProtocol13::mask_outgoing

Definition at line 392 of file websocket.py.

tornado::websocket.WebSocketProtocol13::server_terminated

Reimplemented from tornado.websocket.WebSocketProtocol.

Definition at line 635 of file websocket.py.

---

The documentation for this class was generated from the following file:

• websocket.py