.. include:: headings.inc

.. currentmodule:: lib.delayedresult

.. highlight:: python



.. _lib.delayedresult.Producer:

==========================================================================================================================================
|phoenix_title|  **Producer**
==========================================================================================================================================

Represent the worker thread that produces delayed results. 
It causes the given function to run in a separate thread, 
and a sender to be used to send the return value of the function.
As with any threading.Thread, instantiate and call start().
Note that if the workerFn raises AbortedException, the result is not 
sent and the thread terminates gracefully.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Producer**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.delayedresult.Producer_inheritance.png" alt="Inheritance diagram of Producer" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="http://docs.python.org/library/threading.html#threading._Verbose" title="threading._Verbose" alt="" coords="125,5,291,35"/> <area shape="rect" id="node5" href="http://docs.python.org/library/threading.html#threading.Thread" title="threading.Thread" alt="" coords="339,5,485,35"/> <area shape="rect" id="node4" href="lib.delayedresult.Producer.html" title="Represent the worker thread that produces delayed results." alt="" coords="535,5,724,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

`threading.Thread <http://docs.python.org/library/threading.html#threading.Thread>`_

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.delayedresult.Producer.__init__`                                     The sender will send the return value of
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Producer(threading.Thread)

   Represent the worker thread that produces delayed results. 
   It causes the given function to run in a separate thread, 
   and a sender to be used to send the return value of the function.
   As with any threading.Thread, instantiate and call start().
   Note that if the workerFn raises AbortedException, the result is not 
   sent and the thread terminates gracefully.

   .. method:: __init__(self, sender, workerFn, args=(), kwargs={}, name=None, group=None, daemon=False, sendReturn=True, senderArg=None)

      The sender will send the return value of 
      `workerFn(*args, **kwargs)` to the main thread. The name and group 
      are same as threading.Thread constructor parameters. Daemon causes 
      setDaemon() to be called. If sendReturn is False, then the return 
      value of workerFn() will not be sent. If senderArg is given, it 
      must be the name of the keyword arg to use to pass the sender into 
      the workerFn, so the function can send (typically many) results.