Public Member Functions
tornado.platform.interface.Waker Class Reference
Inheritance diagram for tornado.platform.interface.Waker:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def close
def consume
def fileno
def wake

Detailed Description

A socket-like object that can wake another thread from ``select()``.

The `~tornado.ioloop.IOLoop` will add the Waker's `fileno()` to
its ``select`` (or ``epoll`` or ``kqueue``) calls.  When another
thread wants to wake up the loop, it calls `wake`.  Once it has woken
up, it will call `consume` to do any necessary per-wake cleanup.  When
the ``IOLoop`` is closed, it closes its waker too.

Definition at line 32 of file interface.py.


Member Function Documentation

Closes the waker's file descriptor(s).

Reimplemented in tornado.platform.common.Waker, and tornado.platform.posix.Waker.

Definition at line 57 of file interface.py.

Called after the listen has woken up to do any necessary cleanup.

Reimplemented in tornado.platform.common.Waker, and tornado.platform.posix.Waker.

Definition at line 53 of file interface.py.

Returns a file descriptor for this waker.

Must be suitable for use with ``select()`` or equivalent on the
local platform.

Reimplemented in tornado.platform.common.Waker, and tornado.platform.posix.Waker.

Definition at line 41 of file interface.py.

Triggers activity on the waker's file descriptor.

Reimplemented in tornado.platform.common.Waker, and tornado.platform.posix.Waker.

Definition at line 49 of file interface.py.


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


roswww
Author(s): Jonathan Mace
autogenerated on Thu Jan 2 2014 11:53:30