celery.managers.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  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.2.0-pre1 documentation</title>
  7. <link rel="stylesheet" href="../static/default.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.2.0-pre1',
  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.2.0-pre1 documentation" href="../index.html" />
  21. <link rel="next" title="Django Models - celery.models" href="celery.models.html" />
  22. <link rel="prev" title="Logging - celery.log" href="celery.log.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="../genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |</li>
  34. <li class="right" >
  35. <a href="celery.models.html" title="Django Models - celery.models"
  36. accesskey="N">next</a> |</li>
  37. <li class="right" >
  38. <a href="celery.log.html" title="Logging - celery.log"
  39. accesskey="P">previous</a> |</li>
  40. <li><a href="../index.html">Celery v0.2.0-pre1 documentation</a> &raquo;</li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.managers">
  48. <h1>Django Model Managers - celery.managers<a class="headerlink" href="#module-celery.managers" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.managers</p>
  50. <dl class="class">
  51. <dt id="celery.managers.PeriodicTaskManager">
  52. <em class="property">
  53. 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>
  54. <dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.PeriodicTask</span></tt> models.</p>
  55. <dl class="method">
  56. <dt id="celery.managers.PeriodicTaskManager.get_waiting_tasks">
  57. <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>
  58. <dd><p>Get all waiting periodic tasks.</p>
  59. <table class="docutils field-list" frame="void" rules="none">
  60. <col class="field-name" />
  61. <col class="field-body" />
  62. <tbody valign="top">
  63. <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>
  64. </tr>
  65. </tbody>
  66. </table>
  67. </dd></dl>
  68. </dd></dl>
  69. <dl class="class">
  70. <dt id="celery.managers.TaskManager">
  71. <em class="property">
  72. 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>
  73. <dd><p>Manager for <tt class="xref docutils literal"><span class="pre">celery.models.Task</span></tt> models.</p>
  74. <dl class="method">
  75. <dt id="celery.managers.TaskManager.delete_expired">
  76. <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>
  77. <dd>Delete all expired task results.</dd></dl>
  78. <dl class="method">
  79. <dt id="celery.managers.TaskManager.get_all_expired">
  80. <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>
  81. <dd>Get all expired task results.</dd></dl>
  82. <dl class="method">
  83. <dt id="celery.managers.TaskManager.get_task">
  84. <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>
  85. <dd>Get task meta for task by <tt class="docutils literal"><span class="pre">task_id</span></tt>.</dd></dl>
  86. <dl class="method">
  87. <dt id="celery.managers.TaskManager.is_done">
  88. <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>
  89. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task was executed successfully.</dd></dl>
  90. <dl class="method">
  91. <dt id="celery.managers.TaskManager.store_result">
  92. <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>
  93. <dd><p>Store the result and status of a task.</p>
  94. <table class="docutils field-list" frame="void" rules="none">
  95. <col class="field-name" />
  96. <col class="field-body" />
  97. <tbody valign="top">
  98. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  99. <li><em>task_id</em> &#8211; task id</li>
  100. <li><em>result</em> &#8211; The return value of the task, or an exception
  101. instance raised by the task.</li>
  102. <li><em>status</em> &#8211; Task status. See
  103. <tt class="xref docutils literal"><span class="pre">celery.result.AsyncResult.get_status()</span></tt> for a list of
  104. possible status values.</li>
  105. </ul>
  106. </td>
  107. </tr>
  108. </tbody>
  109. </table>
  110. </dd></dl>
  111. </dd></dl>
  112. </div>
  113. </div>
  114. </div>
  115. </div>
  116. <div class="sphinxsidebar">
  117. <div class="sphinxsidebarwrapper">
  118. <h4>Previous topic</h4>
  119. <p class="topless"><a href="celery.log.html"
  120. title="previous chapter">Logging - celery.log</a></p>
  121. <h4>Next topic</h4>
  122. <p class="topless"><a href="celery.models.html"
  123. title="next chapter">Django Models - celery.models</a></p>
  124. <h3>This Page</h3>
  125. <ul class="this-page-menu">
  126. <li><a href="../sources/reference/celery.managers.txt"
  127. rel="nofollow">Show Source</a></li>
  128. </ul>
  129. <div id="searchbox" style="display: none">
  130. <h3>Quick search</h3>
  131. <form class="search" action="../search.html" method="get">
  132. <input type="text" name="q" size="18" />
  133. <input type="submit" value="Go" />
  134. <input type="hidden" name="check_keywords" value="yes" />
  135. <input type="hidden" name="area" value="default" />
  136. </form>
  137. <p class="searchtip" style="font-size: 90%">
  138. Enter search terms or a module, class or function name.
  139. </p>
  140. </div>
  141. <script type="text/javascript">$('#searchbox').show(0);</script>
  142. </div>
  143. </div>
  144. <div class="clearer"></div>
  145. </div>
  146. <div class="related">
  147. <h3>Navigation</h3>
  148. <ul>
  149. <li class="right" style="margin-right: 10px">
  150. <a href="../genindex.html" title="General Index"
  151. >index</a></li>
  152. <li class="right" >
  153. <a href="../modindex.html" title="Global Module Index"
  154. >modules</a> |</li>
  155. <li class="right" >
  156. <a href="celery.models.html" title="Django Models - celery.models"
  157. >next</a> |</li>
  158. <li class="right" >
  159. <a href="celery.log.html" title="Logging - celery.log"
  160. >previous</a> |</li>
  161. <li><a href="../index.html">Celery v0.2.0-pre1 documentation</a> &raquo;</li>
  162. </ul>
  163. </div>
  164. <div class="footer">
  165. &copy; Copyright 2009, Ask Solem.
  166. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  167. </div>
  168. </body>
  169. </html>