diff options
Diffstat (limited to 'reference/kombu.common.html')
| -rw-r--r-- | reference/kombu.common.html | 82 |
1 files changed, 71 insertions, 11 deletions
diff --git a/reference/kombu.common.html b/reference/kombu.common.html index a94f2c27..8341377a 100644 --- a/reference/kombu.common.html +++ b/reference/kombu.common.html @@ -6,13 +6,13 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Common Utilities - kombu.common — Kombu v1.3.1 documentation</title> + <title>Common Utilities - kombu.common — Kombu v1.4.0 documentation</title> <link rel="stylesheet" href="../_static/celery.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', - VERSION: '1.3.1', + VERSION: '1.4.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -21,9 +21,9 @@ <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> - <link rel="top" title="Kombu v1.3.1 documentation" href="../index.html" /> + <link rel="top" title="Kombu v1.4.0 documentation" href="../index.html" /> <link rel="up" title="API Reference" href="index.html" /> - <link rel="next" title="Clocks and Synchronization - kombu.clocks" href="kombu.clocks.html" /> + <link rel="next" title="Mixin Classes - kombu.mixins" href="kombu.mixins.html" /> <link rel="prev" title="kombu.entity" href="kombu.entity.html" /> </head> <body> @@ -37,12 +37,12 @@ <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > - <a href="kombu.clocks.html" title="Clocks and Synchronization - kombu.clocks" + <a href="kombu.mixins.html" title="Mixin Classes - kombu.mixins" accesskey="N">next</a> |</li> <li class="right" > <a href="kombu.entity.html" title="kombu.entity" accesskey="P">previous</a> |</li> - <li><a href="../index.html">Kombu v1.3.1 documentation</a> »</li> + <li><a href="../index.html">Kombu v1.4.0 documentation</a> »</li> <li><a href="index.html" accesskey="U">API Reference</a> »</li> </ul> </div> @@ -54,11 +54,63 @@ <div class="section" id="common-utilities-kombu-common"> <h1>Common Utilities - kombu.common<a class="headerlink" href="#common-utilities-kombu-common" title="Permalink to this headline">¶</a></h1> -<span class="target" id="module-kombu.common"></span><dl class="function"> +<div class="contents local topic" id="contents"> +<ul class="simple"> +<li><a class="reference internal" href="#kombu-common" id="id1">kombu.common</a></li> +</ul> +</div> +<span class="target" id="module-kombu.common"></span><div class="section" id="kombu-common"> +<h2><a class="toc-backref" href="#id1">kombu.common</a><a class="headerlink" href="#kombu-common" title="Permalink to this headline">¶</a></h2> +<p>Common Utilities.</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">copyright:</th><td class="field-body"><ol class="first loweralpha simple" start="3"> +<li>2009 - 2011 by Ask Solem.</li> +</ol> +</td> +</tr> +<tr class="field"><th class="field-name">license:</th><td class="field-body"><p class="first last">BSD, see LICENSE for more details.</p> +</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="kombu.common.Broadcast"> +<em class="property">class </em><tt class="descclassname">kombu.common.</tt><tt class="descname">Broadcast</tt><big>(</big><em>name=None</em>, <em>queue=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.common.Broadcast" title="Permalink to this definition">¶</a></dt> +<dd><p>Convenience class used to define broadcast queues.</p> +<p>Every queue instance will have a unique name, +and both the queue and exchange is configued with auto deletion.</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">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>name</strong> – This is used as the name of the exchange.</li> +<li><strong>queue</strong> – By default a unique id is used for the queue +name for every consumer. You can specify a custom queue +name here.</li> +<li><strong>**kwargs</strong> – See <a class="reference internal" href="kombu.entity.html#kombu.entity.Queue" title="kombu.entity.Queue"><tt class="xref py py-class docutils literal"><span class="pre">Queue</span></tt></a> for a list +of additional keyword arguments supported.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="function"> <dt id="kombu.common.entry_to_queue"> <tt class="descclassname">kombu.common.</tt><tt class="descname">entry_to_queue</tt><big>(</big><em>queue</em>, <em>**options</em><big>)</big><a class="headerlink" href="#kombu.common.entry_to_queue" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> +<dl class="function"> +<dt id="kombu.common.maybe_declare"> +<tt class="descclassname">kombu.common.</tt><tt class="descname">maybe_declare</tt><big>(</big><em>entity</em>, <em>channel</em><big>)</big><a class="headerlink" href="#kombu.common.maybe_declare" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</div> </div> @@ -69,12 +121,20 @@ <div class="sphinxsidebarwrapper"><p class="logo"><a href="../index.html"> <img class="logo" width="128" height="128" src="http://cloud.github.com/downloads/ask/kombu/kombusmall.jpg" alt="Logo"/> </a></p> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">Common Utilities - kombu.common</a><ul> +<li><a class="reference internal" href="#kombu-common">kombu.common</a></li> +</ul> +</li> +</ul> + <h4>Previous topic</h4> <p class="topless"><a href="kombu.entity.html" title="previous chapter">kombu.entity</a></p> <h4>Next topic</h4> - <p class="topless"><a href="kombu.clocks.html" - title="next chapter">Clocks and Synchronization - kombu.clocks</a></p> + <p class="topless"><a href="kombu.mixins.html" + title="next chapter">Mixin Classes - kombu.mixins</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/reference/kombu.common.txt" @@ -107,12 +167,12 @@ <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > - <a href="kombu.clocks.html" title="Clocks and Synchronization - kombu.clocks" + <a href="kombu.mixins.html" title="Mixin Classes - kombu.mixins" >next</a> |</li> <li class="right" > <a href="kombu.entity.html" title="kombu.entity" >previous</a> |</li> - <li><a href="../index.html">Kombu v1.3.1 documentation</a> »</li> + <li><a href="../index.html">Kombu v1.4.0 documentation</a> »</li> <li><a href="index.html" >API Reference</a> »</li> </ul> </div> |