diff options
Diffstat (limited to 'reference/kombu.pools.html')
| -rw-r--r-- | reference/kombu.pools.html | 159 |
1 files changed, 146 insertions, 13 deletions
diff --git a/reference/kombu.pools.html b/reference/kombu.pools.html index 2675a6c7..e5840d28 100644 --- a/reference/kombu.pools.html +++ b/reference/kombu.pools.html @@ -7,7 +7,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>General Pools - kombu.pools — Kombu 2.1.3 documentation</title> + <title>General Pools - kombu.pools — Kombu 2.2.0rc2 documentation</title> <link rel="stylesheet" href="../_static/celery.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', - VERSION: '2.1.3', + VERSION: '2.2.0rc2', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -24,7 +24,7 @@ <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 2.1.3 documentation" href="../index.html" /> + <link rel="top" title="Kombu 2.2.0rc2 documentation" href="../index.html" /> <link rel="up" title="API Reference" href="index.html" /> <link rel="next" title="kombu.compression" href="kombu.abstract.html" /> <link rel="prev" title="kombu.compression" href="kombu.compression.html" /> @@ -45,7 +45,7 @@ <li class="right" > <a href="kombu.compression.html" title="kombu.compression" accesskey="P">previous</a> |</li> - <li><a href="../index.html">Kombu 2.1.3 documentation</a> »</li> + <li><a href="../index.html">Kombu 2.2.0rc2 documentation</a> »</li> <li><a href="index.html" accesskey="U">API Reference</a> »</li> </ul> </div> @@ -82,34 +82,167 @@ <dl class="class"> <dt id="kombu.pools.ProducerPool"> <em class="property">class </em><tt class="descclassname">kombu.pools.</tt><tt class="descname">ProducerPool</tt><big>(</big><em>connections</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool" title="Permalink to this definition">¶</a></dt> -<dd><dl class="method"> +<dd><dl class="class"> <dt id="kombu.pools.ProducerPool.Producer"> -<tt class="descname">Producer</tt><big>(</big><em>connection</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><tt class="descname">Producer</tt><big>(</big><em>channel</em>, <em>exchange=None</em>, <em>routing_key=None</em>, <em>serializer=None</em>, <em>auto_declare=None</em>, <em>compression=None</em>, <em>on_return=None</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer" title="Permalink to this definition">¶</a></dt> +<dd><p>Message Producer.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>channel</strong> – Connection or channel.</li> +<li><strong>exchange</strong> – Optional default exchange.</li> +<li><strong>routing_key</strong> – Optional default routing key.</li> +<li><strong>serializer</strong> – Default serializer. Default is <cite>“json”</cite>.</li> +<li><strong>compression</strong> – Default compression method. Default is no +compression.</li> +<li><strong>auto_declare</strong> – Automatically declare the default exchange +at instantiation. Default is <tt class="xref py py-const docutils literal"><span class="pre">True</span></tt>.</li> +<li><strong>on_return</strong> – Callback to call for undeliverable messages, +when the <cite>mandatory</cite> or <cite>immediate</cite> arguments to +<a class="reference internal" href="#kombu.pools.ProducerPool.Producer.publish" title="kombu.pools.ProducerPool.Producer.publish"><tt class="xref py py-meth docutils literal"><span class="pre">publish()</span></tt></a> is used. This callback needs the following +signature: <cite>(exception, exchange, routing_key, message)</cite>. +Note that the producer needs to drain events to use this feature.</li> +</ul> +</td> +</tr> +</tbody> +</table> +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.auto_declare"> +<tt class="descname">auto_declare</tt><em class="property"> = True</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.auto_declare" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.channel"> +<tt class="descname">channel</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.channel" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.close"> +<tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.close" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.compression"> +<tt class="descname">compression</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.compression" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.connection"> +<tt class="descname">connection</tt><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.connection" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.declare"> +<tt class="descname">declare</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.declare" title="Permalink to this definition">¶</a></dt> +<dd><p>Declare the exchange.</p> +<p>This happens automatically at instantiation if +<a class="reference internal" href="#kombu.pools.ProducerPool.Producer.auto_declare" title="kombu.pools.ProducerPool.Producer.auto_declare"><tt class="xref py py-attr docutils literal"><span class="pre">auto_declare</span></tt></a> is enabled.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.exchange"> +<tt class="descname">exchange</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.exchange" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.maybe_declare"> +<tt class="descname">maybe_declare</tt><big>(</big><em>entity</em>, <em>retry=False</em>, <em>**retry_policy</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.maybe_declare" title="Permalink to this definition">¶</a></dt> +<dd><p>Declare the exchange if it hasn’t already been declared +during this session.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.on_return"> +<tt class="descname">on_return</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.on_return" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.publish"> +<tt class="descname">publish</tt><big>(</big><em>body</em>, <em>routing_key=None</em>, <em>delivery_mode=None</em>, <em>mandatory=False</em>, <em>immediate=False</em>, <em>priority=0</em>, <em>content_type=None</em>, <em>content_encoding=None</em>, <em>serializer=None</em>, <em>headers=None</em>, <em>compression=None</em>, <em>exchange=None</em>, <em>retry=False</em>, <em>retry_policy=None</em>, <em>declare=</em><span class="optional">[</span><span class="optional">]</span>, <em>**properties</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.publish" title="Permalink to this definition">¶</a></dt> +<dd><p>Publish message to the specified 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-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> +<li><strong>body</strong> – Message body.</li> +<li><strong>routing_key</strong> – Message routing key.</li> +<li><strong>delivery_mode</strong> – See <tt class="xref py py-attr docutils literal"><span class="pre">delivery_mode</span></tt>.</li> +<li><strong>mandatory</strong> – Currently not supported.</li> +<li><strong>immediate</strong> – Currently not supported.</li> +<li><strong>priority</strong> – Message priority. A number between 0 and 9.</li> +<li><strong>content_type</strong> – Content type. Default is auto-detect.</li> +<li><strong>content_encoding</strong> – Content encoding. Default is auto-detect.</li> +<li><strong>serializer</strong> – Serializer to use. Default is auto-detect.</li> +<li><strong>compression</strong> – Compression method to use. Default is none.</li> +<li><strong>headers</strong> – Mapping of arbitrary headers to pass along +with the message body.</li> +<li><strong>exchange</strong> – Override the exchange. Note that this exchange +must have been declared.</li> +<li><strong>declare</strong> – Optional list of required entities that must +have been declared before publishing the message. The entities +will be declared using <a class="reference internal" href="kombu.common.html#kombu.common.maybe_declare" title="kombu.common.maybe_declare"><tt class="xref py py-func docutils literal"><span class="pre">maybe_declare()</span></tt></a>.</li> +<li><strong>retry</strong> – Retry publishing, or declaring entities if the +connection is lost.</li> +<li><strong>retry_policy</strong> – Retry configuration, this is the keywords +supported by <tt class="xref py py-meth docutils literal"><span class="pre">ensure()</span></tt>.</li> +<li><strong>**properties</strong> – Additional message properties, see AMQP spec.</li> +</ul> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.release"> +<tt class="descname">release</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.release" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="kombu.pools.ProducerPool.Producer.revive"> +<tt class="descname">revive</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.revive" title="Permalink to this definition">¶</a></dt> +<dd><p>Revive the producer after connection loss.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.routing_key"> +<tt class="descname">routing_key</tt><em class="property"> = ''</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.routing_key" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="kombu.pools.ProducerPool.Producer.serializer"> +<tt class="descname">serializer</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.pools.ProducerPool.Producer.serializer" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + <dl class="method"> <dt id="kombu.pools.ProducerPool.create_producer"> -<tt class="descname">create_producer</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.create_producer" title="Permalink to this definition">¶</a></dt> +<tt class="descclassname">ProducerPool.</tt><tt class="descname">create_producer</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.create_producer" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="kombu.pools.ProducerPool.new"> -<tt class="descname">new</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.new" title="Permalink to this definition">¶</a></dt> +<tt class="descclassname">ProducerPool.</tt><tt class="descname">new</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.new" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="kombu.pools.ProducerPool.prepare"> -<tt class="descname">prepare</tt><big>(</big><em>p</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.prepare" title="Permalink to this definition">¶</a></dt> +<tt class="descclassname">ProducerPool.</tt><tt class="descname">prepare</tt><big>(</big><em>p</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.prepare" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="kombu.pools.ProducerPool.release"> -<tt class="descname">release</tt><big>(</big><em>resource</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.release" title="Permalink to this definition">¶</a></dt> +<tt class="descclassname">ProducerPool.</tt><tt class="descname">release</tt><big>(</big><em>resource</em><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.release" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="method"> <dt id="kombu.pools.ProducerPool.setup"> -<tt class="descname">setup</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.setup" title="Permalink to this definition">¶</a></dt> +<tt class="descclassname">ProducerPool.</tt><tt class="descname">setup</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.pools.ProducerPool.setup" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> @@ -206,13 +339,13 @@ <li class="right" > <a href="kombu.compression.html" title="kombu.compression" >previous</a> |</li> - <li><a href="../index.html">Kombu 2.1.3 documentation</a> »</li> + <li><a href="../index.html">Kombu 2.2.0rc2 documentation</a> »</li> <li><a href="index.html" >API Reference</a> »</li> </ul> </div> <div class="footer"> © Copyright 2009-2012, Ask Solem. - Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>
\ No newline at end of file |