123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
- <title>Timers - celery.timer — Celery v0.3.2 (unstable) documentation</title>
- <link rel="stylesheet" href="../static/agogo.css" type="text/css" />
- <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../',
- VERSION: '0.3.2 (unstable)',
- COLLAPSE_MODINDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true
- };
- </script>
- <script type="text/javascript" src="../static/jquery.js"></script>
- <script type="text/javascript" src="../static/doctools.js"></script>
- <link rel="top" title="Celery v0.3.2 (unstable) documentation" href="../index.html" />
- <link rel="up" title="Module API Reference" href="index.html" />
- <link rel="next" title="Celery Worker Daemon - celery.bin.celeryd" href="celery.bin.celeryd.html" />
- <link rel="prev" title="Platform Specific - celery.platform" href="celery.platform.html" />
- </head>
- <body>
- <div class="header-wrapper">
- <div class="header">
- <h1><a href="../index.html">Celery v0.3.2 (unstable) documentation</a></h1>
- <div class="rel">
- <a href="../genindex.html" title="General Index"
- accesskey="I">index</a> |
- <a href="../modindex.html" title="Global Module Index"
- accesskey="M">modules</a> |
- <a href="celery.bin.celeryd.html" title="Celery Worker Daemon - celery.bin.celeryd"
- accesskey="N">next</a> |
- <a href="celery.platform.html" title="Platform Specific - celery.platform"
- accesskey="P">previous</a>
- </div>
- </div>
- </div>
- <div class="content-wrapper">
- <div class="content">
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body">
-
- <div class="section" id="module-celery.timer">
- <h1>Timers - celery.timer<a class="headerlink" href="#module-celery.timer" title="Permalink to this headline">¶</a></h1>
- <p>Managing time and events</p>
- <dl class="class">
- <dt id="celery.timer.EventTimer">
- <em class="property">
- 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>
- <dd><p>Do something at an interval.</p>
- <dl class="attribute">
- <dt id="celery.timer.EventTimer.interval">
- <tt class="descname">interval</tt><a class="headerlink" href="#celery.timer.EventTimer.interval" title="Permalink to this definition">¶</a></dt>
- <dd>How often we call the event (in seconds).</dd></dl>
- <dl class="attribute">
- <dt id="celery.timer.EventTimer.event">
- <tt class="descname">event</tt><a class="headerlink" href="#celery.timer.EventTimer.event" title="Permalink to this definition">¶</a></dt>
- <dd>The event callable to run every <tt class="docutils literal"><span class="pre">interval</span></tt> seconds.</dd></dl>
- <dl class="attribute">
- <dt id="celery.timer.EventTimer.last_triggered">
- <tt class="descname">last_triggered</tt><a class="headerlink" href="#celery.timer.EventTimer.last_triggered" title="Permalink to this definition">¶</a></dt>
- <dd>The last time, in unix timestamp format, the event was executed.</dd></dl>
- <dl class="method">
- <dt id="celery.timer.EventTimer.tick">
- <tt class="descname">tick</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.timer.EventTimer.tick" title="Permalink to this definition">¶</a></dt>
- <dd><p>Run a event timer clock tick.</p>
- <p>When the interval has run, the event will be triggered.
- If interval is not set, the event will never be triggered.</p>
- </dd></dl>
- </dd></dl>
- <dl class="exception">
- <dt id="celery.timer.TimeoutError">
- <em class="property">
- 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>
- <dd>The event has timed out.</dd></dl>
- <dl class="class">
- <dt id="celery.timer.TimeoutTimer">
- <em class="property">
- 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>
- <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
- time has run out.</p>
- <dl class="attribute">
- <dt id="celery.timer.TimeoutTimer.timeout">
- <tt class="descname">timeout</tt><a class="headerlink" href="#celery.timer.TimeoutTimer.timeout" title="Permalink to this definition">¶</a></dt>
- <dd>The timeout in seconds.</dd></dl>
- <dl class="attribute">
- <dt id="celery.timer.TimeoutTimer.time_start">
- <tt class="descname">time_start</tt><a class="headerlink" href="#celery.timer.TimeoutTimer.time_start" title="Permalink to this definition">¶</a></dt>
- <dd>The time when the timeout timer instance was constructed.</dd></dl>
- <dl class="method">
- <dt id="celery.timer.TimeoutTimer.tick">
- <tt class="descname">tick</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.timer.TimeoutTimer.tick" title="Permalink to this definition">¶</a></dt>
- <dd><p>Run a timeout timer clock tick.</p>
- <table class="docutils field-list" frame="void" rules="none">
- <col class="field-name" />
- <col class="field-body" />
- <tbody valign="top">
- <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>
- <tr><td> </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.
- 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>
- </tr>
- </tbody>
- </table>
- </dd></dl>
- </dd></dl>
- </div>
- </div>
- </div>
- </div>
- </div>
- <div class="sidebar">
- <h3>Contents</h3>
- <ul class="current">
- <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
- <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
- <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
- <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
- <li class="toctree-l2 current"><a class="current reference external" href="">Timers - celery.timer</a></li>
- <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
- </ul>
- </li>
- <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
- </ul>
- <h3 style="margin-top: 1.5em;">Search</h3>
- <form class="search" action="../search.html" method="get">
- <input type="text" name="q" size="18" />
- <input type="submit" value="Go" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- <p class="searchtip" style="font-size: 90%">
- Enter search terms or a module, class or function name.
- </p>
- </div>
- <div class="clearer"></div>
- </div>
- </div>
- <div class="footer-wrapper">
- <div class="footer">
- <div class="left">
- <a href="../genindex.html" title="General Index"
- >index</a> |
- <a href="../modindex.html" title="Global Module Index"
- >modules</a> |
- <a href="celery.bin.celeryd.html" title="Celery Worker Daemon - celery.bin.celeryd"
- >next</a> |
- <a href="celery.platform.html" title="Platform Specific - celery.platform"
- >previous</a>
- <br/>
- <a href="../sources/reference/celery.timer.txt"
- rel="nofollow">Show Source</a>
- </div>
- <div class="right">
- © Copyright 2009, Ask Solem.<br/>
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
- </div>
- <div class="clearer"></div>
- </div>
- </div>
- </body>
- </html>
|