tornado.test.websocket_test.TestWebSocketHandler Class Reference

Inheritance diagram for tornado.test.websocket_test.TestWebSocketHandler:

List of all members.

Public Member Functions
def	initialize
def	on_close
Public Attributes
	close_future

---

Detailed Description

Base class for testing handlers that exposes the on_close event.

This allows for deterministic cleanup of the associated socket.

Definition at line 32 of file websocket_test.py.

---

Member Function Documentation

def tornado.test.websocket_test.TestWebSocketHandler.initialize	(		self,
			close_future
	)

Definition at line 37 of file websocket_test.py.

def tornado.test.websocket_test.TestWebSocketHandler.on_close

(

self

)

Invoked when the WebSocket is closed.

If the connection was closed cleanly and a status code or reason
phrase was supplied, these values will be available as the attributes
``self.close_code`` and ``self.close_reason``.

.. versionchanged:: 4.0

   Added ``close_code`` and ``close_reason`` attributes.

Reimplemented from tornado.websocket.WebSocketHandler.

Definition at line 40 of file websocket_test.py.

---

Member Data Documentation

tornado::test::websocket_test.TestWebSocketHandler::close_future

Definition at line 37 of file websocket_test.py.

---

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

• websocket_test.py