tornado.iostream.SSLIOStream Class Reference

Inheritance diagram for tornado.iostream.SSLIOStream:

List of all members.

Public Member Functions
def	__init__
def	reading
def	writing
Public Attributes
	socket
Private Member Functions
def	_do_ssl_handshake
def	_handle_connect
def	_handle_read
def	_handle_write
def	_read_from_socket
Private Attributes
	_handshake_reading
	_handshake_writing
	_ssl_accepting
	_ssl_options

---

Detailed Description

A utility class to write to and read from a non-blocking SSL socket.

If the socket passed to the constructor is already connected,
it should be wrapped with::

    ssl.wrap_socket(sock, do_handshake_on_connect=False, **kwargs)

before constructing the SSLIOStream.  Unconnected sockets will be
wrapped when IOStream.connect is finished.

Definition at line 607 of file iostream.py.

---

Constructor & Destructor Documentation

def tornado.iostream.SSLIOStream.__init__	(		self,
			args,
			kwargs
	)

Creates an SSLIOStream.

If a dictionary is provided as keyword argument ssl_options,
it will be used as additional keyword arguments to ssl.wrap_socket.

Definition at line 618 of file iostream.py.

---

Member Function Documentation

def tornado.iostream.SSLIOStream._do_ssl_handshake

(

self

)

[private]

Definition at line 636 of file iostream.py.

def tornado.iostream.SSLIOStream._handle_connect

(

self

)

[private]

Reimplemented from tornado.iostream.IOStream.

Definition at line 675 of file iostream.py.

def tornado.iostream.SSLIOStream._handle_read

(

self

)

[private]

Reimplemented from tornado.iostream.IOStream.

Definition at line 663 of file iostream.py.

def tornado.iostream.SSLIOStream._handle_write

(

self

)

[private]

Reimplemented from tornado.iostream.IOStream.

Definition at line 669 of file iostream.py.

def tornado.iostream.SSLIOStream._read_from_socket

(

self

)

[private]

Attempts to read from the socket.

Returns the data read or None if there is nothing to read.
May be overridden in subclasses.

Reimplemented from tornado.iostream.IOStream.

Definition at line 684 of file iostream.py.

def tornado.iostream.SSLIOStream.reading

(

self

)

Returns true if we are currently reading from the stream.

Reimplemented from tornado.iostream.IOStream.

Definition at line 630 of file iostream.py.

def tornado.iostream.SSLIOStream.writing

(

self

)

Returns true if we are currently writing to the stream.

Reimplemented from tornado.iostream.IOStream.

Definition at line 633 of file iostream.py.

---

Member Data Documentation

tornado::iostream.SSLIOStream::_handshake_reading [private]

Definition at line 622 of file iostream.py.

tornado::iostream.SSLIOStream::_handshake_writing [private]

Definition at line 622 of file iostream.py.

tornado::iostream.SSLIOStream::_ssl_accepting [private]

Definition at line 622 of file iostream.py.

tornado::iostream.SSLIOStream::_ssl_options [private]

Definition at line 622 of file iostream.py.

tornado::iostream.SSLIOStream::socket

Reimplemented from tornado.iostream.IOStream.

Definition at line 675 of file iostream.py.

---

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

• iostream.py