Add docs related to the new conductor feature

Change-Id: I68722a5b6bea0e404427ec7b121e7c6f90e42145
This commit is contained in:
Joshua Harlow 2014-05-29 15:37:04 -07:00
parent c386a5f9d4
commit e34c0c9f06
3 changed files with 64 additions and 3 deletions

44
doc/source/conductors.rst Normal file
View File

@ -0,0 +1,44 @@
----------
Conductors
----------
Overview
========
Conductors in TaskFlow provide a mechanism that unifies the various TaskFlow
concepts under a single easy to use (as plug-and-play as we can make it)
construct.
They are responsible for the following:
* Interacting with :doc:`jobboards <jobs>` (examining and claiming
:doc:`jobs <jobs>`).
* Creating :doc:`engines <engines>` from the claimed jobs (using
:ref:`factories <resumption factories>` to reconstruct the contained
tasks and flows to be executed).
* Dispatching the engine using the provided :doc:`persistence <persistence>`
layer and engine configuration.
* Completing or abandoning the claimed job (depending on dispatching and
execution outcome).
* *Rinse and repeat*.
.. note::
They are inspired by and have similar responsiblities
as `railroad conductors`_.
Interfaces
==========
.. automodule:: taskflow.conductors.base
.. automodule:: taskflow.conductors.single_threaded
Hierarchy
=========
.. inheritance-diagram::
taskflow.conductors.base
taskflow.conductors.single_threaded
:parts: 1
.. _railroad conductors: http://en.wikipedia.org/wiki/Conductor_%28transportation%29

View File

@ -11,19 +11,34 @@ easy, consistent, and reliable.*
Contents Contents
======== ========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
atoms atoms
arguments_and_results arguments_and_results
inputs_and_outputs
patterns patterns
engines engines
workers
jobs
inputs_and_outputs
notifications notifications
persistence persistence
resumption resumption
jobs
conductors
.. toctree::
:hidden:
workers
Miscellaneous
-------------
.. toctree::
:maxdepth: 2
exceptions exceptions
utils utils
states states

View File

@ -19,6 +19,8 @@ in order to revert those atoms or resume those atoms in the correct ordering.
Taskflow provides a pattern that can help in automating this process (it does Taskflow provides a pattern that can help in automating this process (it does
**not** prohibit the user from creating their own strategies for doing this). **not** prohibit the user from creating their own strategies for doing this).
.. _resumption factories:
Factories Factories
========= =========