Rooba
/
tornado
mirror of https://github.com/tornadoweb/tornado.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tornado/docs/gen.rst

53 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Add tornado.gen module for simpler generator-based async code.
2011-09-04 07:59:57 +00:00
``tornado.gen`` --- Simplify asynchronous code
==============================================
.. automodule:: tornado.gen
Add new methods to docs, found by sphinx coverage extension.
2013-03-15 03:07:58 +00:00
Decorators
----------
.. autofunction:: coroutine
Add tornado.gen module for simpler generator-based async code.
2011-09-04 07:59:57 +00:00
.. autofunction:: engine
Update gen docs: deemphasize Task, Callback, and Wait.
2014-07-13 22:19:29 +00:00
Utility functions
-----------------
Add tornado.gen module for simpler generator-based async code.
2011-09-04 07:59:57 +00:00
Update gen docs: deemphasize Task, Callback, and Wait.
2014-07-13 22:19:29 +00:00
.. autoexception:: Return
Rewrite gen docs to make coroutine the primary decorator.
2013-03-16 04:18:46 +00:00
Document all the new HTTP stuff
2014-04-27 03:56:16 +00:00
.. autofunction:: with_timeout
.. autoexception:: TimeoutError
.. autofunction:: maybe_future
Add gen.moment, a yieldable object that resumes after one IOLoop iteration. Use this between requests in HTTP1ServerConnection to keep one connection from monopolizing the IOLoop when there are pipelined (or just fast) requests available. This was causing increased variance in benchmarks using "ab -k" (it also increased throughput, for reasons that are not yet clear, so this change reduces observed speed in these benchmarks).
2014-05-11 22:49:40 +00:00
.. autodata:: moment
:annotation:
Update gen docs: deemphasize Task, Callback, and Wait.
2014-07-13 22:19:29 +00:00
.. autofunction:: Task
Rewrite gen docs to make coroutine the primary decorator.
2013-03-16 04:18:46 +00:00
A couple of small 2.6-isms. We can use namedtuple and the new 0o octal literal notation.
2013-01-27 21:28:35 +00:00
.. class:: Arguments
Update gen docs: deemphasize Task, Callback, and Wait.
2014-07-13 22:19:29 +00:00
The result of a `Task` or `Wait` whose callback had more than one
A couple of small 2.6-isms. We can use namedtuple and the new 0o octal literal notation.
2013-01-27 21:28:35 +00:00
argument (or keyword arguments).
Rewrite gen docs to make coroutine the primary decorator.
2013-03-16 04:18:46 +00:00
The `Arguments` object is a `collections.namedtuple` and can be
used either as a tuple ``(args, kwargs)`` or an object with attributes
``args`` and ``kwargs``.
Update gen docs: deemphasize Task, Callback, and Wait.
2014-07-13 22:19:29 +00:00
Legacy interface
----------------
Before support for `Futures <.Future>` was introduced in Tornado 3.0,
coroutines used subclasses of `YieldPoint` in their ``yield`` expressions.
These classes are still supported but should generally not be used
except for compatibility with older interfaces.
.. autoclass:: YieldPoint
:members:
.. autoclass:: Callback
.. autoclass:: Wait
.. autoclass:: WaitAll