tornado.gen.YieldPoint Class Reference

Inheritance diagram for tornado.gen.YieldPoint:

List of all members.

Public Member Functions
def	get_result
def	is_ready
def	start

---

Detailed Description

Base class for objects that may be yielded from the generator.

.. deprecated:: 4.0
   Use `Futures <.Future>` instead.

Definition at line 230 of file gen.py.

---

Member Function Documentation

def tornado.gen.YieldPoint.get_result

(

self

)

Returns the value to use as the result of the yield expression.

This method will only be called once, and only after `is_ready`
has returned true.

Reimplemented in tornado.gen.Multi, tornado.gen.YieldFuture, tornado.gen.WaitAll, tornado.gen.Wait, and tornado.gen.Callback.

Definition at line 250 of file gen.py.

def tornado.gen.YieldPoint.is_ready

(

self

)

Called by the runner to determine whether to resume the generator.

Returns a boolean; may be called more than once.

Reimplemented in tornado.gen.Multi, tornado.gen.YieldFuture, tornado.gen.WaitAll, tornado.gen.Wait, and tornado.gen.Callback.

Definition at line 243 of file gen.py.

def tornado.gen.YieldPoint.start	(		self,
			runner
	)

Called by the runner after the generator has yielded.

No other methods will be called on this object before ``start``.

Reimplemented in tornado.gen.Multi, tornado.gen.YieldFuture, tornado.gen.WaitAll, tornado.gen.Wait, and tornado.gen.Callback.

Definition at line 236 of file gen.py.

---

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

• gen.py