openstack/futurist
Code Issues Proposed changes

Add periodics to doc features section

Browse Source 
Change-Id: Iadba1ab894f86afb19163814bb7b30360934751a
This commit is contained in:
Joshua Harlow 2015-06-25 20:53:13 -07:00
parent 2f0b79b864
commit 2ea7dba035
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/features.rst
View File

@ -2,6 +2,9 @@
Features
========
Async
-----
* A :py:class:`.futurist.GreenThreadPoolExecutor` using `eventlet`_ green thread
pools. It provides a standard `executor`_ API/interface and it also gathers
execution statistics. It returns instances of
@ -16,5 +19,16 @@ Features
execution statistics. It returns instances
of :py:class:`.futurist.Future` objects.
Periodics
---------
* A :py:class:`.futurist.periodics.PeriodicWorker` that can use the previously
mentioned executors to run asynchronous work periodically in parallel
or synchronously. It does this by executing arbitary functions/methods
that have been decorated with the :py:func:`.futurist.periodics.periodic`
decorator according to a internally maintained schedule (which itself is
based on the `heap`_ algorithm).
.. _heap: https://en.wikipedia.org/wiki/Heap_%28data_structure%29
.. _eventlet: http://eventlet.net/
.. _executor: https://docs.python.org/dev/library/concurrent.futures.html#executor-objects