| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>proton._condition — Qpid Proton Python API 0.32.0 documentation</title> |
| <link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/underscore.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/language_data.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| </head><body> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <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="nav-item nav-item-0"><a href="../../index.html">Qpid Proton Python API 0.32.0 documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">proton._condition</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <h1>Source code for proton._condition</h1><div class="highlight"><pre> |
| <span></span><span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| <span class="c1">#</span> |
| |
| <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">absolute_import</span> |
| |
| <span class="kn">from</span> <span class="nn">cproton</span> <span class="kn">import</span> <span class="n">pn_condition_clear</span><span class="p">,</span> <span class="n">pn_condition_set_name</span><span class="p">,</span> <span class="n">pn_condition_set_description</span><span class="p">,</span> <span class="n">pn_condition_info</span><span class="p">,</span> \ |
| <span class="n">pn_condition_is_set</span><span class="p">,</span> <span class="n">pn_condition_get_name</span><span class="p">,</span> <span class="n">pn_condition_get_description</span> |
| |
| <span class="kn">from</span> <span class="nn">._data</span> <span class="kn">import</span> <span class="n">Data</span><span class="p">,</span> <span class="n">dat2obj</span> |
| |
| |
| <div class="viewcode-block" id="Condition"><a class="viewcode-back" href="../../proton.html#proton.Condition">[docs]</a><span class="k">class</span> <span class="nc">Condition</span><span class="p">:</span> |
| <span class="sd">"""</span> |
| <span class="sd"> An AMQP Condition object. Conditions hold exception information</span> |
| <span class="sd"> pertaining to the closing of an AMQP endpoint such as a :class:`Connection`,</span> |
| <span class="sd"> :class:`Session`, or :class:`Link`. Conditions also hold similar information</span> |
| <span class="sd"> pertaining to deliveries that have reached terminal states.</span> |
| <span class="sd"> Connections, Sessions, Links, and Deliveries may all have local and</span> |
| <span class="sd"> remote conditions associated with them.</span> |
| |
| <span class="sd"> The local condition may be modified by the local endpoint to signal</span> |
| <span class="sd"> a particular condition to the remote peer. The remote condition may</span> |
| <span class="sd"> be examined by the local endpoint to detect whatever condition the</span> |
| <span class="sd"> remote peer may be signaling. Although often conditions are used to</span> |
| <span class="sd"> indicate errors, not all conditions are errors *per/se*, e.g.</span> |
| <span class="sd"> conditions may be used to redirect a connection from one host to</span> |
| <span class="sd"> another.</span> |
| |
| <span class="sd"> Every condition has a short symbolic name, a longer description,</span> |
| <span class="sd"> and an additional info map associated with it. The name identifies</span> |
| <span class="sd"> the formally defined condition, and the map contains additional</span> |
| <span class="sd"> information relevant to the identified condition.</span> |
| |
| <span class="sd"> :ivar ~.name: The name of the condition.</span> |
| <span class="sd"> :vartype ~.name: ``str``</span> |
| <span class="sd"> :ivar ~.description: A description of the condition.</span> |
| <span class="sd"> :vartype ~.description: ``str``</span> |
| <span class="sd"> :ivar ~.info: A data object that holds the additional information associated</span> |
| <span class="sd"> with the condition. The data object may be used both to access and to</span> |
| <span class="sd"> modify the additional information associated with the condition.</span> |
| <span class="sd"> :vartype ~.info: :class:`Data`</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">info</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="n">description</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">=</span> <span class="n">info</span> |
| |
| <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="s2">"Condition(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">repr</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> |
| <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">x</span><span class="p">])</span> |
| |
| <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">o</span><span class="p">,</span> <span class="n">Condition</span><span class="p">):</span> <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">o</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span> \ |
| <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">==</span> <span class="n">o</span><span class="o">.</span><span class="n">description</span> <span class="ow">and</span> \ |
| <span class="bp">self</span><span class="o">.</span><span class="n">info</span> <span class="o">==</span> <span class="n">o</span><span class="o">.</span><span class="n">info</span></div> |
| |
| |
| <span class="k">def</span> <span class="nf">obj2cond</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">cond</span><span class="p">):</span> |
| <span class="n">pn_condition_clear</span><span class="p">(</span><span class="n">cond</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">obj</span><span class="p">:</span> |
| <span class="n">pn_condition_set_name</span><span class="p">(</span><span class="n">cond</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">name</span><span class="p">))</span> |
| <span class="n">pn_condition_set_description</span><span class="p">(</span><span class="n">cond</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">description</span><span class="p">)</span> |
| <span class="n">info</span> <span class="o">=</span> <span class="n">Data</span><span class="p">(</span><span class="n">pn_condition_info</span><span class="p">(</span><span class="n">cond</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">obj</span><span class="o">.</span><span class="n">info</span><span class="p">:</span> |
| <span class="n">info</span><span class="o">.</span><span class="n">put_object</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">info</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span> <span class="nf">cond2obj</span><span class="p">(</span><span class="n">cond</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">pn_condition_is_set</span><span class="p">(</span><span class="n">cond</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">Condition</span><span class="p">(</span><span class="n">pn_condition_get_name</span><span class="p">(</span><span class="n">cond</span><span class="p">),</span> |
| <span class="n">pn_condition_get_description</span><span class="p">(</span><span class="n">cond</span><span class="p">),</span> |
| <span class="n">dat2obj</span><span class="p">(</span><span class="n">pn_condition_info</span><span class="p">(</span><span class="n">cond</span><span class="p">)))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| </pre></div> |
| |
| <div class="clearer"></div> |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3 id="searchlabel">Quick search</h3> |
| <div class="searchformwrapper"> |
| <form class="search" action="../../search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" /> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </div> |
| <script>$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../../genindex.html" title="General Index" |
| >index</a></li> |
| <li class="nav-item nav-item-0"><a href="../../index.html">Qpid Proton Python API 0.32.0 documentation</a> »</li> |
| <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">proton._condition</a></li> |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2019, Apache Qpid Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1. |
| </div> |
| </body> |
| </html> |
