celery.managers.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Django Model Managers - celery.managers &mdash; Celery v0.4.12 (stable) documentation</title>
  7. <link rel="stylesheet" href="../static/nature.css" type="text/css" />
  8. <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.4.12 (stable)',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../static/jquery.js"></script>
  19. <script type="text/javascript" src="../static/doctools.js"></script>
  20. <link rel="top" title="Celery v0.4.12 (stable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Django Models - celery.models" href="celery.models.html" />
  23. <link rel="prev" title="Django Views - celery.views" href="celery.views.html" />
  24. </head>
  25. <body>
  26. <div class="related">
  27. <h3>Navigation</h3>
  28. <ul>
  29. <li class="right" style="margin-right: 10px">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a></li>
  32. <li class="right" >
  33. <a href="../modindex.html" title="Global Module Index"
  34. accesskey="M">modules</a> |</li>
  35. <li class="right" >
  36. <a href="celery.models.html" title="Django Models - celery.models"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.views.html" title="Django Views - celery.views"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.4.12 (stable) documentation</a> &raquo;</li>
  42. <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li>
  43. </ul>
  44. </div>
  45. <div class="document">
  46. <div class="documentwrapper">
  47. <div class="bodywrapper">
  48. <div class="body">
  49. <div class="section" id="module-celery.managers">
  50. <h1>Django Model Managers - celery.managers<a class="headerlink" href="#module-celery.managers" title="Permalink to this headline">¶</a></h1>
  51. <p>celery.managers</p>
  52. <dl class="class">
  53. <dt id="celery.managers.PeriodicTaskManager">
  54. <em class="property">
  55. class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">PeriodicTaskManager</tt><a class="headerlink" href="#celery.managers.PeriodicTaskManager" title="Permalink to this definition">¶</a></dt>
  56. <dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTask</span></tt> models.</p>
  57. <dl class="method">
  58. <dt id="celery.managers.PeriodicTaskManager.get_waiting_tasks">
  59. <tt class="descname">get_waiting_tasks</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.PeriodicTaskManager.get_waiting_tasks" title="Permalink to this definition">¶</a></dt>
  60. <dd><p>Get all waiting periodic tasks.</p>
  61. <table class="docutils field-list" frame="void" rules="none">
  62. <col class="field-name" />
  63. <col class="field-body" />
  64. <tbody valign="top">
  65. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTaskMeta</span></tt> objects.</td>
  66. </tr>
  67. </tbody>
  68. </table>
  69. </dd></dl>
  70. <dl class="method">
  71. <dt id="celery.managers.PeriodicTaskManager.lock">
  72. <tt class="descname">lock</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.PeriodicTaskManager.lock" title="Permalink to this definition">¶</a></dt>
  73. <dd>Lock the periodic task table for reading.</dd></dl>
  74. <dl class="method">
  75. <dt id="celery.managers.PeriodicTaskManager.unlock">
  76. <tt class="descname">unlock</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.PeriodicTaskManager.unlock" title="Permalink to this definition">¶</a></dt>
  77. <dd>Unlock the periodic task table.</dd></dl>
  78. </dd></dl>
  79. <dl class="class">
  80. <dt id="celery.managers.TaskManager">
  81. <em class="property">
  82. class </em><tt class="descclassname">celery.managers.</tt><tt class="descname">TaskManager</tt><a class="headerlink" href="#celery.managers.TaskManager" title="Permalink to this definition">¶</a></dt>
  83. <dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.Task</span></tt> models.</p>
  84. <dl class="method">
  85. <dt id="celery.managers.TaskManager.delete_expired">
  86. <tt class="descname">delete_expired</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.delete_expired" title="Permalink to this definition">¶</a></dt>
  87. <dd>Delete all expired task results.</dd></dl>
  88. <dl class="method">
  89. <dt id="celery.managers.TaskManager.get_all_expired">
  90. <tt class="descname">get_all_expired</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.get_all_expired" title="Permalink to this definition">¶</a></dt>
  91. <dd>Get all expired task results.</dd></dl>
  92. <dl class="method">
  93. <dt id="celery.managers.TaskManager.get_task">
  94. <tt class="descname">get_task</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.get_task" title="Permalink to this definition">¶</a></dt>
  95. <dd>Get task meta for task by <tt class="docutils literal"><span class="pre">task_id</span></tt>.</dd></dl>
  96. <dl class="method">
  97. <dt id="celery.managers.TaskManager.is_done">
  98. <tt class="descname">is_done</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.is_done" title="Permalink to this definition">¶</a></dt>
  99. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was executed successfully.</dd></dl>
  100. <dl class="method">
  101. <dt id="celery.managers.TaskManager.store_result">
  102. <tt class="descname">store_result</tt><big>(</big><em>task_id</em>, <em>result</em>, <em>status</em><big>)</big><a class="headerlink" href="#celery.managers.TaskManager.store_result" title="Permalink to this definition">¶</a></dt>
  103. <dd><p>Store the result and status of a task.</p>
  104. <table class="docutils field-list" frame="void" rules="none">
  105. <col class="field-name" />
  106. <col class="field-body" />
  107. <tbody valign="top">
  108. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  109. <li><em>task_id</em> &#8211; task id</li>
  110. <li><em>result</em> &#8211; The return value of the task, or an exception
  111. instance raised by the task.</li>
  112. <li><em>status</em> &#8211; Task status. See
  113. <tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult.get_status()</span></tt> for a list of
  114. possible status values.</li>
  115. </ul>
  116. </td>
  117. </tr>
  118. </tbody>
  119. </table>
  120. </dd></dl>
  121. </dd></dl>
  122. </div>
  123. </div>
  124. </div>
  125. </div>
  126. <div class="sphinxsidebar">
  127. <div class="sphinxsidebarwrapper">
  128. <h4>Previous topic</h4>
  129. <p class="topless"><a href="celery.views.html"
  130. title="previous chapter">Django Views - celery.views</a></p>
  131. <h4>Next topic</h4>
  132. <p class="topless"><a href="celery.models.html"
  133. title="next chapter">Django Models - celery.models</a></p>
  134. <h3>This Page</h3>
  135. <ul class="this-page-menu">
  136. <li><a href="../sources/reference/celery.managers.txt"
  137. rel="nofollow">Show Source</a></li>
  138. </ul>
  139. <div id="searchbox" style="display: none">
  140. <h3>Quick search</h3>
  141. <form class="search" action="../search.html" method="get">
  142. <input type="text" name="q" size="18" />
  143. <input type="submit" value="Go" />
  144. <input type="hidden" name="check_keywords" value="yes" />
  145. <input type="hidden" name="area" value="default" />
  146. </form>
  147. <p class="searchtip" style="font-size: 90%">
  148. Enter search terms or a module, class or function name.
  149. </p>
  150. </div>
  151. <script type="text/javascript">$('#searchbox').show(0);</script>
  152. </div>
  153. </div>
  154. <div class="clearer"></div>
  155. </div>
  156. <div class="related">
  157. <h3>Navigation</h3>
  158. <ul>
  159. <li class="right" style="margin-right: 10px">
  160. <a href="../genindex.html" title="General Index"
  161. >index</a></li>
  162. <li class="right" >
  163. <a href="../modindex.html" title="Global Module Index"
  164. >modules</a> |</li>
  165. <li class="right" >
  166. <a href="celery.models.html" title="Django Models - celery.models"
  167. >next</a> |</li>
  168. <li class="right" >
  169. <a href="celery.views.html" title="Django Views - celery.views"
  170. >previous</a> |</li>
  171. <li><a href="../index.html">Celery v0.4.12 (stable) documentation</a> &raquo;</li>
  172. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  173. </ul>
  174. </div>
  175. <div class="footer">
  176. &copy; Copyright 2009, Ask Solem.
  177. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  178. </div>
  179. </body>
  180. </html>