Halaman utama Jelajahi Bantuan
Masuk
yangck
/
celery
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki
Pohon: 4016b76e21
Ranting Tag
celery
/
reference
/
celery.worker.html

celery.worker.html 28 KB
Riwayat Mentahan

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml">
    5. 

  5.   <head>
    6. 

  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.     
    8. 

  8.     <title>Multiprocessing Worker - celery.worker &mdash; Celery v0.3.5 (unstable) documentation</title>
    9. 

  9.     <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.       URL_ROOT:    '../',
    14. 

  14.       VERSION:     '0.3.5 (unstable)',
    15. 

  15.       COLLAPSE_MODINDEX: false,
    16. 

  16.       FILE_SUFFIX: '.html',
    17. 

  17.       HAS_SOURCE:  true
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="../static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="../static/doctools.js"></script>
    22. 

  22.     <link rel="top" title="Celery v0.3.5 (unstable) documentation" href="../index.html" />
    23. 

  23.     <link rel="up" title="Module API Reference" href="index.html" />
    24. 

  24.     <link rel="next" title="Task Pool - celery.pool" href="celery.pool.html" />
    25. 

  25.     <link rel="prev" title="Task Discovery - celery.discovery" href="celery.discovery.html" /> 
    26. 

  26.   </head>
    27. 

  27.   <body>
    28. 

  28. 

  29.     <div class="header-wrapper">
    30. 

  30.       <div class="header">
    31. 

  31. 	<h1><a href="../index.html">Celery v0.3.5 (unstable) documentation</a></h1>
    32. 

  32. 	<div class="rel">
    33. 

  33.           <a href="../genindex.html" title="General Index"
    34. 

  34.              accesskey="I">index</a> |
    35. 

  35.           <a href="../modindex.html" title="Global Module Index"
    36. 

  36.              accesskey="M">modules</a> |
    37. 

  37.           <a href="celery.pool.html" title="Task Pool - celery.pool"
    38. 

  38.              accesskey="N">next</a> |
    39. 

  39.           <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
    40. 

  40.              accesskey="P">previous</a>
    41. 

  41. 	</div>
    42. 

  42.       </div>
    43. 

  43.     </div>
    44. 

  44. 

  45.     <div class="content-wrapper">
    46. 

  46.       <div class="content">
    47. 

  47. 	<div class="document">
    48. 

  48. 	  <div class="documentwrapper">
    49. 

  49. 	    <div class="bodywrapper">
    50. 

  50. 	      <div class="body">
    51. 

  51. 		
    52. 

  52.   <div class="section" id="module-celery.worker">
    53. 

  53. <h1>Multiprocessing Worker - celery.worker<a class="headerlink" href="#module-celery.worker" title="Permalink to this headline">¶</a></h1>
    54. 

  54. <p>celery.worker</p>
    55. 

  55. <dl class="exception">
    56. 

  56. <dt id="celery.worker.EmptyQueue">
    57. 

  57. <em class="property">
    58. 

  58. exception </em><tt class="descclassname">celery.worker.</tt><tt class="descname">EmptyQueue</tt><a class="headerlink" href="#celery.worker.EmptyQueue" title="Permalink to this definition">¶</a></dt>
    59. 

  59. <dd>The message queue is currently empty.</dd></dl>
    60. 

  60. 

  61. <dl class="class">
    62. 

  62. <dt id="celery.worker.PeriodicWorkController">
    63. 

  63. <em class="property">
    64. 

  64. class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">PeriodicWorkController</tt><big>(</big><em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>verbose=None</em><big>)</big><a class="headerlink" href="#celery.worker.PeriodicWorkController" title="Permalink to this definition">¶</a></dt>
    65. 

  65. <dd><p>A thread that continuously checks if there are
    66. 

  66. :class:<a href="#id1"><span class="problematic" id="id2">`</span></a>celery.task.PeriodicTask`s waiting for execution, and executes
    67. 

  67. them.</p>
    68. 

  68. <p>Example</p>
    69. 

  69. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">PeriodicWorkController</span><span class="p">()</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
    70. 

  70. </pre></div>
    71. 

  71. </div>
    72. 

  72. <dl class="method">
    73. 

  73. <dt id="celery.worker.PeriodicWorkController.run">
    74. 

  74. <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.PeriodicWorkController.run" title="Permalink to this definition">¶</a></dt>
    75. 

  75. <dd>Don&#8217;t use <a title="celery.worker.PeriodicWorkController.run" class="reference internal" href="#celery.worker.PeriodicWorkController.run"><tt class="xref docutils literal"><span class="pre">run()</span></tt></a>. use <tt class="xref docutils literal"><span class="pre">start()</span></tt>.</dd></dl>
    76. 

  76. 

  77. </dd></dl>
    78. 

  78. 

  79. <dl class="class">
    80. 

  80. <dt id="celery.worker.TaskWrapper">
    81. 

  81. <em class="property">
    82. 

  82. class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">TaskWrapper</tt><big>(</big><em>task_name</em>, <em>task_id</em>, <em>task_func</em>, <em>args</em>, <em>kwargs</em>, <em>**opts</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper" title="Permalink to this definition">¶</a></dt>
    83. 

  83. <dd><p>Class wrapping a task to be run.</p>
    84. 

  84. <table class="docutils field-list" frame="void" rules="none">
    85. 

  85. <col class="field-name" />
    86. 

  86. <col class="field-body" />
    87. 

  87. <tbody valign="top">
    88. 

  88. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    89. 

  89. <li><em>task_name</em> &#8211; see <a title="celery.worker.TaskWrapper.task_name" class="reference internal" href="#celery.worker.TaskWrapper.task_name"><tt class="xref docutils literal"><span class="pre">task_name</span></tt></a>.</li>
    90. 

  90. <li><em>task_id</em> &#8211; see <a title="celery.worker.TaskWrapper.task_id" class="reference internal" href="#celery.worker.TaskWrapper.task_id"><tt class="xref docutils literal"><span class="pre">task_id</span></tt></a>.</li>
    91. 

  91. <li><em>task_func</em> &#8211; see <a title="celery.worker.TaskWrapper.task_func" class="reference internal" href="#celery.worker.TaskWrapper.task_func"><tt class="xref docutils literal"><span class="pre">task_func</span></tt></a></li>
    92. 

  92. <li><em>args</em> &#8211; see <a title="celery.worker.TaskWrapper.args" class="reference internal" href="#celery.worker.TaskWrapper.args"><tt class="xref docutils literal"><span class="pre">args</span></tt></a></li>
    93. 

  93. <li><em>kwargs</em> &#8211; see <a title="celery.worker.TaskWrapper.kwargs" class="reference internal" href="#celery.worker.TaskWrapper.kwargs"><tt class="xref docutils literal"><span class="pre">kwargs</span></tt></a>.</li>
    94. 

  94. </ul>
    95. 

  95. </td>
    96. 

  96. </tr>
    97. 

  97. </tbody>
    98. 

  98. </table>
    99. 

  99. <dl class="attribute">
    100. 

  100. <dt id="celery.worker.TaskWrapper.task_name">
    101. 

  101. <tt class="descname">task_name</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_name" title="Permalink to this definition">¶</a></dt>
    102. 

  102. <dd>Kind of task. Must be a name registered in the task registry.</dd></dl>
    103. 

  103. 

  104. <dl class="attribute">
    105. 

  105. <dt id="celery.worker.TaskWrapper.task_id">
    106. 

  106. <tt class="descname">task_id</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_id" title="Permalink to this definition">¶</a></dt>
    107. 

  107. <dd>UUID of the task.</dd></dl>
    108. 

  108. 

  109. <dl class="attribute">
    110. 

  110. <dt id="celery.worker.TaskWrapper.task_func">
    111. 

  111. <tt class="descname">task_func</tt><a class="headerlink" href="#celery.worker.TaskWrapper.task_func" title="Permalink to this definition">¶</a></dt>
    112. 

  112. <dd>The tasks callable object.</dd></dl>
    113. 

  113. 

  114. <dl class="attribute">
    115. 

  115. <dt id="celery.worker.TaskWrapper.args">
    116. 

  116. <tt class="descname">args</tt><a class="headerlink" href="#celery.worker.TaskWrapper.args" title="Permalink to this definition">¶</a></dt>
    117. 

  117. <dd>List of positional arguments to apply to the task.</dd></dl>
    118. 

  118. 

  119. <dl class="attribute">
    120. 

  120. <dt id="celery.worker.TaskWrapper.kwargs">
    121. 

  121. <tt class="descname">kwargs</tt><a class="headerlink" href="#celery.worker.TaskWrapper.kwargs" title="Permalink to this definition">¶</a></dt>
    122. 

  122. <dd>Mapping of keyword arguments to apply to the task.</dd></dl>
    123. 

  123. 

  124. <dl class="method">
    125. 

  125. <dt id="celery.worker.TaskWrapper.execute">
    126. 

  126. <tt class="descname">execute</tt><big>(</big><em>loglevel=None</em>, <em>logfile=None</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.execute" title="Permalink to this definition">¶</a></dt>
    127. 

  127. <dd><p>Execute the task in a <a title="celery.worker.jail" class="reference internal" href="#celery.worker.jail"><tt class="xref docutils literal"><span class="pre">jail()</span></tt></a> and store return value
    128. 

  128. and status in the task meta backend.</p>
    129. 

  129. <table class="docutils field-list" frame="void" rules="none">
    130. 

  130. <col class="field-name" />
    131. 

  131. <col class="field-body" />
    132. 

  132. <tbody valign="top">
    133. 

  133. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    134. 

  134. <li><em>loglevel</em> &#8211; The loglevel used by the task.</li>
    135. 

  135. <li><em>logfile</em> &#8211; The logfile used by the task.</li>
    136. 

  136. </ul>
    137. 

  137. </td>
    138. 

  138. </tr>
    139. 

  139. </tbody>
    140. 

  140. </table>
    141. 

  141. </dd></dl>
    142. 

  142. 

  143. <dl class="method">
    144. 

  144. <dt id="celery.worker.TaskWrapper.execute_using_pool">
    145. 

  145. <tt class="descname">execute_using_pool</tt><big>(</big><em>pool</em>, <em>loglevel=None</em>, <em>logfile=None</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.execute_using_pool" title="Permalink to this definition">¶</a></dt>
    146. 

  146. <dd><p>Like <a title="celery.worker.TaskWrapper.execute" class="reference internal" href="#celery.worker.TaskWrapper.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a>, but using the <tt class="xref docutils literal"><span class="pre">multiprocessing</span></tt> pool.</p>
    147. 

  147. <table class="docutils field-list" frame="void" rules="none">
    148. 

  148. <col class="field-name" />
    149. 

  149. <col class="field-body" />
    150. 

  150. <tbody valign="top">
    151. 

  151. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    152. 

  152. <li><em>pool</em> &#8211; A <tt class="xref docutils literal"><span class="pre">multiprocessing.Pool</span></tt> instance.</li>
    153. 

  153. <li><em>loglevel</em> &#8211; The loglevel used by the task.</li>
    154. 

  154. <li><em>logfile</em> &#8211; The logfile used by the task.</li>
    155. 

  155. </ul>
    156. 

  156. </td>
    157. 

  157. </tr>
    158. 

  158. </tbody>
    159. 

  159. </table>
    160. 

  160. <p>:returns <tt class="xref docutils literal"><span class="pre">multiprocessing.AsyncResult</span></tt> instance.</p>
    161. 

  161. </dd></dl>
    162. 

  162. 

  163. <dl class="method">
    164. 

  164. <dt id="celery.worker.TaskWrapper.extend_with_default_kwargs">
    165. 

  165. <tt class="descname">extend_with_default_kwargs</tt><big>(</big><em>loglevel</em>, <em>logfile</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.extend_with_default_kwargs" title="Permalink to this definition">¶</a></dt>
    166. 

  166. <dd><p>Extend the tasks keyword arguments with standard task arguments.</p>
    167. 

  167. <p>These are <tt class="docutils literal"><span class="pre">logfile</span></tt>, <tt class="docutils literal"><span class="pre">loglevel</span></tt>, <tt class="docutils literal"><span class="pre">task_id</span></tt> and <tt class="docutils literal"><span class="pre">task_name</span></tt>.</p>
    168. 

  168. </dd></dl>
    169. 

  169. 

  170. <dl class="classmethod">
    171. 

  171. <dt id="celery.worker.TaskWrapper.from_message">
    172. 

  172. <em class="property">
    173. 

  173. classmethod </em><tt class="descname">from_message</tt><big>(</big><em>message</em>, <em>logger</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.from_message" title="Permalink to this definition">¶</a></dt>
    174. 

  174. <dd><p>Create a <a title="celery.worker.TaskWrapper" class="reference internal" href="#celery.worker.TaskWrapper"><tt class="xref docutils literal"><span class="pre">TaskWrapper</span></tt></a> from a task message sent by
    175. 

  175. <a title="celery.messaging.TaskPublisher" class="reference external" href="celery.messaging.html#celery.messaging.TaskPublisher"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskPublisher</span></tt></a>.</p>
    176. 

  176. <table class="docutils field-list" frame="void" rules="none">
    177. 

  177. <col class="field-name" />
    178. 

  178. <col class="field-body" />
    179. 

  179. <tbody valign="top">
    180. 

  180. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.worker.UnknownTask" class="reference internal" href="#celery.worker.UnknownTask">UnknownTask</a>:</th></tr>
    181. 

  181. <tr><td>&nbsp;</td><td class="field-body">if the message does not describe a task,
    182. 

  182. the message is also rejected.</td>
    183. 

  183. </tr>
    184. 

  184. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a title="celery.worker.TaskWrapper" class="reference internal" href="#celery.worker.TaskWrapper"><tt class="xref docutils literal"><span class="pre">TaskWrapper</span></tt></a> instance.</td>
    185. 

  185. </tr>
    186. 

  186. </tbody>
    187. 

  187. </table>
    188. 

  188. </dd></dl>
    189. 

  189. 

  190. <dl class="method">
    191. 

  191. <dt id="celery.worker.TaskWrapper.on_failure">
    192. 

  192. <tt class="descname">on_failure</tt><big>(</big><em>exc_info</em>, <em>meta</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.on_failure" title="Permalink to this definition">¶</a></dt>
    193. 

  193. <dd>The handler used if the task raised an exception.</dd></dl>
    194. 

  194. 

  195. <dl class="method">
    196. 

  196. <dt id="celery.worker.TaskWrapper.on_success">
    197. 

  197. <tt class="descname">on_success</tt><big>(</big><em>ret_value</em>, <em>meta</em><big>)</big><a class="headerlink" href="#celery.worker.TaskWrapper.on_success" title="Permalink to this definition">¶</a></dt>
    198. 

  198. <dd>The handler used if the task was successfully processed (
    199. 

  199. without raising an exception).</dd></dl>
    200. 

  200. 

  201. </dd></dl>
    202. 

  202. 

  203. <dl class="exception">
    204. 

  204. <dt id="celery.worker.UnknownTask">
    205. 

  205. <em class="property">
    206. 

  206. exception </em><tt class="descclassname">celery.worker.</tt><tt class="descname">UnknownTask</tt><a class="headerlink" href="#celery.worker.UnknownTask" title="Permalink to this definition">¶</a></dt>
    207. 

  207. <dd>Got an unknown task in the queue. The message is requeued and
    208. 

  208. ignored.</dd></dl>
    209. 

  209. 

  210. <dl class="class">
    211. 

  211. <dt id="celery.worker.WorkController">
    212. 

  212. <em class="property">
    213. 

  213. class </em><tt class="descclassname">celery.worker.</tt><tt class="descname">WorkController</tt><big>(</big><em>concurrency=None</em>, <em>logfile=None</em>, <em>loglevel=None</em>, <em>queue_wakeup_after=None</em>, <em>is_detached=False</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController" title="Permalink to this definition">¶</a></dt>
    214. 

  214. <dd><p>Executes tasks waiting in the task queue.</p>
    215. 

  215. <table class="docutils field-list" frame="void" rules="none">
    216. 

  216. <col class="field-name" />
    217. 

  217. <col class="field-body" />
    218. 

  218. <tbody valign="top">
    219. 

  219. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    220. 

  220. <li><em>concurrency</em> &#8211; see <a title="celery.worker.WorkController.concurrency" class="reference internal" href="#celery.worker.WorkController.concurrency"><tt class="xref docutils literal"><span class="pre">concurrency</span></tt></a>.</li>
    221. 

  221. <li><em>logfile</em> &#8211; see <a title="celery.worker.WorkController.logfile" class="reference internal" href="#celery.worker.WorkController.logfile"><tt class="xref docutils literal"><span class="pre">logfile</span></tt></a>.</li>
    222. 

  222. <li><em>loglevel</em> &#8211; see <a title="celery.worker.WorkController.loglevel" class="reference internal" href="#celery.worker.WorkController.loglevel"><tt class="xref docutils literal"><span class="pre">loglevel</span></tt></a>.</li>
    223. 

  223. <li><em>queue_wakeup_after</em> &#8211; see <a title="celery.worker.WorkController.queue_wakeup_after" class="reference internal" href="#celery.worker.WorkController.queue_wakeup_after"><tt class="xref docutils literal"><span class="pre">queue_wakeup_after</span></tt></a>.</li>
    224. 

  224. </ul>
    225. 

  225. </td>
    226. 

  226. </tr>
    227. 

  227. </tbody>
    228. 

  228. </table>
    229. 

  229. <dl class="attribute">
    230. 

  230. <dt id="celery.worker.WorkController.concurrency">
    231. 

  231. <tt class="descname">concurrency</tt><a class="headerlink" href="#celery.worker.WorkController.concurrency" title="Permalink to this definition">¶</a></dt>
    232. 

  232. <dd>The number of simultaneous processes doing work (default:
    233. 

  233. <a title="celery.conf.DAEMON_CONCURRENCY" class="reference external" href="celery.conf.html#celery.conf.DAEMON_CONCURRENCY"><tt class="xref docutils literal"><span class="pre">celery.conf.DAEMON_CONCURRENCY</span></tt></a>)</dd></dl>
    234. 

  234. 

  235. <dl class="attribute">
    236. 

  236. <dt id="celery.worker.WorkController.loglevel">
    237. 

  237. <tt class="descname">loglevel</tt><a class="headerlink" href="#celery.worker.WorkController.loglevel" title="Permalink to this definition">¶</a></dt>
    238. 

  238. <dd>The loglevel used (default: <tt class="xref docutils literal"><span class="pre">logging.INFO</span></tt>)</dd></dl>
    239. 

  239. 

  240. <dl class="attribute">
    241. 

  241. <dt id="celery.worker.WorkController.logfile">
    242. 

  242. <tt class="descname">logfile</tt><a class="headerlink" href="#celery.worker.WorkController.logfile" title="Permalink to this definition">¶</a></dt>
    243. 

  243. <dd>The logfile used, if no logfile is specified it uses <tt class="docutils literal"><span class="pre">stderr</span></tt>
    244. 

  244. (default: <a title="celery.conf.DAEMON_LOG_FILE" class="reference external" href="celery.conf.html#celery.conf.DAEMON_LOG_FILE"><tt class="xref docutils literal"><span class="pre">celery.conf.DAEMON_LOG_FILE</span></tt></a>).</dd></dl>
    245. 

  245. 

  246. <dl class="attribute">
    247. 

  247. <dt id="celery.worker.WorkController.queue_wakeup_after">
    248. 

  248. <tt class="descname">queue_wakeup_after</tt><a class="headerlink" href="#celery.worker.WorkController.queue_wakeup_after" title="Permalink to this definition">¶</a></dt>
    249. 

  249. <dd>The time it takes for the daemon to wake up after the queue is empty,
    250. 

  250. so it can check for more work
    251. 

  251. (default: <a title="celery.conf.QUEUE_WAKEUP_AFTER" class="reference external" href="celery.conf.html#celery.conf.QUEUE_WAKEUP_AFTER"><tt class="xref docutils literal"><span class="pre">celery.conf.QUEUE_WAKEUP_AFTER</span></tt></a>).</dd></dl>
    252. 

  252. 

  253. <dl class="attribute">
    254. 

  254. <dt id="celery.worker.WorkController.empty_msg_emit_every">
    255. 

  255. <tt class="descname">empty_msg_emit_every</tt><a class="headerlink" href="#celery.worker.WorkController.empty_msg_emit_every" title="Permalink to this definition">¶</a></dt>
    256. 

  256. <dd>How often the daemon emits the <tt class="docutils literal"><span class="pre">&quot;Waiting</span> <span class="pre">for</span> <span class="pre">queue...&quot;</span></tt> message.
    257. 

  257. If this is <tt class="xref docutils literal"><span class="pre">None</span></tt>, the message will never be logged.
    258. 

  258. (default: <a title="celery.conf.EMPTY_MSG_EMIT_EVERY" class="reference external" href="celery.conf.html#celery.conf.EMPTY_MSG_EMIT_EVERY"><tt class="xref docutils literal"><span class="pre">celery.conf.EMPTY_MSG_EMIT_EVERY</span></tt></a>)</dd></dl>
    259. 

  259. 

  260. <dl class="attribute">
    261. 

  261. <dt id="celery.worker.WorkController.logger">
    262. 

  262. <tt class="descname">logger</tt><a class="headerlink" href="#celery.worker.WorkController.logger" title="Permalink to this definition">¶</a></dt>
    263. 

  263. <dd>The <tt class="xref docutils literal"><span class="pre">logging.Logger</span></tt> instance used for logging.</dd></dl>
    264. 

  264. 

  265. <dl class="attribute">
    266. 

  266. <dt id="celery.worker.WorkController.pool">
    267. 

  267. <tt class="descname">pool</tt><a class="headerlink" href="#celery.worker.WorkController.pool" title="Permalink to this definition">¶</a></dt>
    268. 

  268. <dd>The <tt class="xref docutils literal"><span class="pre">multiprocessing.Pool</span></tt> instance used.</dd></dl>
    269. 

  269. 

  270. <dl class="attribute">
    271. 

  271. <dt id="celery.worker.WorkController.task_consumer">
    272. 

  272. <tt class="descname">task_consumer</tt><a class="headerlink" href="#celery.worker.WorkController.task_consumer" title="Permalink to this definition">¶</a></dt>
    273. 

  273. <dd>The <a title="celery.messaging.TaskConsumer" class="reference external" href="celery.messaging.html#celery.messaging.TaskConsumer"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskConsumer</span></tt></a> instance used.</dd></dl>
    274. 

  274. 

  275. <dl class="method">
    276. 

  276. <dt id="celery.worker.WorkController.connection_diagnostics">
    277. 

  277. <tt class="descname">connection_diagnostics</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.connection_diagnostics" title="Permalink to this definition">¶</a></dt>
    278. 

  278. <dd>Diagnose the AMQP connection, and reset connection if
    279. 

  279. necessary.</dd></dl>
    280. 

  280. 

  281. <dl class="method">
    282. 

  282. <dt id="celery.worker.WorkController.execute_next_task">
    283. 

  283. <tt class="descname">execute_next_task</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.execute_next_task" title="Permalink to this definition">¶</a></dt>
    284. 

  284. <dd><p>Execute the next task on the queue using the multiprocessing pool.</p>
    285. 

  285. <p>Catches all exceptions and logs them with level
    286. 

  286. <tt class="xref docutils literal"><span class="pre">logging.CRITICAL</span></tt>.</p>
    287. 

  287. <p>Raises <a title="celery.worker.EmptyQueue" class="reference internal" href="#celery.worker.EmptyQueue"><tt class="xref docutils literal"><span class="pre">EmptyQueue</span></tt></a> exception if there is no message
    288. 

  288. waiting on the queue.</p>
    289. 

  289. </dd></dl>
    290. 

  290. 

  291. <dl class="method">
    292. 

  292. <dt id="celery.worker.WorkController.process_task">
    293. 

  293. <tt class="descname">process_task</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#celery.worker.WorkController.process_task" title="Permalink to this definition">¶</a></dt>
    294. 

  294. <dd>Process task message by passing it to the pool of workers.</dd></dl>
    295. 

  295. 

  296. <dl class="method">
    297. 

  297. <dt id="celery.worker.WorkController.receive_message">
    298. 

  298. <tt class="descname">receive_message</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.receive_message" title="Permalink to this definition">¶</a></dt>
    299. 

  299. <dd><p>Receive the next message from the message broker.</p>
    300. 

  300. <p>Tries to reset the AMQP connection if not available.
    301. 

  301. Returns <tt class="xref docutils literal"><span class="pre">None</span></tt> if no message is waiting on the queue.</p>
    302. 

  302. <table class="docutils field-list" frame="void" rules="none">
    303. 

  303. <col class="field-name" />
    304. 

  304. <col class="field-body" />
    305. 

  305. <tbody valign="top">
    306. 

  306. <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref docutils literal"><span class="pre">carrot.messaging.Message</span></tt> instance.</td>
    307. 

  307. </tr>
    308. 

  308. </tbody>
    309. 

  309. </table>
    310. 

  310. </dd></dl>
    311. 

  311. 

  312. <dl class="method">
    313. 

  313. <dt id="celery.worker.WorkController.reset_connection">
    314. 

  314. <tt class="descname">reset_connection</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.reset_connection" title="Permalink to this definition">¶</a></dt>
    315. 

  315. <dd><p>Reset the AMQP connection, and reinitialize the
    316. 

  316. <a title="celery.messaging.TaskConsumer" class="reference external" href="celery.messaging.html#celery.messaging.TaskConsumer"><tt class="xref docutils literal"><span class="pre">celery.messaging.TaskConsumer</span></tt></a> instance.</p>
    317. 

  317. <p>Resets the task consumer in <a title="celery.worker.WorkController.task_consumer" class="reference internal" href="#celery.worker.WorkController.task_consumer"><tt class="xref docutils literal"><span class="pre">task_consumer</span></tt></a>.</p>
    318. 

  318. </dd></dl>
    319. 

  319. 

  320. <dl class="method">
    321. 

  321. <dt id="celery.worker.WorkController.run">
    322. 

  322. <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.run" title="Permalink to this definition">¶</a></dt>
    323. 

  323. <dd>Starts the workers main loop.</dd></dl>
    324. 

  324. 

  325. <dl class="method">
    326. 

  326. <dt id="celery.worker.WorkController.schedule_retry_tasks">
    327. 

  327. <tt class="descname">schedule_retry_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.worker.WorkController.schedule_retry_tasks" title="Permalink to this definition">¶</a></dt>
    328. 

  328. <dd>Reschedule all requeued tasks waiting for retry.</dd></dl>
    329. 

  329. 

  330. </dd></dl>
    331. 

  331. 

  332. <dl class="function">
    333. 

  333. <dt id="celery.worker.jail">
    334. 

  334. <tt class="descclassname">celery.worker.</tt><tt class="descname">jail</tt><big>(</big><em>task_id</em>, <em>func</em>, <em>args</em>, <em>kwargs</em><big>)</big><a class="headerlink" href="#celery.worker.jail" title="Permalink to this definition">¶</a></dt>
    335. 

  335. <dd><p>Wraps the task in a jail, which catches all exceptions, and
    336. 

  336. saves the status and result of the task execution to the task
    337. 

  337. meta backend.</p>
    338. 

  338. <p>If the call was successful, it saves the result to the task result
    339. 

  339. backend, and sets the task status to <tt class="docutils literal"><span class="pre">&quot;DONE&quot;</span></tt>.</p>
    340. 

  340. <p>If the call results in an exception, it saves the exception as the task
    341. 

  341. result, and sets the task status to <tt class="docutils literal"><span class="pre">&quot;FAILURE&quot;</span></tt>.</p>
    342. 

  342. <table class="docutils field-list" frame="void" rules="none">
    343. 

  343. <col class="field-name" />
    344. 

  344. <col class="field-body" />
    345. 

  345. <tbody valign="top">
    346. 

  346. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    347. 

  347. <li><em>task_id</em> &#8211; The id of the task.</li>
    348. 

  348. <li><em>func</em> &#8211; Callable object to execute.</li>
    349. 

  349. <li><em>args</em> &#8211; List of positional args to pass on to the function.</li>
    350. 

  350. <li><em>kwargs</em> &#8211; Keyword arguments mapping to pass on to the function.</li>
    351. 

  351. </ul>
    352. 

  352. </td>
    353. 

  353. </tr>
    354. 

  354. <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the function return value on success, or
    355. 

  355. the exception instance on failure.</p>
    356. 

  356. </td>
    357. 

  357. </tr>
    358. 

  358. </tbody>
    359. 

  359. </table>
    360. 

  360. </dd></dl>
    361. 

  361. 

  362. </div>
    363. 

  363. 

  364. 

  365. 	      </div>
    366. 

  366. 	    </div>
    367. 

  367. 	  </div>
    368. 

  368. 	</div>
    369. 

  369. 	<div class="sidebar">
    370. 

  370. 	  <h3>Contents</h3>
    371. 

  371. 	  <ul class="current">
    372. 

  372. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
    373. 

  373. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
    374. 

  374. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
    375. 

  375. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
    379. 

  379. <li class="toctree-l2 current"><a class="current reference external" href="">Multiprocessing Worker - celery.worker</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference external" href="celery.pool.html">Task Pool - celery.pool</a></li>
    381. 

  381. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
    384. 

  384. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
    385. 

  385. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
    386. 

  386. <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
    387. 

  387. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
    388. 

  388. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
    389. 

  389. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
    390. 

  390. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
    391. 

  391. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
    392. 

  392. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
    393. 

  393. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
    394. 

  394. </ul>
    395. 

  395. </li>
    396. 

  396. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
    397. 

  397. </ul>
    398. 

  398. 

  399. 	  <h3 style="margin-top: 1.5em;">Search</h3>
    400. 

  400. 	  <form class="search" action="../search.html" method="get">
    401. 

  401.             <input type="text" name="q" size="18" />
    402. 

  402.             <input type="submit" value="Go" />
    403. 

  403.             <input type="hidden" name="check_keywords" value="yes" />
    404. 

  404.             <input type="hidden" name="area" value="default" />
    405. 

  405.           </form>
    406. 

  406.           <p class="searchtip" style="font-size: 90%">
    407. 

  407.             Enter search terms or a module, class or function name.
    408. 

  408.           </p>
    409. 

  409. 	</div>
    410. 

  410. 	<div class="clearer"></div>
    411. 

  411.       </div>
    412. 

  412.     </div>
    413. 

  413. 

  414.     <div class="footer-wrapper">
    415. 

  415.       <div class="footer">
    416. 

  416. 	<div class="left">
    417. 

  417.           <a href="../genindex.html" title="General Index"
    418. 

  418.              >index</a> |
    419. 

  419.           <a href="../modindex.html" title="Global Module Index"
    420. 

  420.              >modules</a> |
    421. 

  421.           <a href="celery.pool.html" title="Task Pool - celery.pool"
    422. 

  422.              >next</a> |
    423. 

  423.           <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
    424. 

  424.              >previous</a>
    425. 

  425.             <br/>
    426. 

  426.             <a href="../sources/reference/celery.worker.txt"
    427. 

  427.                rel="nofollow">Show Source</a>
    428. 

  428. 	</div>
    429. 

  429. 

  430. 	<div class="right">
    431. 

  431. 	  &copy; Copyright 2009, Ask Solem.<br/>
    432. 

  432. 	  Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
    433. 

  433. 	</div>
    434. 

  434. 	<div class="clearer"></div>
    435. 

  435.       </div>
    436. 

  436.     </div>
    437. 

  437. 

  438.   </body>
    439. 

  439. </html>
    440.