diff options
| author | Ask Solem <askh@opera.com> | 2010-10-27 09:49:27 +0200 |
|---|---|---|
| committer | Ask Solem <askh@opera.com> | 2010-10-27 09:49:27 +0200 |
| commit | 765b0c164f0032b89cce5369456fed11aca04a51 (patch) | |
| tree | e5408863a0b952f757e75b3af617de4b2fb903fb /reference | |
| parent | 641435b2322c3f0c66403943b1c2e72289118a08 (diff) | |
| download | kombu-765b0c164f0032b89cce5369456fed11aca04a51.tar.gz | |
Github Pages: Added missing pages
Diffstat (limited to 'reference')
| -rw-r--r-- | reference/kombu.transport.virtual.exchange.html | 279 | ||||
| -rw-r--r-- | reference/kombu.transport.virtual.scheduling.html | 151 |
2 files changed, 430 insertions, 0 deletions
diff --git a/reference/kombu.transport.virtual.exchange.html b/reference/kombu.transport.virtual.exchange.html new file mode 100644 index 00000000..e0f321fc --- /dev/null +++ b/reference/kombu.transport.virtual.exchange.html @@ -0,0 +1,279 @@ + +<!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>kombu.transport.virtual.exchange — Kombu v0.9.1 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: '0.9.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <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 v0.9.1 documentation" href="../index.html" /> + <link rel="up" title="API Reference" href="index.html" /> + <link rel="next" title="kombu.transport.virtual.scheduling" href="kombu.transport.virtual.scheduling.html" /> + <link rel="prev" title="kombu.transport.virtual" href="kombu.transport.virtual.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.scheduling.html" title="kombu.transport.virtual.scheduling" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.html" title="kombu.transport.virtual" + accesskey="P">previous</a> |</li> + <li><a href="../index.html">Kombu v0.9.1 documentation</a> »</li> + <li><a href="index.html" accesskey="U">API Reference</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <span class="target" id="module-kombu.transport.virtual.exchange"></span><div class="section" id="kombu-transport-virtual-exchange"> +<h1>kombu.transport.virtual.exchange<a class="headerlink" href="#kombu-transport-virtual-exchange" title="Permalink to this headline">¶</a></h1> +<p>Implementations of the standard exchanges defined +by the AMQ protocol (excluding the <cite>headers</cite> exchange).</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 - 2010 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> +<div class="contents local topic" id="contents"> +<ul class="simple"> +<li><a class="reference internal" href="#direct" id="id3">Direct</a></li> +<li><a class="reference internal" href="#topic" id="id4">Topic</a></li> +<li><a class="reference internal" href="#fanout" id="id5">Fanout</a></li> +<li><a class="reference internal" href="#interface" id="id6">Interface</a></li> +</ul> +</div> +<div class="section" id="direct"> +<h2><a class="toc-backref" href="#id3">Direct</a><a class="headerlink" href="#direct" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="kombu.transport.virtual.exchange.DirectExchange"> +<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.exchange.</tt><tt class="descname">DirectExchange</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.DirectExchange" title="Permalink to this definition">¶</a></dt> +<dd><p>The <cite>direct</cite> exchange routes based on exact routing keys.</p> +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.DirectExchange.lookup"> +<tt class="descname">lookup</tt><big>(</big><em>table</em>, <em>exchange</em>, <em>routing_key</em>, <em>default</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.DirectExchange.lookup" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</div> +<div class="section" id="topic"> +<h2><a class="toc-backref" href="#id4">Topic</a><a class="headerlink" href="#topic" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="kombu.transport.virtual.exchange.TopicExchange"> +<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.exchange.</tt><tt class="descname">TopicExchange</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.TopicExchange" title="Permalink to this definition">¶</a></dt> +<dd><p>The <cite>topic</cite> exchanges routes based on words separated by dots, and +wildcard characters <cite>*</cite> (any single word), and <cite>#</cite> (one or more words).</p> +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.TopicExchange.key_to_pattern"> +<tt class="descname">key_to_pattern</tt><big>(</big><em>rkey</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.TopicExchange.key_to_pattern" title="Permalink to this definition">¶</a></dt> +<dd><p>Get the corresponding regex for any routing key.</p> +</dd></dl> + +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.TopicExchange.lookup"> +<tt class="descname">lookup</tt><big>(</big><em>table</em>, <em>exchange</em>, <em>routing_key</em>, <em>default</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.TopicExchange.lookup" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.TopicExchange.prepare_bind"> +<tt class="descname">prepare_bind</tt><big>(</big><em>queue</em>, <em>exchange</em>, <em>routing_key</em>, <em>arguments</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.TopicExchange.prepare_bind" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="kombu.transport.virtual.exchange.TopicExchange.wildcards"> +<tt class="descname">wildcards</tt><a class="headerlink" href="#kombu.transport.virtual.exchange.TopicExchange.wildcards" title="Permalink to this definition">¶</a></dt> +<dd><p>map of wildcard to regex conversions</p> +</dd></dl> + +</dd></dl> + +</div> +<div class="section" id="fanout"> +<h2><a class="toc-backref" href="#id5">Fanout</a><a class="headerlink" href="#fanout" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="kombu.transport.virtual.exchange.FanoutExchange"> +<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.exchange.</tt><tt class="descname">FanoutExchange</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.FanoutExchange" title="Permalink to this definition">¶</a></dt> +<dd><p>The <cite>fanout</cite> exchange implements broadcast messaging by delivering +copies of all messages to all queues bound the the exchange.</p> +<p>To support fanout the virtual channel needs to store the table +as shared state. This requires that the <cite>Channel.supports_fanout</cite> +attribute is set to true, and the <cite>Channel._queue_bind</cite> and +<cite>Channel.get_table</cite> methods are implemented. See the redis backend +for an example implementation of these methods.</p> +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.FanoutExchange.lookup"> +<tt class="descname">lookup</tt><big>(</big><em>table</em>, <em>exchange</em>, <em>routing_key</em>, <em>default</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.FanoutExchange.lookup" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.FanoutExchange.prepare_bind"> +<tt class="descname">prepare_bind</tt><big>(</big><em>queue</em>, <em>exchange</em>, <em>routing_key</em>, <em>arguments</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.FanoutExchange.prepare_bind" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</div> +<div class="section" id="interface"> +<h2><a class="toc-backref" href="#id6">Interface</a><a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="kombu.transport.virtual.exchange.ExchangeType"> +<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.exchange.</tt><tt class="descname">ExchangeType</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.ExchangeType" title="Permalink to this definition">¶</a></dt> +<dd><p>Implements the specifics for an exchange type.</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>channel</strong> – AMQ Channel</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.ExchangeType.equivalent"> +<tt class="descname">equivalent</tt><big>(</big><em>prev</em>, <em>exchange</em>, <em>type</em>, <em>durable</em>, <em>auto_delete</em>, <em>arguments</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.ExchangeType.equivalent" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true if <cite>prev</cite> and <a href="#id1"><span class="problematic" id="id2">`</span></a><em>exchange</em> is equivalent.</p> +</dd></dl> + +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.ExchangeType.lookup"> +<tt class="descname">lookup</tt><big>(</big><em>exchange</em>, <em>routing_key</em>, <em>default</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.ExchangeType.lookup" title="Permalink to this definition">¶</a></dt> +<dd><p>Lookup all queues matching <cite>routing_key</cite> in <cite>exchange</cite>.</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">Returns:</th><td class="field-body"><cite>default</cite> if no queues matched.</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="kombu.transport.virtual.exchange.ExchangeType.prepare_bind"> +<tt class="descname">prepare_bind</tt><big>(</big><em>queue</em>, <em>exchange</em>, <em>routing_key</em>, <em>arguments</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.exchange.ExchangeType.prepare_bind" title="Permalink to this definition">¶</a></dt> +<dd><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">Returns:</th><td class="field-body"><cite>(routing_key, regex, queue)</cite> tuple to store</td> +</tr> +</tbody> +</table> +<p>for bindings to this exchange.</p> +</dd></dl> + +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <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="#">kombu.transport.virtual.exchange</a><ul> +<li><a class="reference internal" href="#direct">Direct</a></li> +<li><a class="reference internal" href="#topic">Topic</a></li> +<li><a class="reference internal" href="#fanout">Fanout</a></li> +<li><a class="reference internal" href="#interface">Interface</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="kombu.transport.virtual.html" + title="previous chapter">kombu.transport.virtual</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="kombu.transport.virtual.scheduling.html" + title="next chapter">kombu.transport.virtual.scheduling</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../sources/reference/kombu.transport.virtual.exchange.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <h3>Quick 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> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.scheduling.html" title="kombu.transport.virtual.scheduling" + >next</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.html" title="kombu.transport.virtual" + >previous</a> |</li> + <li><a href="../index.html">Kombu v0.9.1 documentation</a> »</li> + <li><a href="index.html" >API Reference</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2009-2010, Ask Solem. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4. + </div> + </body> +</html>
\ No newline at end of file diff --git a/reference/kombu.transport.virtual.scheduling.html b/reference/kombu.transport.virtual.scheduling.html new file mode 100644 index 00000000..afe4bd11 --- /dev/null +++ b/reference/kombu.transport.virtual.scheduling.html @@ -0,0 +1,151 @@ + +<!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>kombu.transport.virtual.scheduling — Kombu v0.9.1 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: '0.9.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <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 v0.9.1 documentation" href="../index.html" /> + <link rel="up" title="API Reference" href="index.html" /> + <link rel="next" title="kombu.serialization" href="kombu.serialization.html" /> + <link rel="prev" title="kombu.transport.virtual.exchange" href="kombu.transport.virtual.exchange.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="kombu.serialization.html" title="kombu.serialization" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.exchange.html" title="kombu.transport.virtual.exchange" + accesskey="P">previous</a> |</li> + <li><a href="../index.html">Kombu v0.9.1 documentation</a> »</li> + <li><a href="index.html" accesskey="U">API Reference</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="contents local topic" id="contents"> +<ul class="simple"> +<li><a class="reference internal" href="#kombu-transport-virtual-scheduling" id="id1">kombu.transport.virtual.scheduling</a></li> +</ul> +</div> +<span class="target" id="module-kombu.transport.virtual.scheduling"></span><div class="section" id="kombu-transport-virtual-scheduling"> +<h1><a class="toc-backref" href="#id1">kombu.transport.virtual.scheduling</a><a class="headerlink" href="#kombu-transport-virtual-scheduling" title="Permalink to this headline">¶</a></h1> +<p>Consumer 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 - 2010 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.transport.virtual.scheduling.FairCycle"> +<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.scheduling.</tt><tt class="descname">FairCycle</tt><big>(</big><em>fun</em>, <em>resources</em>, <em>predicate=<type 'exceptions.Exception'></em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.scheduling.FairCycle" title="Permalink to this definition">¶</a></dt> +<dd><p>Consume from a set of resources, where each resource gets +an equal chance to be consumed from.</p> +<dl class="method"> +<dt id="kombu.transport.virtual.scheduling.FairCycle.get"> +<tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.scheduling.FairCycle.get" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar"> + <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> + <h4>Previous topic</h4> + <p class="topless"><a href="kombu.transport.virtual.exchange.html" + title="previous chapter">kombu.transport.virtual.exchange</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="kombu.serialization.html" + title="next chapter">kombu.serialization</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../sources/reference/kombu.transport.virtual.scheduling.txt" + rel="nofollow">Show Source</a></li> + </ul> +<div id="searchbox" style="display: none"> + <h3>Quick 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> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="kombu.serialization.html" title="kombu.serialization" + >next</a> |</li> + <li class="right" > + <a href="kombu.transport.virtual.exchange.html" title="kombu.transport.virtual.exchange" + >previous</a> |</li> + <li><a href="../index.html">Kombu v0.9.1 documentation</a> »</li> + <li><a href="index.html" >API Reference</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2009-2010, Ask Solem. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4. + </div> + </body> +</html>
\ No newline at end of file |