celery.task.builtins.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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>Built-in Task Classes - celery.task.builtins &mdash; Celery v0.6.0 (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.6.0 (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.6.0 (stable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Common Task Strategies - celery.task.strategy" href="celery.task.strategy.html" />
  23. <link rel="prev" title="Task Registry - celery.registry" href="celery.registry.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.task.strategy.html" title="Common Task Strategies - celery.task.strategy"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.registry.html" title="Task Registry - celery.registry"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.6.0 (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.task.builtins">
  50. <h1>Built-in Task Classes - celery.task.builtins<a class="headerlink" href="#module-celery.task.builtins" title="Permalink to this headline">¶</a></h1>
  51. <dl class="class">
  52. <dt id="celery.task.builtins.DeleteExpiredTaskMetaTask">
  53. <em class="property">
  54. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">DeleteExpiredTaskMetaTask</tt><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask" title="Permalink to this definition">¶</a></dt>
  55. <dd><p>A periodic task that deletes expired task metadata every day.</p>
  56. <p>This runs the current backend&#8217;s
  57. <a title="celery.backends.base.BaseBackend.cleanup" class="reference external" href="celery.backends.base.html#celery.backends.base.BaseBackend.cleanup"><tt class="xref docutils literal"><span class="pre">celery.backends.base.BaseBackend.cleanup()</span></tt></a> method.</p>
  58. <dl class="method">
  59. <dt id="celery.task.builtins.DeleteExpiredTaskMetaTask.run">
  60. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask.run" title="Permalink to this definition">¶</a></dt>
  61. <dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>
  62. </dd></dl>
  63. <dl class="class">
  64. <dt id="celery.task.builtins.PingTask">
  65. <em class="property">
  66. class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">PingTask</tt><a class="headerlink" href="#celery.task.builtins.PingTask" title="Permalink to this definition">¶</a></dt>
  67. <dd><p>The task used by <tt class="xref docutils literal"><span class="pre">ping()</span></tt>.</p>
  68. <dl class="method">
  69. <dt id="celery.task.builtins.PingTask.run">
  70. <tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.PingTask.run" title="Permalink to this definition">¶</a></dt>
  71. <dd><table class="docutils field-list" frame="void" rules="none">
  72. <col class="field-name" />
  73. <col class="field-body" />
  74. <tbody valign="top">
  75. <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the string <tt class="docutils literal"><span class="pre">&quot;pong&quot;</span></tt>.</td>
  76. </tr>
  77. </tbody>
  78. </table>
  79. </dd></dl>
  80. </dd></dl>
  81. </div>
  82. </div>
  83. </div>
  84. </div>
  85. <div class="sphinxsidebar">
  86. <div class="sphinxsidebarwrapper">
  87. <h4>Previous topic</h4>
  88. <p class="topless"><a href="celery.registry.html"
  89. title="previous chapter">Task Registry - celery.registry</a></p>
  90. <h4>Next topic</h4>
  91. <p class="topless"><a href="celery.task.strategy.html"
  92. title="next chapter">Common Task Strategies - celery.task.strategy</a></p>
  93. <h3>This Page</h3>
  94. <ul class="this-page-menu">
  95. <li><a href="../sources/reference/celery.task.builtins.txt"
  96. rel="nofollow">Show Source</a></li>
  97. </ul>
  98. <div id="searchbox" style="display: none">
  99. <h3>Quick search</h3>
  100. <form class="search" action="../search.html" method="get">
  101. <input type="text" name="q" size="18" />
  102. <input type="submit" value="Go" />
  103. <input type="hidden" name="check_keywords" value="yes" />
  104. <input type="hidden" name="area" value="default" />
  105. </form>
  106. <p class="searchtip" style="font-size: 90%">
  107. Enter search terms or a module, class or function name.
  108. </p>
  109. </div>
  110. <script type="text/javascript">$('#searchbox').show(0);</script>
  111. </div>
  112. </div>
  113. <div class="clearer"></div>
  114. </div>
  115. <div class="related">
  116. <h3>Navigation</h3>
  117. <ul>
  118. <li class="right" style="margin-right: 10px">
  119. <a href="../genindex.html" title="General Index"
  120. >index</a></li>
  121. <li class="right" >
  122. <a href="../modindex.html" title="Global Module Index"
  123. >modules</a> |</li>
  124. <li class="right" >
  125. <a href="celery.task.strategy.html" title="Common Task Strategies - celery.task.strategy"
  126. >next</a> |</li>
  127. <li class="right" >
  128. <a href="celery.registry.html" title="Task Registry - celery.registry"
  129. >previous</a> |</li>
  130. <li><a href="../index.html">Celery v0.6.0 (stable) documentation</a> &raquo;</li>
  131. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  132. </ul>
  133. </div>
  134. <div class="footer">
  135. &copy; Copyright 2009, Ask Solem.
  136. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  137. </div>
  138. </body>
  139. </html>