Added: qpid/site/input/releases/qpid-proton-master/proton/python/book/overview.html URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-proton-master/proton/python/book/overview.html?rev=1705923&view=auto ============================================================================== --- qpid/site/input/releases/qpid-proton-master/proton/python/book/overview.html (added) +++ qpid/site/input/releases/qpid-proton-master/proton/python/book/overview.html Tue Sep 29 20:27:56 2015 @@ -0,0 +1,904 @@ +<!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>API Overview — Apache Qpid Proton 0.10 documentation</title> + + <link rel="stylesheet" href="_static/sphinxdoc.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.10', + 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="Apache Qpid Proton 0.10 documentation" href="index.html" /> + <link rel="prev" title="Tutorial" href="tutorial.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="tutorial.html" title="Tutorial" + accesskey="P">previous</a> |</li> + <li><a href="index.html">Apache Qpid Proton 0.10 documentation</a> »</li> + </ul> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">API Overview</a><ul> +<li><a class="reference internal" href="#an-overview-of-the-model">An overview of the model</a></li> +<li><a class="reference internal" href="#a-summary-of-the-most-commonly-used-classes-and-members">A summary of the most commonly used classes and members</a></li> +<li><a class="reference internal" href="#delivery-guarantees">Delivery guarantees</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="tutorial.html" + title="previous chapter">Tutorial</a></p> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="_sources/overview.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" /> + <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="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="api-overview"> +<h1>API Overview<a class="headerlink" href="#api-overview" title="Permalink to this headline">¶</a></h1> +<div class="section" id="an-overview-of-the-model"> +<h2>An overview of the model<a class="headerlink" href="#an-overview-of-the-model" title="Permalink to this headline">¶</a></h2> +<p>Messages are transferred between connected peers over ‘links’. At the +sending peer the link is called a sender. At the receiving peer it is +called a receiver. Messages are sent by senders and received by +receivers. Links may have named ‘source’ and ‘target’ addresses (for +example to identify the queue from which message were to be received +or to which they were to be sent).</p> +<p>Links are established over sessions. Sessions are established over +connections. Connections are (generally) established between two +uniquely identified containers. Though a connection can have multiple +sessions, often this is not needed. The container API allows you to +ignore sessions unless you actually require them.</p> +<p>The sending of a message over a link is called a delivery. The message +is the content sent, including all meta-data such as headers and +annotations. The delivery is the protocol exchange associated with the +transfer of that content.</p> +<p>To indicate that a delivery is complete, either the sender or the +receiver ‘settles’ it. When the other side learns that it has been +settled, they will no longer communicate about that delivery. The +receiver can also indicate whether they accept or reject the +message.</p> +<p>Three different delivery levels or ‘guarantees’ can be achieved: +at-most-once, at-least-once or exactly-once. See +<a class="reference internal" href="#delivery-guarantees"><em>Delivery guarantees</em></a> for more detail.</p> +</div> +<div class="section" id="a-summary-of-the-most-commonly-used-classes-and-members"> +<h2>A summary of the most commonly used classes and members<a class="headerlink" href="#a-summary-of-the-most-commonly-used-classes-and-members" title="Permalink to this headline">¶</a></h2> +<p>A brief summary of some of the key classes follows.</p> +<p>The <a class="reference internal" href="#proton.reactor.Container" title="proton.reactor.Container"><tt class="xref py py-class docutils literal"><span class="pre">Container</span></tt></a> class is a convenient entry +point into the API, allowing connections and links to be +established. Applications are structured as one or more event +handlers. Handlers can be set at Container, Connection, or Link +scope. Messages are sent by establishing an approprate sender and +invoking its <a class="reference internal" href="#proton.Sender.send" title="proton.Sender.send"><tt class="xref py py-meth docutils literal"><span class="pre">send()</span></tt></a> method. This is +typically done when the sender is sendable, a condition indicated by +the <a class="reference internal" href="#proton.handlers.MessagingHandler.on_sendable" title="proton.handlers.MessagingHandler.on_sendable"><tt class="xref py py-meth docutils literal"><span class="pre">on_sendable()</span></tt></a> event, to +avoid execessive build up of messages. Messages can be received by +establishing an appropriate receiver and handling the +<a class="reference internal" href="#proton.handlers.MessagingHandler.on_message" title="proton.handlers.MessagingHandler.on_message"><tt class="xref py py-meth docutils literal"><span class="pre">on_message()</span></tt></a> event.</p> +<dl class="class"> +<dt id="proton.reactor.Container"> +<em class="property">class </em><tt class="descclassname">proton.reactor.</tt><tt class="descname">Container</tt><big>(</big><em>*handlers</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#proton.reactor.Container" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">proton.reactor.Reactor</span></tt></p> +<p>A representation of the AMQP concept of a ‘container’, which +lossely speaking is something that establishes links to or from +another container, over which messages are transfered. This is +an extension to the Reactor class that adds convenience methods +for creating connections and sender- or receiver- links.</p> +<dl class="attribute"> +<dt id="Container.container_id"> +<tt class="descname">container_id</tt><a class="headerlink" href="#Container.container_id" title="Permalink to this definition">¶</a></dt> +<dd><p>The identifier used to identify this container in any +connections it establishes. Container names should be +unique. By default a UUID will be used.</p> +</dd></dl> + +<p>The <a class="reference internal" href="#proton.reactor.Container.connect" title="proton.reactor.Container.connect"><tt class="xref py py-meth docutils literal"><span class="pre">connect()</span></tt></a> method returns +an instance of <a class="reference internal" href="#proton.Connection" title="proton.Connection"><tt class="xref py py-class docutils literal"><span class="pre">Connection</span></tt></a>, the +<a class="reference internal" href="#proton.reactor.Container.create_receiver" title="proton.reactor.Container.create_receiver"><tt class="xref py py-meth docutils literal"><span class="pre">create_receiver()</span></tt></a> method +returns an instance of <a class="reference internal" href="#proton.Receiver" title="proton.Receiver"><tt class="xref py py-class docutils literal"><span class="pre">Receiver</span></tt></a> and the +<a class="reference internal" href="#proton.reactor.Container.create_sender" title="proton.reactor.Container.create_sender"><tt class="xref py py-meth docutils literal"><span class="pre">create_sender()</span></tt></a> method +returns an instance of <a class="reference internal" href="#proton.Sender" title="proton.Sender"><tt class="xref py py-class docutils literal"><span class="pre">Sender</span></tt></a>.</p> +<dl class="method"> +<dt id="proton.reactor.Container.connect"> +<tt class="descname">connect</tt><big>(</big><em>url=None</em>, <em>urls=None</em>, <em>address=None</em>, <em>handler=None</em>, <em>reconnect=None</em>, <em>heartbeat=None</em>, <em>ssl_domain=None</em><big>)</big><a class="headerlink" href="#proton.reactor.Container.connect" title="Permalink to this definition">¶</a></dt> +<dd><p>Initiates the establishment of an AMQP connection. Returns an +instance of proton.Connection.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.reactor.Container.create_receiver"> +<tt class="descname">create_receiver</tt><big>(</big><em>context</em>, <em>source=None</em>, <em>target=None</em>, <em>name=None</em>, <em>dynamic=False</em>, <em>handler=None</em>, <em>options=None</em><big>)</big><a class="headerlink" href="#proton.reactor.Container.create_receiver" title="Permalink to this definition">¶</a></dt> +<dd><p>Initiates the establishment of a link over which messages can +be received (aka a subscription). Returns an instance of +proton.Receiver.</p> +<p>There are two patterns of use. (1) A connection can be passed +as the first argument, in which case the link is established +on that connection. In this case the source address can be +specified as the second argument (or as a keyword +argument). The target address can also be specified if +desired. (2) Alternatively a URL can be passed as the first +argument. In this case a new connection will be establised on +which the link will be attached. If a path is specified and +the source is not, then the path of the URL is used as the +target address.</p> +<p>The name of the link may be specified if desired, otherwise a +unique name will be generated.</p> +<p>Various LinkOptions can be specified to further control the +attachment.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.reactor.Container.create_sender"> +<tt class="descname">create_sender</tt><big>(</big><em>context</em>, <em>target=None</em>, <em>source=None</em>, <em>name=None</em>, <em>handler=None</em>, <em>tags=None</em>, <em>options=None</em><big>)</big><a class="headerlink" href="#proton.reactor.Container.create_sender" title="Permalink to this definition">¶</a></dt> +<dd><p>Initiates the establishment of a link over which messages can +be sent. Returns an instance of proton.Sender.</p> +<p>There are two patterns of use. (1) A connection can be passed +as the first argument, in which case the link is established +on that connection. In this case the target address can be +specified as the second argument (or as a keyword +argument). The source address can also be specified if +desired. (2) Alternatively a URL can be passed as the first +argument. In this case a new connection will be establised on +which the link will be attached. If a path is specified and +the target is not, then the path of the URL is used as the +target address.</p> +<p>The name of the link may be specified if desired, otherwise a +unique name will be generated.</p> +<p>Various LinkOptions can be specified to further control the +attachment.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.reactor.Container.run"> +<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.reactor.Container.run" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="proton.reactor.Container.schedule"> +<tt class="descname">schedule</tt><big>(</big><em>delay</em>, <em>task</em><big>)</big><a class="headerlink" href="#proton.reactor.Container.schedule" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Connection"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Connection</tt><big>(</big><em>impl=<built-in function pn_connection></em><big>)</big><a class="headerlink" href="#proton.Connection" title="Permalink to this definition">¶</a></dt> +<dd><p>A representation of an AMQP connection</p> +<dl class="method"> +<dt id="proton.Connection.close"> +<tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Connection.close" title="Permalink to this definition">¶</a></dt> +<dd><p>Closes the connection.</p> +<p>In more detail, this moves the local state of the connection to +the CLOSED state and triggers a close frame to be sent to the +peer. A connection is fully closed once both peers have closed it.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.container"> +<tt class="descname">container</tt><a class="headerlink" href="#proton.Connection.container" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.hostname"> +<tt class="descname">hostname</tt><a class="headerlink" href="#proton.Connection.hostname" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="proton.Connection.open"> +<tt class="descname">open</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Connection.open" title="Permalink to this definition">¶</a></dt> +<dd><p>Opens the connection.</p> +<p>In more detail, this moves the local state of the connection to +the ACTIVE state and triggers an open frame to be sent to the +peer. A connection is fully active once both peers have opened it.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.remote_container"> +<tt class="descname">remote_container</tt><a class="headerlink" href="#proton.Connection.remote_container" title="Permalink to this definition">¶</a></dt> +<dd><p>The container identifier specified by the remote peer for this connection.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.remote_desired_capabilities"> +<tt class="descname">remote_desired_capabilities</tt><a class="headerlink" href="#proton.Connection.remote_desired_capabilities" title="Permalink to this definition">¶</a></dt> +<dd><p>The capabilities desired by the remote peer for this connection.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.remote_hostname"> +<tt class="descname">remote_hostname</tt><a class="headerlink" href="#proton.Connection.remote_hostname" title="Permalink to this definition">¶</a></dt> +<dd><p>The hostname specified by the remote peer for this connection.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.remote_offered_capabilities"> +<tt class="descname">remote_offered_capabilities</tt><a class="headerlink" href="#proton.Connection.remote_offered_capabilities" title="Permalink to this definition">¶</a></dt> +<dd><p>The capabilities offered by the remote peer for this connection.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.remote_properties"> +<tt class="descname">remote_properties</tt><a class="headerlink" href="#proton.Connection.remote_properties" title="Permalink to this definition">¶</a></dt> +<dd><p>The properties specified by the remote peer for this connection.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Connection.session"> +<tt class="descname">session</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Connection.session" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns a new session on this connection.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Connection.state"> +<tt class="descname">state</tt><a class="headerlink" href="#proton.Connection.state" title="Permalink to this definition">¶</a></dt> +<dd><p>The state of the connection as a bit field. The state has a local +and a remote component. Each of these can be in one of three +states: UNINIT, ACTIVE or CLOSED. These can be tested by masking +against LOCAL_UNINIT, LOCAL_ACTIVE, LOCAL_CLOSED, REMOTE_UNINIT, +REMOTE_ACTIVE and REMOTE_CLOSED.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Receiver"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Receiver</tt><big>(</big><em>impl</em><big>)</big><a class="headerlink" href="#proton.Receiver" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#proton.Link" title="proton.Link"><tt class="xref py py-class docutils literal"><span class="pre">proton.Link</span></tt></a></p> +<p>A link over which messages are received.</p> +<dl class="method"> +<dt id="proton.Receiver.drain"> +<tt class="descname">drain</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#proton.Receiver.drain" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="proton.Receiver.draining"> +<tt class="descname">draining</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Receiver.draining" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="proton.Receiver.flow"> +<tt class="descname">flow</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#proton.Receiver.flow" title="Permalink to this definition">¶</a></dt> +<dd><p>Increases the credit issued to the remote sender by the specified number of messages.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Receiver.recv"> +<tt class="descname">recv</tt><big>(</big><em>limit</em><big>)</big><a class="headerlink" href="#proton.Receiver.recv" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Sender"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Sender</tt><big>(</big><em>impl</em><big>)</big><a class="headerlink" href="#proton.Sender" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <a class="reference internal" href="#proton.Link" title="proton.Link"><tt class="xref py py-class docutils literal"><span class="pre">proton.Link</span></tt></a></p> +<p>A link over which messages are sent.</p> +<dl class="method"> +<dt id="proton.Sender.offered"> +<tt class="descname">offered</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#proton.Sender.offered" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="method"> +<dt id="proton.Sender.send"> +<tt class="descname">send</tt><big>(</big><em>obj</em>, <em>tag=None</em><big>)</big><a class="headerlink" href="#proton.Sender.send" title="Permalink to this definition">¶</a></dt> +<dd><p>Send specified object over this sender; the object is expected to +have a send() method on it that takes the sender and an optional +tag as arguments.</p> +<p>Where the object is a Message, this will send the message over +this link, creating a new delivery for the purpose.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Link"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Link</tt><big>(</big><em>impl</em><big>)</big><a class="headerlink" href="#proton.Link" title="Permalink to this definition">¶</a></dt> +<dd><p>A representation of an AMQP link, of which there are two concrete +implementations, Sender and Receiver.</p> +<p>The <a class="reference internal" href="#proton.Link.source" title="proton.Link.source"><tt class="xref py py-meth docutils literal"><span class="pre">source()</span></tt></a>, +<a class="reference internal" href="#proton.Link.target" title="proton.Link.target"><tt class="xref py py-meth docutils literal"><span class="pre">target()</span></tt></a>, +<a class="reference internal" href="#proton.Link.remote_source" title="proton.Link.remote_source"><tt class="xref py py-meth docutils literal"><span class="pre">remote_source()</span></tt></a> and +<a class="reference internal" href="#proton.Link.remote_target" title="proton.Link.remote_target"><tt class="xref py py-meth docutils literal"><span class="pre">remote_target()</span></tt></a> methods all return an +instance of <a class="reference internal" href="#proton.Terminus" title="proton.Terminus"><tt class="xref py py-class docutils literal"><span class="pre">Terminus</span></tt></a>.</p> +<dl class="attribute"> +<dt id="proton.Link.connection"> +<tt class="descname">connection</tt><a class="headerlink" href="#proton.Link.connection" title="Permalink to this definition">¶</a></dt> +<dd><p>The connection on which this link was attached.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.credit"> +<tt class="descname">credit</tt><a class="headerlink" href="#proton.Link.credit" title="Permalink to this definition">¶</a></dt> +<dd><p>The amount of oustanding credit on this link.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.is_receiver"> +<tt class="descname">is_receiver</tt><a class="headerlink" href="#proton.Link.is_receiver" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true if this link is a receiver.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.is_sender"> +<tt class="descname">is_sender</tt><a class="headerlink" href="#proton.Link.is_sender" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true if this link is a sender.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.name"> +<tt class="descname">name</tt><a class="headerlink" href="#proton.Link.name" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the name of the link</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.queued"> +<tt class="descname">queued</tt><a class="headerlink" href="#proton.Link.queued" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.remote_source"> +<tt class="descname">remote_source</tt><a class="headerlink" href="#proton.Link.remote_source" title="Permalink to this definition">¶</a></dt> +<dd><p>The source of the link as described by the remote peer.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.remote_target"> +<tt class="descname">remote_target</tt><a class="headerlink" href="#proton.Link.remote_target" title="Permalink to this definition">¶</a></dt> +<dd><p>The target of the link as described by the remote peer.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.session"> +<tt class="descname">session</tt><a class="headerlink" href="#proton.Link.session" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.source"> +<tt class="descname">source</tt><a class="headerlink" href="#proton.Link.source" title="Permalink to this definition">¶</a></dt> +<dd><p>The source of the link as described by the local peer.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.state"> +<tt class="descname">state</tt><a class="headerlink" href="#proton.Link.state" title="Permalink to this definition">¶</a></dt> +<dd><p>The state of the link as a bit field. The state has a local +and a remote component. Each of these can be in one of three +states: UNINIT, ACTIVE or CLOSED. These can be tested by masking +against LOCAL_UNINIT, LOCAL_ACTIVE, LOCAL_CLOSED, REMOTE_UNINIT, +REMOTE_ACTIVE and REMOTE_CLOSED.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Link.target"> +<tt class="descname">target</tt><a class="headerlink" href="#proton.Link.target" title="Permalink to this definition">¶</a></dt> +<dd><p>The target of the link as described by the local peer.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Delivery"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Delivery</tt><big>(</big><em>impl</em><big>)</big><a class="headerlink" href="#proton.Delivery" title="Permalink to this definition">¶</a></dt> +<dd><p>Tracks and/or records the delivery of a message over a link.</p> +<dl class="attribute"> +<dt id="proton.Delivery.connection"> +<tt class="descname">connection</tt><a class="headerlink" href="#proton.Delivery.connection" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the connection over which the delivery was sent or received.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.link"> +<tt class="descname">link</tt><a class="headerlink" href="#proton.Delivery.link" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the link on which the delivery was sent or received.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.local_state"> +<tt class="descname">local_state</tt><a class="headerlink" href="#proton.Delivery.local_state" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the local state of the delivery.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.partial"> +<tt class="descname">partial</tt><a class="headerlink" href="#proton.Delivery.partial" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true for an incoming delivery if not all the data is +yet available.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.readable"> +<tt class="descname">readable</tt><a class="headerlink" href="#proton.Delivery.readable" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true for an incoming delivery that has data to read.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.remote_state"> +<tt class="descname">remote_state</tt><a class="headerlink" href="#proton.Delivery.remote_state" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the state of the delivery as indicated by the remote +peer.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.session"> +<tt class="descname">session</tt><a class="headerlink" href="#proton.Delivery.session" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the session over which the delivery was sent or received.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Delivery.settle"> +<tt class="descname">settle</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Delivery.settle" title="Permalink to this definition">¶</a></dt> +<dd><p>Settles the delivery locally. This indicates the aplication +considers the delivery complete and does not wish to receive any +further events about it. Every delivery should be settled locally.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.settled"> +<tt class="descname">settled</tt><a class="headerlink" href="#proton.Delivery.settled" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true if the delivery has been settled by the remote peer.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Delivery.update"> +<tt class="descname">update</tt><big>(</big><em>state</em><big>)</big><a class="headerlink" href="#proton.Delivery.update" title="Permalink to this definition">¶</a></dt> +<dd><p>Set the local state of the delivery e.g. ACCEPTED, REJECTED, RELEASED.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Delivery.writable"> +<tt class="descname">writable</tt><a class="headerlink" href="#proton.Delivery.writable" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns true for an outgoing delivery to which data can now be written.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.handlers.MessagingHandler"> +<em class="property">class </em><tt class="descclassname">proton.handlers.</tt><tt class="descname">MessagingHandler</tt><big>(</big><em>prefetch=10</em>, <em>auto_accept=True</em>, <em>auto_settle=True</em>, <em>peer_close_is_error=False</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler" title="Permalink to this definition">¶</a></dt> +<dd><p>A general purpose handler that makes the proton-c events somewhat +simpler to deal with and/or avoids repetitive tasks for common use +cases.</p> +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.accept"> +<tt class="descname">accept</tt><big>(</big><em>delivery</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.accept" title="Permalink to this definition">¶</a></dt> +<dd><p>Accepts a received message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_accepted"> +<tt class="descname">on_accepted</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_accepted" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the remote peer accepts an outgoing message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_connection_error"> +<tt class="descname">on_connection_error</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_connection_error" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the peer closes the connection with an error condition.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_disconnected"> +<tt class="descname">on_disconnected</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_disconnected" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the socket is disconnected.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_link_error"> +<tt class="descname">on_link_error</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_link_error" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the peer closes the link with an error condition.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_message"> +<tt class="descname">on_message</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_message" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when a message is received. The message itself can be +obtained as a property on the event. For the purpose of +refering to this message in further actions (e.g. if +explicitly accepting it, the <tt class="docutils literal"><span class="pre">delivery</span></tt> should be used, also +obtainable via a property on the event.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_reactor_init"> +<tt class="descname">on_reactor_init</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_reactor_init" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the event loop - the reactor - starts.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_rejected"> +<tt class="descname">on_rejected</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_rejected" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the remote peer rejects an outgoing message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_sendable"> +<tt class="descname">on_sendable</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_sendable" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the sender link has credit and messages can +therefore be transferred.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_session_error"> +<tt class="descname">on_session_error</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_session_error" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the peer closes the session with an error condition.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_settled"> +<tt class="descname">on_settled</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_settled" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the remote peer has settled the outgoing +message. This is the point at which it shouod never be +retransmitted.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.on_start"> +<tt class="descname">on_start</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.on_start" title="Permalink to this definition">¶</a></dt> +<dd><p>Called when the event loop starts. (Just an alias for on_reactor_init)</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.reject"> +<tt class="descname">reject</tt><big>(</big><em>delivery</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.reject" title="Permalink to this definition">¶</a></dt> +<dd><p>Rejects a received message that is considered invalid or +unprocessable.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.release"> +<tt class="descname">release</tt><big>(</big><em>delivery</em>, <em>delivered=True</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.release" title="Permalink to this definition">¶</a></dt> +<dd><p>Releases a received message, making it available at the source +for any (other) interested receiver. The <tt class="docutils literal"><span class="pre">delivered</span></tt> +parameter indicates whether this should be considered a +delivery attempt (and the delivery count updated) or not.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.handlers.MessagingHandler.settle"> +<tt class="descname">settle</tt><big>(</big><em>delivery</em>, <em>state=None</em><big>)</big><a class="headerlink" href="#proton.handlers.MessagingHandler.settle" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Event"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Event</tt><big>(</big><em>impl</em>, <em>number</em><big>)</big><a class="headerlink" href="#proton.Event" title="Permalink to this definition">¶</a></dt> +<dd><dl class="attribute"> +<dt id="proton.Event.connection"> +<tt class="descname">connection</tt><a class="headerlink" href="#proton.Event.connection" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the connection associated with the event, or null if none is associated with it.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.context"> +<tt class="descname">context</tt><a class="headerlink" href="#proton.Event.context" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the context object associated with the event. The type of this depend on the type of event.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.delivery"> +<tt class="descname">delivery</tt><a class="headerlink" href="#proton.Event.delivery" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the delivery associated with the event, or null if none is associated with it.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.link"> +<tt class="descname">link</tt><a class="headerlink" href="#proton.Event.link" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the link associated with the event, or null if none is associated with it.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.reactor"> +<tt class="descname">reactor</tt><a class="headerlink" href="#proton.Event.reactor" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the reactor associated with the event.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.receiver"> +<tt class="descname">receiver</tt><a class="headerlink" href="#proton.Event.receiver" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the receiver link associated with the event, or null if +none is associated with it. This is essentially an alias for +link(), that does an additional checkon the type of the link.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.sender"> +<tt class="descname">sender</tt><a class="headerlink" href="#proton.Event.sender" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the sender link associated with the event, or null if +none is associated with it. This is essentially an alias for +link(), that does an additional checkon the type of the +link.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Event.session"> +<tt class="descname">session</tt><a class="headerlink" href="#proton.Event.session" title="Permalink to this definition">¶</a></dt> +<dd><p>Returns the session associated with the event, or null if none is associated with it.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Message"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Message</tt><big>(</big><em>body=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#proton.Message" title="Permalink to this definition">¶</a></dt> +<dd><p>The L{Message} class is a mutable holder of message content.</p> +<p>@ivar instructions: delivery instructions for the message +@type instructions: dict +@ivar annotations: infrastructure defined message annotations +@type annotations: dict +@ivar properties: application defined message properties +@type properties: dict +@ivar body: message body +@type body: bytes | unicode | dict | list | int | long | float | UUID</p> +<dl class="attribute"> +<dt id="proton.Message.address"> +<tt class="descname">address</tt><a class="headerlink" href="#proton.Message.address" title="Permalink to this definition">¶</a></dt> +<dd><p>The address of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.content_encoding"> +<tt class="descname">content_encoding</tt><a class="headerlink" href="#proton.Message.content_encoding" title="Permalink to this definition">¶</a></dt> +<dd><p>The content-encoding of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.content_type"> +<tt class="descname">content_type</tt><a class="headerlink" href="#proton.Message.content_type" title="Permalink to this definition">¶</a></dt> +<dd><p>The content-type of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.correlation_id"> +<tt class="descname">correlation_id</tt><a class="headerlink" href="#proton.Message.correlation_id" title="Permalink to this definition">¶</a></dt> +<dd><p>The correlation-id for the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.creation_time"> +<tt class="descname">creation_time</tt><a class="headerlink" href="#proton.Message.creation_time" title="Permalink to this definition">¶</a></dt> +<dd><p>The creation time of the message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Message.decode"> +<tt class="descname">decode</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#proton.Message.decode" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.delivery_count"> +<tt class="descname">delivery_count</tt><a class="headerlink" href="#proton.Message.delivery_count" title="Permalink to this definition">¶</a></dt> +<dd><p>The number of delivery attempts made for this message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.durable"> +<tt class="descname">durable</tt><a class="headerlink" href="#proton.Message.durable" title="Permalink to this definition">¶</a></dt> +<dd><p>The durable property indicates that the message should be held durably +by any intermediaries taking responsibility for the message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Message.encode"> +<tt class="descname">encode</tt><big>(</big><big>)</big><a class="headerlink" href="#proton.Message.encode" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.expiry_time"> +<tt class="descname">expiry_time</tt><a class="headerlink" href="#proton.Message.expiry_time" title="Permalink to this definition">¶</a></dt> +<dd><p>The expiry time of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.first_acquirer"> +<tt class="descname">first_acquirer</tt><a class="headerlink" href="#proton.Message.first_acquirer" title="Permalink to this definition">¶</a></dt> +<dd><p>True iff the recipient is the first to acquire the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.group_id"> +<tt class="descname">group_id</tt><a class="headerlink" href="#proton.Message.group_id" title="Permalink to this definition">¶</a></dt> +<dd><p>The group id of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.group_sequence"> +<tt class="descname">group_sequence</tt><a class="headerlink" href="#proton.Message.group_sequence" title="Permalink to this definition">¶</a></dt> +<dd><p>The sequence of the message within its group.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.id"> +<tt class="descname">id</tt><a class="headerlink" href="#proton.Message.id" title="Permalink to this definition">¶</a></dt> +<dd><p>The id of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.priority"> +<tt class="descname">priority</tt><a class="headerlink" href="#proton.Message.priority" title="Permalink to this definition">¶</a></dt> +<dd><p>The priority of the message.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Message.recv"> +<tt class="descname">recv</tt><big>(</big><em>link</em><big>)</big><a class="headerlink" href="#proton.Message.recv" title="Permalink to this definition">¶</a></dt> +<dd><p>Receives and decodes the message content for the current delivery +from the link. Upon success it will return the current delivery +for the link. If there is no current delivery, or if the current +delivery is incomplete, or if the link is not a receiver, it will +return None.</p> +<p>@type link: Link +@param link: the link to receive a message from +@return the delivery associated with the decoded message (or None)</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.reply_to"> +<tt class="descname">reply_to</tt><a class="headerlink" href="#proton.Message.reply_to" title="Permalink to this definition">¶</a></dt> +<dd><p>The reply-to address for the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.reply_to_group_id"> +<tt class="descname">reply_to_group_id</tt><a class="headerlink" href="#proton.Message.reply_to_group_id" title="Permalink to this definition">¶</a></dt> +<dd><p>The group-id for any replies.</p> +</dd></dl> + +<dl class="method"> +<dt id="proton.Message.send"> +<tt class="descname">send</tt><big>(</big><em>sender</em>, <em>tag=None</em><big>)</big><a class="headerlink" href="#proton.Message.send" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.subject"> +<tt class="descname">subject</tt><a class="headerlink" href="#proton.Message.subject" title="Permalink to this definition">¶</a></dt> +<dd><p>The subject of the message.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.ttl"> +<tt class="descname">ttl</tt><a class="headerlink" href="#proton.Message.ttl" title="Permalink to this definition">¶</a></dt> +<dd><p>The time to live of the message measured in seconds. Expired messages +may be dropped.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Message.user_id"> +<tt class="descname">user_id</tt><a class="headerlink" href="#proton.Message.user_id" title="Permalink to this definition">¶</a></dt> +<dd><p>The user id of the message creator.</p> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="proton.Terminus"> +<em class="property">class </em><tt class="descclassname">proton.</tt><tt class="descname">Terminus</tt><big>(</big><em>impl</em><big>)</big><a class="headerlink" href="#proton.Terminus" title="Permalink to this definition">¶</a></dt> +<dd><dl class="attribute"> +<dt id="proton.Terminus.address"> +<tt class="descname">address</tt><a class="headerlink" href="#proton.Terminus.address" title="Permalink to this definition">¶</a></dt> +<dd><p>The address that identifies the source or target node</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Terminus.capabilities"> +<tt class="descname">capabilities</tt><a class="headerlink" href="#proton.Terminus.capabilities" title="Permalink to this definition">¶</a></dt> +<dd><p>Capabilities of the source or target.</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Terminus.dynamic"> +<tt class="descname">dynamic</tt><a class="headerlink" href="#proton.Terminus.dynamic" title="Permalink to this definition">¶</a></dt> +<dd><p>Indicates whether the source or target node was dynamically +created</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Terminus.filter"> +<tt class="descname">filter</tt><a class="headerlink" href="#proton.Terminus.filter" title="Permalink to this definition">¶</a></dt> +<dd><p>A filter on a source allows the set of messages transfered over +the link to be restricted</p> +</dd></dl> + +<dl class="attribute"> +<dt id="proton.Terminus.properties"> +<tt class="descname">properties</tt><a class="headerlink" href="#proton.Terminus.properties" title="Permalink to this definition">¶</a></dt> +<dd><p>Properties of a dynamic source or target.</p> +</dd></dl> + +</dd></dl> + +</div> +<div class="section" id="delivery-guarantees"> +<span id="id1"></span><h2>Delivery guarantees<a class="headerlink" href="#delivery-guarantees" title="Permalink to this headline">¶</a></h2> +<p>For at-most-once, the sender settles the message as soon as it sends +it. If the connection is lost before the message is received by the +receiver, the message will not be delivered.</p> +<p>For at-least-once, the receiver accepts and settles the message on +receipt. If the connection is lost before the sender is informed of +the settlement, then the delivery is considered in-doubt and should be +retried. This will ensure it eventually gets delivered (provided of +course the connection and link can be reestablished). It may mean that +it is delivered multiple times though.</p> +<p>Finally, for exactly-once, the receiver accepts the message but +doesn’t settle it. The sender settles once it is aware that the +receiver accepted it. In this way the receiver retains knowledge of an +accepted message until it is sure the sender knows it has been +accepted. If the connection is lost before settlement, the receiver +informs the sender of all the unsettled deliveries it knows about, and +from this the sender can deduce which need to be redelivered. The +sender likewise informs the receiver which deliveries it knows about, +from which the receiver can deduce which have already been settled.</p> +</div> +</div> + + + </div> + </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="tutorial.html" title="Tutorial" + >previous</a> |</li> + <li><a href="index.html">Apache Qpid Proton 0.10 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2015, Apache Qpid. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.3. + </div> + </body> +</html> \ No newline at end of file
Added: qpid/site/input/releases/qpid-proton-master/proton/python/book/search.html URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-proton-master/proton/python/book/search.html?rev=1705923&view=auto ============================================================================== --- qpid/site/input/releases/qpid-proton-master/proton/python/book/search.html (added) +++ qpid/site/input/releases/qpid-proton-master/proton/python/book/search.html Tue Sep 29 20:27:56 2015 @@ -0,0 +1,99 @@ +<!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>Search — Apache Qpid Proton 0.10 documentation</title> + + <link rel="stylesheet" href="_static/sphinxdoc.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.10', + 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> + <script type="text/javascript" src="_static/searchtools.js"></script> + <link rel="top" title="Apache Qpid Proton 0.10 documentation" href="index.html" /> + <script type="text/javascript"> + jQuery(function() { Search.loadIndex("searchindex.js"); }); + </script> + + <script type="text/javascript" id="searchindexloader"></script> + + + </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><a href="index.html">Apache Qpid Proton 0.10 documentation</a> »</li> + </ul> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + </div> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <h1 id="search-documentation">Search</h1> + <div id="fallback" class="admonition warning"> + <script type="text/javascript">$('#fallback').hide();</script> + <p> + Please activate JavaScript to enable the search + functionality. + </p> + </div> + <p> + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. + </p> + <form action="" method="get"> + <input type="text" name="q" value="" /> + <input type="submit" value="search" /> + <span id="search-progress" style="padding-left: 10px"></span> + </form> + + <div id="search-results"> + + </div> + + </div> + </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><a href="index.html">Apache Qpid Proton 0.10 documentation</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2015, Apache Qpid. + Created using <a href="http://sphinx-doc.org/";>Sphinx</a> 1.2.3. + </div> + </body> +</html> \ No newline at end of file Added: qpid/site/input/releases/qpid-proton-master/proton/python/book/searchindex.js URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-proton-master/proton/python/book/searchindex.js?rev=1705923&view=auto ============================================================================== --- qpid/site/input/releases/qpid-proton-master/proton/python/book/searchindex.js (added) +++ qpid/site/input/releases/qpid-proton-master/proton/python/book/searchindex.js Tue Sep 29 20:27:56 2015 @@ -0,0 +1 @@ +Search.setIndex({envversion:42,terms:{represent:2,all:[2,1],concept:2,partial:2,local_act:2,illustr:1,remote_act:2,consum:1,correl:2,abil:1,follow:[2,1],settlement:2,hold:1,depend:2,incas:1,readabl:2,send:[0,2],concret:2,sent:[2,1],sourc:[2,1],everi:2,fals:2,on_messag:[2,1],util:1,mechan:1,veri:1,implicitli:1,brows:1,implement:[2,1],level:2,did:1,list:[2,1],helloworld:1,ssl_domain:2,"try":1,prevent:1,properti:2,direct:0,uniqu:[2,1],slithi:1,second:[2,1],pass:[2,1],further:[2,1],port:1,rath:1,repli:[2,1],abl:1,brief:2,current:2,version:1,remote_sourc:[2,1],method:[2,1],deduc:2,essenc:1,first_acquir:2,doubt:[2,1],gener:[2,1],never:2,here:1,bodi:[2,1],let:1,address:[2,1],path:2,modifi:1,sinc:1,valu:1,acceptor:1,convert:1,sender:[2,1],queue:[2,1],credit:[2,1],amount:2,action:2,typic:2,commonli:0,via:[2,1],api:0,total:1,establish:[2,1],on_connection_open:1,is_send:[2,1],twa:1,from:[2,1],describ:[2,1],commun:[2,1],two:[2,1],next:1,live:2,handler:[2,1],call:[2,1],establis:2,msg:1,scope:2,s impler:2,type:[2,1],until:[2,1],more:[2,1],sort:1,auto_settl:2,desir:[2,1],toolkit:1,appropr:2,indic:[2,1],relai:1,remote_uninit:2,known:1,actual:[2,1],given:1,cach:1,content_typ:2,dictat:1,none:[2,1],alia:2,prepar:1,work:1,annot:2,kwarg:2,can:[2,1],learn:2,purpos:[2,1],def:1,control:[2,1],remote_target:[2,1],give:1,process:1,accept:[2,1],topic:1,tag:2,want:1,occur:1,delai:2,print_funct:1,remote_hostnam:2,multipl:2,rather:1,anoth:[2,1],how:1,"__init__":1,reject:2,instead:1,reestablish:2,simpl:1,updat:2,after:1,invok:[2,1],reflect:1,befor:[2,1],on_connection_error:2,cours:[2,1],heartbeat:2,mai:[2,1],associ:[2,1],demonstr:1,alloc:1,unsettl:2,correspond:1,issu:2,callback:1,"switch":1,green:1,allow:[2,1],enter:1,order:1,local_uninit:2,elif:1,help:1,over:[2,1],move:[2,1],soon:2,execess:2,through:1,reconnect:[2,1],ttl:2,flexibl:1,reply_to_group_id:2,dynam:[2,1],paramet:2,style:1,disconnect:[2,1],uuid:2,borogrov:1,unicode_liter:1,infrastructur:2,exchang:2,therefor:2,easier:1,them:[2,1],"fl oat":2,"return":[2,1],thei:[2,1],handl:[2,1],initi:[2,1],now:[2,1],mome:1,strive:1,name:[2,1],realist:1,drop:2,separ:1,achiev:[2,1],reactiv:1,mode:1,each:[2,1],fulli:2,unicod:2,complet:[2,1],side:[2,1],mean:2,redeliv:2,receipt:2,meta:2,connect:[2,1],our:1,event:[2,1],special:1,out:1,variabl:1,remote_offered_cap:[2,1],shown:1,network:1,local_st:2,req:1,content:[0,2],print:1,got:1,container_id:2,pn_connect:2,differ:[2,1],on_clos:1,base:[2,1],releas:2,"byte":2,recv:[2,1],shortest:1,could:1,success:[2,1],keep:1,filter:2,prefetch:2,remote_properti:2,retain:2,first:[2,1],origin:1,notifi:1,directli:1,upper:1,onc:[2,1],number:[2,1],restrict:[2,1],instruct:2,alreadi:[2,1],done:[2,1],messag:[2,1],symmetri:1,open:2,prioriti:2,brillig:1,script:1,data:2,tove:1,sometim:1,least:[2,1],attach:2,too:1,scheme:1,"final":2,listen:1,creation_tim:2,option:[2,1],peer_close_is_error:2,copi:1,specifi:[2,1],selector:1,appropri:[2,1],somewhat:2,attempt:2,create_send:[2,1],exactli:[2,1],holder:2,haven:1,conveni :2,target:[2,1],keyword:2,provid:[2,1],requir:[2,1],structur:[2,1],exampl:[2,1],str:1,were:[2,1],thu:1,deliveri:0,respons:[0,2],generate_uuid:1,argument:[2,1],expir:2,have:[2,1],deliv:2,need:[2,1],"null":2,on_link_open:1,built:2,on_send:[2,1],self:1,note:1,also:[2,1],client:1,take:[2,1],which:[2,1],singl:1,uppercas:1,gymbl:1,sure:2,unless:2,distribut:1,though:[2,1],track:[2,1],object:[2,1],expiry_tim:2,react:1,most:0,said:1,sendabl:[2,1],terminu:2,"class":0,tradit:1,don:1,url:[2,1],flow:[2,1],doe:[2,1],inde:1,optionpars:1,recipi:2,reactor:[2,1],show:1,unprocess:2,session:2,particularli:1,identifi:2,involv:1,onli:1,explicitli:2,acquir:2,configur:1,activ:2,written:[2,1],than:1,dict:2,local:2,add_opt:1,count:[2,1],variou:[2,1],get:[2,1],likewis:2,stop:1,becaus:1,on_session_error:2,"new":[2,1],increas:2,restart:1,resend:1,enabl:1,held:2,remot:[2,1],common:[2,1],contain:[2,1],where:2,summari:0,respond:1,on_reactor_init:2,set:[2,1],creator:2,overwhelm:1,frame:2,knowledg:2,mutabl:2,see:[2, 1],arg:1,close:[2,1],group_sequ:2,subject:2,awar:2,still:1,pattern:[2,1],someth:2,state:2,between:[2,1],"import":1,subscript:2,across:1,altern:2,kei:[2,1],conjunct:1,extens:[2,1],messaginghandl:[2,1],group:2,remote_desired_cap:2,come:1,addit:2,both:2,howev:1,equal:1,against:[2,1],tutori:0,context:2,logic:1,mani:1,simpli:1,point:[2,1],overview:0,pop:1,header:[2,1],param:2,suppli:1,speak:2,code:1,quit:1,user_id:2,three:2,been:[2,1],compon:[2,1],much:1,interest:[2,1],modif:1,wait:1,ani:[2,1],next_request:1,repetit:2,those:1,"case":[2,1],look:1,servic:1,wabe:1,local_clos:2,aim:1,defin:[2,1],"while":1,abov:1,error:2,anonym:1,loop:[2,1],program:1,outgrab:1,essenti:2,correlation_id:[2,1],itself:2,incom:[2,1],conn:1,delivery_count:2,receiv:[0,2],make:[2,1],intermediari:[2,1],same:1,oustand:2,member:0,instanc:[2,1],decod:2,eventu:[2,1],mimsi:1,dynamicnodeproperti:1,hostnam:2,upon:2,capabl:2,temporari:1,user:2,checkon:2,aka:2,task:2,content_encod:2,shouod:2,eleg:1,keyboardinterrupt:1,colour:1 ,well:1,implementa:1,without:1,command:1,thi:[2,1],model:0,protocol:2,entri:2,just:[2,1],uninit:2,obtain:2,yet:[2,1],field:2,except:1,littl:1,add:[2,1],schedul:2,on_link_error:2,els:1,match:1,build:2,opt:1,applic:[2,1],loss:2,read:2,auto_accept:2,writabl:2,know:[2,1],world:0,bit:2,measur:2,ivar:2,like:1,lost:2,should:[2,1],server:1,linkopt:2,either:[2,1],group_id:2,underli:1,often:[2,1],deal:2,creation:2,some:[2,1],back:1,guarante:0,librari:1,confirm:1,avoid:[2,1],iff:2,retri:2,exit:1,settl:2,prog:1,condit:2,on_reject:2,duplic:1,localhost:1,refer:2,machin:1,particular:1,previou:1,run:[2,1],consumig:1,is_receiv:2,usag:1,broker:1,on_accept:[2,1],peer:[2,1],"super":1,expiri:2,about:2,obj:2,socket:[2,1],on_disconnect:[2,1],slightli:1,optpars:1,outgo:2,on_start:[2,1],"__future__":1,on_connection_clos:1,within:[2,1],encod:2,automat:1,drain:[2,1],ensur:2,chang:1,artifici:1,durabl:2,retransmit:2,mask:2,wai:2,transfer:[2,1],support:1,"long":2,avail:2,start:[2,1],reli:1,trigger:[2,1],includ:[ 2,1],suit:1,remote_contain:2,parse_arg:1,"function":[2,1],offer:[2,1],create_receiv:[2,1],link:[2,1],line:1,"true":[2,1],reset:1,made:2,possibl:1,whether:[2,1],wish:[2,1],tell:1,asynchron:0,record:2,gire:1,limit:2,indefinit:1,otherwis:2,inform:2,similar:1,impl:2,expect:[2,1],alongsid:1,creat:[2,1],"int":[2,1],request:0,parser:1,doesn:2,incomplet:2,exist:1,check:1,again:1,aplic:2,amqp:[2,1],on_settl:2,sequenti:1,when:[2,1],detail:2,invalid:2,"default":[2,1],other:[2,1],test:[2,1],you:[2,1],queu:[2,1],node:2,sequenc:[2,1],consid:2,remote_clos:2,longer:2,descript:1,ignor:[2,1],remote_st:2,time:[2,1],reply_to:[2,1],hello:0},objtypes:{"0":"py:attribute","1":"py:method","2":"py:class"},objnames:{"0":["py","attribute","Python attribute"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["index","tutorial","overview"],titles:["Apache Qpid Proton: python documentation","Tutorial","API Overview"],objects:{"proton.Delivery":{session:[2,0,1,""],local_state:[2,0,1 ,""],partial:[2,0,1,""],remote_state:[2,0,1,""],readable:[2,0,1,""],update:[2,1,1,""],writable:[2,0,1,""],connection:[2,0,1,""],settle:[2,1,1,""],link:[2,0,1,""],settled:[2,0,1,""]},"proton.Connection":{remote_container:[2,0,1,""],container:[2,0,1,""],remote_properties:[2,0,1,""],hostname:[2,0,1,""],remote_hostname:[2,0,1,""],remote_offered_capabilities:[2,0,1,""],state:[2,0,1,""],session:[2,1,1,""],close:[2,1,1,""],remote_desired_capabilities:[2,0,1,""],open:[2,1,1,""]},Container:{container_id:[2,0,1,""]},"proton.handlers.MessagingHandler":{on_reactor_init:[2,1,1,""],on_settled:[2,1,1,""],on_session_error:[2,1,1,""],on_message:[2,1,1,""],on_accepted:[2,1,1,""],accept:[2,1,1,""],on_disconnected:[2,1,1,""],on_connection_error:[2,1,1,""],settle:[2,1,1,""],on_start:[2,1,1,""],reject:[2,1,1,""],release:[2,1,1,""],on_link_error:[2,1,1,""],on_rejected:[2,1,1,""],on_sendable:[2,1,1,""]},"proton.Event":{reactor:[2,0,1,""],delivery:[2,0,1,""],connection:[2,0,1,""],session:[2,0,1,""],link:[2, 0,1,""],context:[2,0,1,""],receiver:[2,0,1,""],sender:[2,0,1,""]},"proton.Terminus":{filter:[2,0,1,""],dynamic:[2,0,1,""],properties:[2,0,1,""],capabilities:[2,0,1,""],address:[2,0,1,""]},"proton.Message":{creation_time:[2,0,1,""],first_acquirer:[2,0,1,""],correlation_id:[2,0,1,""],ttl:[2,0,1,""],reply_to_group_id:[2,0,1,""],subject:[2,0,1,""],decode:[2,1,1,""],delivery_count:[2,0,1,""],user_id:[2,0,1,""],durable:[2,0,1,""],send:[2,1,1,""],id:[2,0,1,""],priority:[2,0,1,""],content_encoding:[2,0,1,""],encode:[2,1,1,""],content_type:[2,0,1,""],address:[2,0,1,""],expiry_time:[2,0,1,""],recv:[2,1,1,""],reply_to:[2,0,1,""],group_id:[2,0,1,""],group_sequence:[2,0,1,""]},proton:{Terminus:[2,2,1,""],Sender:[2,2,1,""],Delivery:[2,2,1,""],Connection:[2,2,1,""],Link:[2,2,1,""],Receiver:[2,2,1,""],Message:[2,2,1,""],Event:[2,2,1,""]},"proton.reactor.Container":{connect:[2,1,1,""],create_receiver:[2,1,1,""],run:[2,1,1,""],create_sender:[2,1,1,""],schedule:[2,1,1,""]},"proton.Sender":{offered:[2, 1,1,""],send:[2,1,1,""]},"proton.Link":{remote_source:[2,0,1,""],name:[2,0,1,""],credit:[2,0,1,""],is_receiver:[2,0,1,""],state:[2,0,1,""],source:[2,0,1,""],connection:[2,0,1,""],session:[2,0,1,""],remote_target:[2,0,1,""],is_sender:[2,0,1,""],queued:[2,0,1,""],target:[2,0,1,""]},"proton.handlers":{MessagingHandler:[2,2,1,""]},"proton.Receiver":{recv:[2,1,1,""],draining:[2,1,1,""],drain:[2,1,1,""],flow:[2,1,1,""]},"proton.reactor":{Container:[2,2,1,""]}},titleterms:{overview:2,direct:1,proton:0,api:2,respons:1,guarante:2,miscellan:1,receiv:1,apach:0,send:1,member:2,document:0,deliveri:2,python:0,most:2,world:1,"class":2,qpid:0,request:1,asynchron:1,tutori:1,model:2,hello:1,commonli:2,summari:2}}) \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
