celery.platform.html 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  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>Platform Specific - celery.platform &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="Timers - celery.timer" href="celery.timer.html" />
  23. <link rel="prev" title="Messaging - celery.messaging" href="celery.messaging.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.timer.html" title="Timers - celery.timer"
  35. accesskey="N">next</a> |
  36. <a href="celery.messaging.html" title="Messaging - celery.messaging"
  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.platform">
  48. <h1>Platform Specific - celery.platform<a class="headerlink" href="#module-celery.platform" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.platform</p>
  50. <dl class="class">
  51. <dt id="celery.platform.PIDFile">
  52. <em class="property">
  53. class </em><tt class="descclassname">celery.platform.</tt><tt class="descname">PIDFile</tt><big>(</big><em>pidfile</em><big>)</big><a class="headerlink" href="#celery.platform.PIDFile" title="Permalink to this definition">¶</a></dt>
  54. <dd><p>Manages a pid file.</p>
  55. <dl class="method">
  56. <dt id="celery.platform.PIDFile.check">
  57. <tt class="descname">check</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.platform.PIDFile.check" title="Permalink to this definition">¶</a></dt>
  58. <dd><p>Check the status of the pidfile.</p>
  59. <p>If the pidfile exists, and the process is not running, it will
  60. remove the stale pidfile and continue as normal. If the process
  61. <em>is</em> running, it will exit the program with an error message.</p>
  62. </dd></dl>
  63. <dl class="method">
  64. <dt id="celery.platform.PIDFile.get_pid">
  65. <tt class="descname">get_pid</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.platform.PIDFile.get_pid" title="Permalink to this definition">¶</a></dt>
  66. <dd>Get the process id stored in the pidfile.</dd></dl>
  67. <dl class="method">
  68. <dt id="celery.platform.PIDFile.remove">
  69. <tt class="descname">remove</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.platform.PIDFile.remove" title="Permalink to this definition">¶</a></dt>
  70. <dd>Remove the pidfile.</dd></dl>
  71. <dl class="method">
  72. <dt id="celery.platform.PIDFile.write">
  73. <tt class="descname">write</tt><big>(</big><em>pid=None</em><big>)</big><a class="headerlink" href="#celery.platform.PIDFile.write" title="Permalink to this definition">¶</a></dt>
  74. <dd><p>Write a pidfile.</p>
  75. <p>If <tt class="docutils literal"><span class="pre">pid</span></tt> is not specified the pid of the current process
  76. will be used.</p>
  77. </dd></dl>
  78. </dd></dl>
  79. <dl class="function">
  80. <dt id="celery.platform.daemonize">
  81. <tt class="descclassname">celery.platform.</tt><tt class="descname">daemonize</tt><big>(</big><em>pidfile</em><big>)</big><a class="headerlink" href="#celery.platform.daemonize" title="Permalink to this definition">¶</a></dt>
  82. <dd>Detach a process from the controlling terminal and run it in the
  83. background as a daemon.</dd></dl>
  84. <dl class="function">
  85. <dt id="celery.platform.remove_pidfile">
  86. <tt class="descclassname">celery.platform.</tt><tt class="descname">remove_pidfile</tt><big>(</big><em>pidfile</em><big>)</big><a class="headerlink" href="#celery.platform.remove_pidfile" title="Permalink to this definition">¶</a></dt>
  87. <dd>Remove the pidfile.</dd></dl>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. <div class="sidebar">
  94. <h3>Contents</h3>
  95. <ul class="current">
  96. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  97. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
  98. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
  99. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  100. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
  101. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  102. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  103. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  104. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  105. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
  106. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  107. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  108. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  109. <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
  110. <li class="toctree-l2"><a class="reference external" href="celery.datastructures.html">Datastructures - celery.datastructures</a></li>
  111. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  112. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  113. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  114. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  115. <li class="toctree-l2 current"><a class="current reference external" href="">Platform Specific - celery.platform</a></li>
  116. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
  117. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  118. </ul>
  119. </li>
  120. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
  121. </ul>
  122. <h3 style="margin-top: 1.5em;">Search</h3>
  123. <form class="search" action="../search.html" method="get">
  124. <input type="text" name="q" size="18" />
  125. <input type="submit" value="Go" />
  126. <input type="hidden" name="check_keywords" value="yes" />
  127. <input type="hidden" name="area" value="default" />
  128. </form>
  129. <p class="searchtip" style="font-size: 90%">
  130. Enter search terms or a module, class or function name.
  131. </p>
  132. </div>
  133. <div class="clearer"></div>
  134. </div>
  135. </div>
  136. <div class="footer-wrapper">
  137. <div class="footer">
  138. <div class="left">
  139. <a href="../genindex.html" title="General Index"
  140. >index</a> |
  141. <a href="../modindex.html" title="Global Module Index"
  142. >modules</a> |
  143. <a href="celery.timer.html" title="Timers - celery.timer"
  144. >next</a> |
  145. <a href="celery.messaging.html" title="Messaging - celery.messaging"
  146. >previous</a>
  147. <br/>
  148. <a href="../sources/reference/celery.platform.txt"
  149. rel="nofollow">Show Source</a>
  150. </div>
  151. <div class="right">
  152. &copy; Copyright 2009, Ask Solem.<br/>
  153. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  154. </div>
  155. <div class="clearer"></div>
  156. </div>
  157. </div>
  158. </body>
  159. </html>