celery.timer.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  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>Timers - celery.timer &mdash; Celery v0.3.2 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/agogo.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.3.2 (unstable)',
  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.3.2 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Celery Worker Daemon - celery.bin.celeryd" href="celery.bin.celeryd.html" />
  23. <link rel="prev" title="Platform Specific - celery.platform" href="celery.platform.html" />
  24. </head>
  25. <body>
  26. <div class="header-wrapper">
  27. <div class="header">
  28. <h1><a href="../index.html">Celery v0.3.2 (unstable) documentation</a></h1>
  29. <div class="rel">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a> |
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |
  34. <a href="celery.bin.celeryd.html" title="Celery Worker Daemon - celery.bin.celeryd"
  35. accesskey="N">next</a> |
  36. <a href="celery.platform.html" title="Platform Specific - celery.platform"
  37. accesskey="P">previous</a>
  38. </div>
  39. </div>
  40. </div>
  41. <div class="content-wrapper">
  42. <div class="content">
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.timer">
  48. <h1>Timers - celery.timer<a class="headerlink" href="#module-celery.timer" title="Permalink to this headline">¶</a></h1>
  49. <p>Managing time and events</p>
  50. <dl class="class">
  51. <dt id="celery.timer.EventTimer">
  52. <em class="property">
  53. class </em><tt class="descclassname">celery.timer.</tt><tt class="descname">EventTimer</tt><big>(</big><em>event</em>, <em>interval=None</em><big>)</big><a class="headerlink" href="#celery.timer.EventTimer" title="Permalink to this definition">¶</a></dt>
  54. <dd><p>Do something at an interval.</p>
  55. <dl class="attribute">
  56. <dt id="celery.timer.EventTimer.interval">
  57. <tt class="descname">interval</tt><a class="headerlink" href="#celery.timer.EventTimer.interval" title="Permalink to this definition">¶</a></dt>
  58. <dd>How often we call the event (in seconds).</dd></dl>
  59. <dl class="attribute">
  60. <dt id="celery.timer.EventTimer.event">
  61. <tt class="descname">event</tt><a class="headerlink" href="#celery.timer.EventTimer.event" title="Permalink to this definition">¶</a></dt>
  62. <dd>The event callable to run every <tt class="docutils literal"><span class="pre">interval</span></tt> seconds.</dd></dl>
  63. <dl class="attribute">
  64. <dt id="celery.timer.EventTimer.last_triggered">
  65. <tt class="descname">last_triggered</tt><a class="headerlink" href="#celery.timer.EventTimer.last_triggered" title="Permalink to this definition">¶</a></dt>
  66. <dd>The last time, in unix timestamp format, the event was executed.</dd></dl>
  67. <dl class="method">
  68. <dt id="celery.timer.EventTimer.tick">
  69. <tt class="descname">tick</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.timer.EventTimer.tick" title="Permalink to this definition">¶</a></dt>
  70. <dd><p>Run a event timer clock tick.</p>
  71. <p>When the interval has run, the event will be triggered.
  72. If interval is not set, the event will never be triggered.</p>
  73. </dd></dl>
  74. </dd></dl>
  75. <dl class="exception">
  76. <dt id="celery.timer.TimeoutError">
  77. <em class="property">
  78. exception </em><tt class="descclassname">celery.timer.</tt><tt class="descname">TimeoutError</tt><a class="headerlink" href="#celery.timer.TimeoutError" title="Permalink to this definition">¶</a></dt>
  79. <dd>The event has timed out.</dd></dl>
  80. <dl class="class">
  81. <dt id="celery.timer.TimeoutTimer">
  82. <em class="property">
  83. class </em><tt class="descclassname">celery.timer.</tt><tt class="descname">TimeoutTimer</tt><big>(</big><em>timeout</em>, <em>timeout_msg='The operation timed out'</em><big>)</big><a class="headerlink" href="#celery.timer.TimeoutTimer" title="Permalink to this definition">¶</a></dt>
  84. <dd><p>A timer that raises <a title="celery.timer.TimeoutError" class="reference internal" href="#celery.timer.TimeoutError"><tt class="xref docutils literal"><span class="pre">TimeoutError</span></tt></a> exception when the
  85. time has run out.</p>
  86. <dl class="attribute">
  87. <dt id="celery.timer.TimeoutTimer.timeout">
  88. <tt class="descname">timeout</tt><a class="headerlink" href="#celery.timer.TimeoutTimer.timeout" title="Permalink to this definition">¶</a></dt>
  89. <dd>The timeout in seconds.</dd></dl>
  90. <dl class="attribute">
  91. <dt id="celery.timer.TimeoutTimer.time_start">
  92. <tt class="descname">time_start</tt><a class="headerlink" href="#celery.timer.TimeoutTimer.time_start" title="Permalink to this definition">¶</a></dt>
  93. <dd>The time when the timeout timer instance was constructed.</dd></dl>
  94. <dl class="method">
  95. <dt id="celery.timer.TimeoutTimer.tick">
  96. <tt class="descname">tick</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.timer.TimeoutTimer.tick" title="Permalink to this definition">¶</a></dt>
  97. <dd><p>Run a timeout timer clock tick.</p>
  98. <table class="docutils field-list" frame="void" rules="none">
  99. <col class="field-name" />
  100. <col class="field-body" />
  101. <tbody valign="top">
  102. <tr class="field"><th class="field-name" colspan="2">Raises <a title="celery.timer.TimeoutError" class="reference internal" href="#celery.timer.TimeoutError">TimeoutError</a>:</th></tr>
  103. <tr><td>&nbsp;</td><td class="field-body">when <a title="celery.timer.TimeoutTimer.timeout" class="reference internal" href="#celery.timer.TimeoutTimer.timeout"><tt class="xref docutils literal"><span class="pre">timeout</span></tt></a> seconds has passed.
  104. If <a title="celery.timer.TimeoutTimer.timeout" class="reference internal" href="#celery.timer.TimeoutTimer.timeout"><tt class="xref docutils literal"><span class="pre">timeout</span></tt></a> is not set, it will never time out.</td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. </dd></dl>
  109. </dd></dl>
  110. </div>
  111. </div>
  112. </div>
  113. </div>
  114. </div>
  115. <div class="sidebar">
  116. <h3>Contents</h3>
  117. <ul class="current">
  118. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  119. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
  120. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
  121. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  122. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
  123. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  124. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  125. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  126. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  127. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
  128. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  129. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  130. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  131. <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
  132. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
  133. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  134. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  135. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  136. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  137. <li class="toctree-l2"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
  138. <li class="toctree-l2 current"><a class="current reference external" href="">Timers - celery.timer</a></li>
  139. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  140. </ul>
  141. </li>
  142. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
  143. </ul>
  144. <h3 style="margin-top: 1.5em;">Search</h3>
  145. <form class="search" action="../search.html" method="get">
  146. <input type="text" name="q" size="18" />
  147. <input type="submit" value="Go" />
  148. <input type="hidden" name="check_keywords" value="yes" />
  149. <input type="hidden" name="area" value="default" />
  150. </form>
  151. <p class="searchtip" style="font-size: 90%">
  152. Enter search terms or a module, class or function name.
  153. </p>
  154. </div>
  155. <div class="clearer"></div>
  156. </div>
  157. </div>
  158. <div class="footer-wrapper">
  159. <div class="footer">
  160. <div class="left">
  161. <a href="../genindex.html" title="General Index"
  162. >index</a> |
  163. <a href="../modindex.html" title="Global Module Index"
  164. >modules</a> |
  165. <a href="celery.bin.celeryd.html" title="Celery Worker Daemon - celery.bin.celeryd"
  166. >next</a> |
  167. <a href="celery.platform.html" title="Platform Specific - celery.platform"
  168. >previous</a>
  169. <br/>
  170. <a href="../sources/reference/celery.timer.txt"
  171. rel="nofollow">Show Source</a>
  172. </div>
  173. <div class="right">
  174. &copy; Copyright 2009, Ask Solem.<br/>
  175. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  176. </div>
  177. <div class="clearer"></div>
  178. </div>
  179. </div>
  180. </body>
  181. </html>