You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2015/03/12 21:25:45 UTC
svn commit: r1666288 [6/8] - in /qpid/dispatch/branches/0.4/doc/pre_built:
./ doc/ doc/qpid-dispatch/ doc/qpid-dispatch/book/ doc/qpid-dispatch/html/
doc/qpid-dispatch/html/_sources/ doc/qpid-dispatch/html/_sources/book/
doc/qpid-dispatch/html/_sources...
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/book.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/book.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/book.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/book.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,168 @@
+
+
+<!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>Qpid Dispatch Router Book — Qpid Dispatch 0.4 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.4',
+ 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="Qpid Dispatch 0.4 documentation" href="../index.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><a href="../index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/book/book.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="qpid-dispatch-router-book">
+<h1>Qpid Dispatch Router Book<a class="headerlink" href="#qpid-dispatch-router-book" title="Permalink to this headline">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#overview">1.1. Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#benefits">1.2. Benefits</a></li>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html#features">1.3. Features</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="using.html">2. Using Qpid Dispatch</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="using.html#configuration">2.1. Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using.html#client-compatibility">2.2. Client Compatibility</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using.html#tools">2.3. Tools</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="using.html#qdstat">2.3.1. qdstat</a></li>
+<li class="toctree-l3"><a class="reference internal" href="using.html#qdmanage">2.3.2. qdmanage</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="using.html#features-and-examples">2.4. Features and Examples</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="using.html#standalone-and-interior-modes">2.4.1. Standalone and Interior Modes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="using.html#mobile-subscribers">2.4.2. Mobile Subscribers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="using.html#dynamic-reply-to">2.4.3. Dynamic Reply-To</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="addressing.html">3. Addressing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="addressing.html#routing-patterns">3.1. Routing patterns</a></li>
+<li class="toctree-l2"><a class="reference internal" href="addressing.html#routing-mechanisms">3.2. Routing mechanisms</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="addressing.html#message-routing">3.2.1. Message routing</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="amqp-mapping.html">4. AMQP Mapping</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="amqp-mapping.html#message-annotations">4.1. Message Annotations</a></li>
+<li class="toctree-l2"><a class="reference internal" href="amqp-mapping.html#source-target-capabilities">4.2. Source/Target Capabilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="amqp-mapping.html#dynamic-node-properties">4.3. Dynamic-Node-Properties</a></li>
+<li class="toctree-l2"><a class="reference internal" href="amqp-mapping.html#addresses-and-address-formats">4.4. Addresses and Address Formats</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="amqp-mapping.html#address-patterns">4.4.1. Address Patterns</a></li>
+<li class="toctree-l3"><a class="reference internal" href="amqp-mapping.html#supported-addresses">4.4.2. Supported Addresses</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="amqp-mapping.html#implementation-of-the-amqp-management-specification">4.5. Implementation of the AMQP Management Specification</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="schema.html">5. Management Schema</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="schema.html#configuration-entities">5.1. Configuration Entities</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#container">5.1.1. container</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router">5.1.2. router</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#listener">5.1.3. listener</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#connector">5.1.4. connector</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#log">5.1.5. log</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#fixedaddress">5.1.6. fixedAddress</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#waypoint">5.1.7. waypoint</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#linkroutepattern">5.1.8. linkRoutePattern</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="schema.html#operational-entities">5.2. Operational Entities</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#org-amqp-management">5.2.1. org.amqp.management</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#management">5.2.2. management</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-link">5.2.3. router.link</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-address">5.2.4. router.address</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-node">5.2.5. router.node</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#connection">5.2.6. connection</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#allocator">5.2.7. allocator</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="schema.html#management-operations">5.3. Management Operations</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#operations-for-all-entity-types">5.3.1. Operations for all entity types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#operations-for-org-amqp-management-entity-type">5.3.2. Operations for <cite>org.amqp.management</cite> entity type</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#operations-for-management-entity-type">5.3.3. Operations for <cite>management</cite> entity type</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</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><a href="../index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Apache Qpid <http://qpid.apache.org/>.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/introduction.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/introduction.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/introduction.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/introduction.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,190 @@
+
+
+<!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>1. Introduction — Qpid Dispatch 0.4 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.4',
+ 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="Qpid Dispatch 0.4 documentation" href="../index.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><a href="../index.html">Qpid Dispatch 0.4 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="#">1. Introduction</a><ul>
+<li><a class="reference internal" href="#overview">1.1. Overview</a></li>
+<li><a class="reference internal" href="#benefits">1.2. Benefits</a></li>
+<li><a class="reference internal" href="#features">1.3. Features</a></li>
+</ul>
+</li>
+</ul>
+
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/book/introduction.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="introduction">
+<h1>1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="overview">
+<h2>1.1. Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
+<p>The Dispatch router is an AMQP message message router that provides
+advanced interconnect capabilities. It allows flexible routing of
+messages between any AMQP-enabled endpoints, whether they be clients,
+servers, brokers or any other entity that can send or receive standard
+AMQP messages.</p>
+<p>A messaging client can make a single AMQP connection into a messaging
+bus built of Dispatch routers and, over that connection, exchange
+messages with one or more message brokers, and at the same time exchange
+messages directly with other endpoints without involving a broker at
+all.</p>
+<p>The router is an intermediary for messages but it is <em>not</em> a broker. It
+does not <em>take responsibility for</em> messages. It will, however, propagate
+settlement and disposition across a network such that delivery
+guarantees are met. In other words: the router network will deliver the
+message, possibly via several intermediate routers, <em>and</em> it will route
+the acknowledgement of that message by the ultimate reciever back across
+the same path. This means that <em>responsibility</em> for the message is
+transfered from the original sender to the ultimate receiver <em>as if they
+were directly connected</em>. However this is done via a flexible network
+that allows highly configurable routing of the message transparent to
+both sender and receiver.</p>
+<p>There are some patterns where this enables “brokerless messaging”
+approaches that are preferable to brokered approaches. In other cases a
+broker is essential (in particular where you need the separation of
+responsibility and/or the buffering provided by store-and-forward) but a
+dispatch network can still be useful to tie brokers and clients together
+into patterns that are difficult with a single broker.</p>
+<p>For a “brokerless” example, consider the common brokered implementation
+of the request-response pattern, a client puts a request on a queue and
+then waits for a reply on another queue. In this case the broker can be
+a hindrance - the client may want to know immediatly if there is nobody
+to serve the request, but typically it can only wait for a timeout to
+discover this. With a dispatch network, the client can be informed
+immediately if its message cannot be delivered because nobody is
+listening. When the client receives acknowledgement of the request it
+knows not just that it is sitting on a queue, but that it has actually
+been received by the server.</p>
+<p>For an exampe of using dispatch to enhance the use of brokers, consider
+using an array of brokers to implement a scalable distributed work
+queue. A dispatch network can make this appear as a single queue, with
+senders publishing to a single address and receivers subscribing to a
+single address. The dispatch network can distribute work to any broker
+in the array and collect work from any broker for any receiver. Brokers
+can be shut down or added without affecting clients. This elegantly
+solves the common difficult of “stuck messages” when implementing this
+pattern with brokers alone. If a receiver is connected to a broker that
+has no messages, but there are messages on another broker, you have to
+somehow transfer them or leave them “stuck”. With a dispatch network,
+<em>all</em> the receivers are connected to <em>all</em> the brokers. If there is a
+message anywhere it can be delivered to any receiver.</p>
+<p>The router is meant to be deployed in topologies of multiple routers,
+preferably with redundant paths. It uses link-state routing protocols
+and algorithms (similar to OSPF or IS-IS from the networking world) to
+calculate the best path from every point to every other point and to
+recover quickly from failures. It does not need to use clustering for
+high availability; rather, it relies on redundant paths to provide
+continued connectivity in the face of system or network failure. Because
+it never takes responsibility for messages it is effectively stateless,
+messages not delivered to their final destination will not be
+acknowledged to the sender and therefore the sender can re-send such
+messages if it is disconnected from the network.</p>
+</div>
+<div class="section" id="benefits">
+<h2>1.2. Benefits<a class="headerlink" href="#benefits" title="Permalink to this headline">¶</a></h2>
+<p>Simplifies connectivity</p>
+<ul class="simple">
+<li>An endpoint can do all of its messaging through a single transport connection</li>
+<li>Avoid opening holes in firewalls for incoming connections</li>
+</ul>
+<p>Simplifies reliability</p>
+<ul class="simple">
+<li>Reliability and availability are provided using redundant topology, not server clustering</li>
+<li>Reliable end-to-end messaging without persistent stores</li>
+<li>Use a message broker only when you need store-and-forward semantics</li>
+</ul>
+</div>
+<div class="section" id="features">
+<h2>1.3. Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>Supports arbitrary topology - no restrictions on redundancy</li>
+<li>Automatic route computation - adjusts quickly to changes in topology</li>
+<li>Cost-based route computation</li>
+<li><a class="reference external" href="#addressing">Rich addressing semantics</a></li>
+<li>Security</li>
+</ul>
+</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><a href="../index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Apache Qpid <http://qpid.apache.org/>.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/schema.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/schema.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/schema.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/schema.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,735 @@
+
+
+<!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>5. Management Schema — Qpid Dispatch 0.4 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.4',
+ 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="Qpid Dispatch 0.4 documentation" href="../index.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><a href="../index.html">Qpid Dispatch 0.4 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="#">5. Management Schema</a><ul>
+<li><a class="reference internal" href="#configuration-entities">5.1. Configuration Entities</a><ul>
+<li><a class="reference internal" href="#container">5.1.1. container</a></li>
+<li><a class="reference internal" href="#router">5.1.2. router</a></li>
+<li><a class="reference internal" href="#listener">5.1.3. listener</a></li>
+<li><a class="reference internal" href="#connector">5.1.4. connector</a></li>
+<li><a class="reference internal" href="#log">5.1.5. log</a></li>
+<li><a class="reference internal" href="#fixedaddress">5.1.6. fixedAddress</a></li>
+<li><a class="reference internal" href="#waypoint">5.1.7. waypoint</a></li>
+<li><a class="reference internal" href="#linkroutepattern">5.1.8. linkRoutePattern</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#operational-entities">5.2. Operational Entities</a><ul>
+<li><a class="reference internal" href="#org-amqp-management">5.2.1. org.amqp.management</a><ul>
+<li><a class="reference internal" href="#operation-get-types">5.2.1.1. Operation GET-TYPES</a></li>
+<li><a class="reference internal" href="#operation-get-attributes">5.2.1.2. Operation GET-ATTRIBUTES</a></li>
+<li><a class="reference internal" href="#operation-get-operations">5.2.1.3. Operation GET-OPERATIONS</a></li>
+<li><a class="reference internal" href="#operation-get-annotations">5.2.1.4. Operation GET-ANNOTATIONS</a></li>
+<li><a class="reference internal" href="#operation-query">5.2.1.5. Operation QUERY</a></li>
+<li><a class="reference internal" href="#operation-get-mgmt-nodes">5.2.1.6. Operation GET-MGMT-NODES</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#management">5.2.2. management</a><ul>
+<li><a class="reference internal" href="#operation-get-schema-json">5.2.2.1. Operation GET-SCHEMA-JSON</a></li>
+<li><a class="reference internal" href="#operation-get-schema">5.2.2.2. Operation GET-SCHEMA</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#router-link">5.2.3. router.link</a></li>
+<li><a class="reference internal" href="#router-address">5.2.4. router.address</a></li>
+<li><a class="reference internal" href="#router-node">5.2.5. router.node</a></li>
+<li><a class="reference internal" href="#connection">5.2.6. connection</a></li>
+<li><a class="reference internal" href="#allocator">5.2.7. allocator</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#management-operations">5.3. Management Operations</a><ul>
+<li><a class="reference internal" href="#operations-for-all-entity-types">5.3.1. Operations for all entity types</a><ul>
+<li><a class="reference internal" href="#operation-read">5.3.1.1. Operation READ</a></li>
+<li><a class="reference internal" href="#operation-create">5.3.1.2. Operation CREATE</a></li>
+<li><a class="reference internal" href="#operation-update">5.3.1.3. Operation UPDATE</a></li>
+<li><a class="reference internal" href="#operation-delete">5.3.1.4. Operation DELETE</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#operations-for-org-amqp-management-entity-type">5.3.2. Operations for <cite>org.amqp.management</cite> entity type</a><ul>
+<li><a class="reference internal" href="#id1">5.3.2.1. Operation GET-TYPES</a></li>
+<li><a class="reference internal" href="#id2">5.3.2.2. Operation GET-ATTRIBUTES</a></li>
+<li><a class="reference internal" href="#id3">5.3.2.3. Operation GET-OPERATIONS</a></li>
+<li><a class="reference internal" href="#id4">5.3.2.4. Operation GET-ANNOTATIONS</a></li>
+<li><a class="reference internal" href="#id5">5.3.2.5. Operation QUERY</a></li>
+<li><a class="reference internal" href="#id6">5.3.2.6. Operation GET-MGMT-NODES</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#operations-for-management-entity-type">5.3.3. Operations for <cite>management</cite> entity type</a><ul>
+<li><a class="reference internal" href="#id7">5.3.3.1. Operation GET-SCHEMA-JSON</a></li>
+<li><a class="reference internal" href="#id8">5.3.3.2. Operation GET-SCHEMA</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/book/schema.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="management-schema">
+<h1>5. Management Schema<a class="headerlink" href="#management-schema" title="Permalink to this headline">¶</a></h1>
+<p>This chapter documents the set of <em>management entity types</em> that define
+configuration and management of a Dispatch Router. A management entity type has
+a set of <em>attributes</em> that can be read, some attributes can also be
+updated. Some entity types also support <em>operations</em> that can be called.</p>
+<p>All management entity types have the following standard attributes:</p>
+<dl class="docutils">
+<dt><em>type</em></dt>
+<dd>The fully qualified type of the entity,
+e.g. <cite>org.apache.qpid.dispatch.router</cite>. This document uses the short name
+without the <cite>org.apache.qpid.dispatch</cite> prefix e.g. <cite>router</cite>. The dispatch
+tools will accept the short or long name.</dd>
+<dt><em>identity</em></dt>
+<dd>A system-generated identity of the entity. It includes
+the short type name and some identifying information. E.g. <cite>log/AGENT</cite> or
+<cite>listener/localhost:amqp</cite></dd>
+</dl>
+<p>There are two main categories of management entity type.</p>
+<dl class="docutils">
+<dt><em>Configuration</em> Entities</dt>
+<dd>Parameters that can be set in the configuration file
+(see <cite>qdrouterd.conf(5)</cite> man page) or set at run-time with the <cite>qdmanage(8)</cite>
+tool.</dd>
+<dt><em>Operational</em> Entities</dt>
+<dd>Run-time status values that can be queried using <cite>qdstat(8)</cite> or <cite>qdmanage(8)</cite> tools.</dd>
+</dl>
+<div class="section" id="configuration-entities">
+<h2>5.1. Configuration Entities<a class="headerlink" href="#configuration-entities" title="Permalink to this headline">¶</a></h2>
+<p>Configuration entities define the attributes allowed in the configuration file
+(see <cite>qdrouterd.conf(5)</cite>) but you can also create entities once the router is
+running using the <cite>qdrouterd(8)</cite> tool’s <cite>create</cite> operation. Some entities can also
+be modified using the <cite>update</cite> operation, see the entity descriptions below.</p>
+<div class="section" id="container">
+<h3>5.1.1. container<a class="headerlink" href="#container" title="Permalink to this headline">¶</a></h3>
+<p>Attributes related to the AMQP container.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>containerName</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name of the AMQP container. If not specified, the container name will be set to a value of the container’s choosing. The automatically assigned container name is not guaranteed to be persistent across restarts of the container.</dd>
+<dt><em>workerThreads</em> (integer, default=1, <cite>CREATE</cite>)</dt>
+<dd>The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .</dd>
+<dt><em>debugDump</em> (path, <cite>CREATE</cite>)</dt>
+<dd>A file to dump debugging information that can’t be logged normally.</dd>
+</dl>
+</div>
+<div class="section" id="router">
+<h3>5.1.2. router<a class="headerlink" href="#router" title="Permalink to this headline">¶</a></h3>
+<p>Tracks peer routers and computes routes to destinations.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>routerId</em> (string, <cite>CREATE</cite>)</dt>
+<dd>Router’s unique identity.</dd>
+<dt><em>mode</em> (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’, <cite>CREATE</cite>)</dt>
+<dd>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</dd>
+<dt><em>area</em> (string)</dt>
+<dd>Unused placeholder.</dd>
+<dt><em>helloInterval</em> (integer, default=1, <cite>CREATE</cite>)</dt>
+<dd>Interval in seconds between HELLO messages sent to neighbor routers.</dd>
+<dt><em>helloMaxAge</em> (integer, default=3, <cite>CREATE</cite>)</dt>
+<dd>Time in seconds after which a neighbor is declared lost if no HELLO is received.</dd>
+<dt><em>raInterval</em> (integer, default=30, <cite>CREATE</cite>)</dt>
+<dd>Interval in seconds between Router-Advertisements sent to all routers in a stable network.</dd>
+<dt><em>raIntervalFlux</em> (integer, default=4, <cite>CREATE</cite>)</dt>
+<dd>Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.</dd>
+<dt><em>remoteLsMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
+<dd>Time in seconds after which link state is declared stale if no RA is received.</dd>
+<dt><em>mobileAddrMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
+<dd>Deprecated - This value is no longer used in the router.</dd>
+<dt><em>addrCount</em> (integer)</dt>
+<dd>Number of addresses known to the router.</dd>
+<dt><em>linkCount</em> (integer)</dt>
+<dd>Number of links attached to the router node.</dd>
+<dt><em>nodeCount</em> (integer)</dt>
+<dd>Number of known peer router nodes.</dd>
+</dl>
+</div>
+<div class="section" id="listener">
+<h3>5.1.3. listener<a class="headerlink" href="#listener" title="Permalink to this headline">¶</a></h3>
+<p>Listens for incoming connections to the router.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>addr</em> (string, default=‘0.0.0.0’, <cite>CREATE</cite>)</dt>
+<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
+<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
+<dd>Port number or symbolic service name.</dd>
+<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
+<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
+<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
+<dt><em>saslMechanisms</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dt><em>requirePeerAuth</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
+<dd>Only for listeners using SSL. If set to ‘yes’, attached clients will be required to supply a certificate. If the certificate is not traceable to a CA in the ssl profile’s cert-db, authentication fails for the connection.</dd>
+<dt><em>trustedCerts</em> (path, <cite>CREATE</cite>)</dt>
+<dd>This optional setting can be used to reduce the set of available CAs for client authentication. If used, this setting must provide a path to a PEM file that contains the trusted certificates.</dd>
+<dt><em>allowUnsecured</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>For listeners using SSL only. If set to ‘yes’ the listener will allow both SSL-secured clients and non-SSL clients to connect.</dd>
+<dt><em>allowNoSasl</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>If set to ‘yes’, this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.</dd>
+<dt><em>maxFrameSize</em> (integer, default=65536, <cite>CREATE</cite>)</dt>
+<dd>Defaults to 65536. If specified, it is the maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</dd>
+</dl>
+</div>
+<div class="section" id="connector">
+<h3>5.1.4. connector<a class="headerlink" href="#connector" title="Permalink to this headline">¶</a></h3>
+<p>Establishes an outgoing connections from the router.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>addr</em> (string, default=‘0.0.0.0’, <cite>CREATE</cite>)</dt>
+<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
+<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
+<dd>Port number or symbolic service name.</dd>
+<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
+<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
+<dt><em>certFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.</dd>
+<dt><em>keyFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the PEM-formatted private key for the above certificate.</dd>
+<dt><em>passwordFile</em> (path, <cite>CREATE</cite>)</dt>
+<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
+<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
+<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
+<dt><em>saslMechanisms</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
+<dt><em>allowRedirect</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
+<dd>Allow the peer to redirect this connection to another address.</dd>
+<dt><em>maxFrameSize</em> (integer, default=65536, <cite>CREATE</cite>)</dt>
+<dd>Maximum frame size in octets that will be used in the connection-open negotiation with a connected peer. The frame size is the largest contiguous set of uninterrupted data that can be sent for a message delivery over the connection. Interleaving of messages on different links is done at frame granularity.</dd>
+</dl>
+</div>
+<div class="section" id="log">
+<h3>5.1.5. log<a class="headerlink" href="#log" title="Permalink to this headline">¶</a></h3>
+<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
+<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘DEFAULT’], required)</dt>
+<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
+<dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt>
+<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
+<dt><em>timestamp</em> (boolean, <cite>UPDATE</cite>)</dt>
+<dd>Include timestamp in log messages.</dd>
+<dt><em>source</em> (boolean, <cite>UPDATE</cite>)</dt>
+<dd>Include source file and line number in log messages.</dd>
+<dt><em>output</em> (string, <cite>UPDATE</cite>)</dt>
+<dd>Where to send log messages. Can be ‘stderr’, ‘syslog’ or a file name.</dd>
+</dl>
+</div>
+<div class="section" id="fixedaddress">
+<h3>5.1.6. fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">¶</a></h3>
+<p>Establishes semantics for addresses starting with a prefix.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address prefix (always starting with ‘/’).</dd>
+<dt><em>phase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>The phase of a multi-hop address passing through one or more waypoints.</dd>
+<dt><em>fanout</em> (One of [‘multiple’, ‘single’], default=’multiple’, <cite>CREATE</cite>)</dt>
+<dd>One of ‘multiple’ or ‘single’. Multiple fanout is a non-competing pattern. If there are multiple consumers using the same address, each consumer will receive its own copy of every message sent to the address. Single fanout is a competing pattern where each message is sent to only one consumer.</dd>
+<dt><em>bias</em> (One of [‘closest’, ‘spread’], default=’closest’, <cite>CREATE</cite>)</dt>
+<dd>Only if fanout is single. One of ‘closest’ or ‘spread’. Closest bias means that messages to an address will always be delivered to the closest (lowest cost) subscribed consumer. Spread bias will distribute the messages across subscribers in an approximately even manner.</dd>
+</dl>
+</div>
+<div class="section" id="waypoint">
+<h3>5.1.7. waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">¶</a></h3>
+<p>A remote node that messages for an address pass through.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>address</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The AMQP address of the waypoint.</dd>
+<dt><em>connector</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The name of the on-demand connector used to reach the waypoint’s container.</dd>
+<dt><em>inPhase</em> (integer, default=-1, <cite>CREATE</cite>)</dt>
+<dd>The phase of the address as it is routed _to_ the waypoint.</dd>
+<dt><em>outPhase</em> (integer, default=-1, <cite>CREATE</cite>)</dt>
+<dd>The phase of the address as it is routed _from_ the waypoint.</dd>
+</dl>
+</div>
+<div class="section" id="linkroutepattern">
+<h3>5.1.8. linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">¶</a></h3>
+<p>A pattern to match a connected container to endpoints for routed links.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The AMQP address prefix for nodes on the container.</dd>
+<dt><em>connector</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name of the on-demand connector used to reach the waypoint’s container.</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="operational-entities">
+<h2>5.2. Operational Entities<a class="headerlink" href="#operational-entities" title="Permalink to this headline">¶</a></h2>
+<p>Operational entities provide statistics and other run-time attributes of the router.
+The <cite>qdstat(8)</cite> tool provides a convenient way to query run-time statistics.
+You can also use the general-purpose management tool <cite>qdmanage(8)</cite> to query
+operational attributes.</p>
+<div class="section" id="org-amqp-management">
+<h3>5.2.1. org.amqp.management<a class="headerlink" href="#org-amqp-management" title="Permalink to this headline">¶</a></h3>
+<p>The standard AMQP management node interface.</p>
+<p>Operations allowed: <cite>QUERY</cite>, <cite>GET-TYPES</cite>, <cite>GET-ANNOTATIONS</cite>, <cite>GET-OPERATIONS</cite>, <cite>GET-ATTRIBUTES</cite>, <cite>GET-MGMT-NODES</cite>, <cite>READ</cite></p>
+<div class="section" id="operation-get-types">
+<h4>5.2.1.1. Operation GET-TYPES<a class="headerlink" href="#operation-get-types" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and their inheritance relationships</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.</p>
+</div>
+<div class="section" id="operation-get-attributes">
+<h4>5.2.1.2. Operation GET-ATTRIBUTES<a class="headerlink" href="#operation-get-attributes" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and the annotations they implement</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.</p>
+</div>
+<div class="section" id="operation-get-operations">
+<h4>5.2.1.3. Operation GET-OPERATIONS<a class="headerlink" href="#operation-get-operations" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and the operations they support</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.</p>
+</div>
+<div class="section" id="operation-get-annotations">
+<h4>5.2.1.4. Operation GET-ANNOTATIONS<a class="headerlink" href="#operation-get-annotations" title="Permalink to this headline">¶</a></h4>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.</p>
+</div>
+<div class="section" id="operation-query">
+<h4>5.2.1.5. Operation QUERY<a class="headerlink" href="#operation-query" title="Permalink to this headline">¶</a></h4>
+<p>Query for attribute values of multiple entities.</p>
+<p><strong>Request body</strong> (map)A map containing the key <cite>attributeNames</cite> with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>count</em> (integer)</dt>
+<dd>If set, specifies the number of entries from the result set to return. If not set return all from <cite>offset</cite></dd>
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+<dt><em>offset</em> (integer)</dt>
+<dd>If set, specifies the number of the first element of the result set to be returned.</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map with two entries. <cite>attributeNames</cite> is a list of the attribute names returned. <cite>results</cite> is a list of lists each containing the attribute values for a single entity in the same order as the names in the <cite>attributeNames</cite> entry. If an attribute name is not applicable for an entity then the corresponding value is <cite>null</cite></p>
+<p><strong>Response properties:</strong></p>
+<dl class="docutils">
+<dt><em>count</em> (integer)</dt>
+<dd>Number of results returned</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+</div>
+<div class="section" id="operation-get-mgmt-nodes">
+<h4>5.2.1.6. Operation GET-MGMT-NODES<a class="headerlink" href="#operation-get-mgmt-nodes" title="Permalink to this headline">¶</a></h4>
+<p>Get the addresses of all management nodes known to this router</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (list)A list of addresses (strings) of management nodes known to this management node.</p>
+</div>
+</div>
+<div class="section" id="management">
+<h3>5.2.2. management<a class="headerlink" href="#management" title="Permalink to this headline">¶</a></h3>
+<p>Qpid dispatch router extensions to the standard org.amqp.management interface.</p>
+<p>Operations allowed: <cite>GET-SCHEMA</cite>, <cite>GET-JSON-SCHEMA</cite>, <cite>QUERY</cite>, <cite>GET-TYPES</cite>, <cite>GET-ANNOTATIONS</cite>, <cite>GET-OPERATIONS</cite>, <cite>GET-ATTRIBUTES</cite>, <cite>GET-MGMT-NODES</cite>, <cite>READ</cite></p>
+<div class="section" id="operation-get-schema-json">
+<h4>5.2.2.1. Operation GET-SCHEMA-JSON<a class="headerlink" href="#operation-get-schema-json" title="Permalink to this headline">¶</a></h4>
+<p>Get the qdrouterd schema for this router in JSON format</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>indent</em> (integer)</dt>
+<dd>Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (string)The qdrouter schema as a JSON string.</p>
+</div>
+<div class="section" id="operation-get-schema">
+<h4>5.2.2.2. Operation GET-SCHEMA<a class="headerlink" href="#operation-get-schema" title="Permalink to this headline">¶</a></h4>
+<p>Get the qdrouterd schema for this router in AMQP map format</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)The qdrouter schema as a map.</p>
+</div>
+</div>
+<div class="section" id="router-link">
+<h3>5.2.3. router.link<a class="headerlink" href="#router-link" title="Permalink to this headline">¶</a></h3>
+<p>Link to another AMQP endpoint: router node, client or other AMQP process.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<p><em>linkName</em> (string)</p>
+<p><em>linkType</em> (One of [‘endpoint’, ‘waypoint’, ‘inter-router’, ‘inter-area’])</p>
+<p><em>linkDir</em> (One of [‘in’, ‘out’])</p>
+<p><em>owningAddr</em> (string)</p>
+<p><em>eventFifoDepth</em> (integer)</p>
+<p><em>msgFifoDepth</em> (integer)</p>
+<p><em>remoteContainer</em> (string)</p>
+</div>
+<div class="section" id="router-address">
+<h3>5.2.4. router.address<a class="headerlink" href="#router-address" title="Permalink to this headline">¶</a></h3>
+<p>AMQP address managed by the router.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<p><em>inProcess</em> (boolean)</p>
+<p><em>subscriberCount</em> (integer)</p>
+<p><em>remoteCount</em> (integer)</p>
+<p><em>deliveriesIngress</em> (integer)</p>
+<p><em>deliveriesEgress</em> (integer)</p>
+<p><em>deliveriesTransit</em> (integer)</p>
+<p><em>deliveriesToContainer</em> (integer)</p>
+<p><em>deliveriesFromContainer</em> (integer)</p>
+<dl class="docutils">
+<dt><em>key</em> (string)</dt>
+<dd>Internal unique (to this router) key to identify the address</dd>
+</dl>
+</div>
+<div class="section" id="router-node">
+<h3>5.2.5. router.node<a class="headerlink" href="#router-node" title="Permalink to this headline">¶</a></h3>
+<p>Remote router node connected to this router.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>routerId</em> (string)</dt>
+<dd>Remote node identifier.</dd>
+<dt><em>instance</em> (integer)</dt>
+<dd>Remote node boot number.</dd>
+<dt><em>linkState</em> (list)</dt>
+<dd>List of remote node’s neighbours.</dd>
+<dt><em>nextHop</em> (string)</dt>
+<dd>Neighbour ID of next hop to remote node from here.</dd>
+<dt><em>validOrigins</em> (list)</dt>
+<dd>List of valid origin nodes for messages arriving via the remote node, used for duplicate elimination in redundant networks.</dd>
+<dt><em>address</em> (string)</dt>
+<dd>Address of the remote node</dd>
+<dt><em>routerLink</em> (entityId)</dt>
+<dd>Local link to remote node</dd>
+</dl>
+</div>
+<div class="section" id="connection">
+<h3>5.2.6. connection<a class="headerlink" href="#connection" title="Permalink to this headline">¶</a></h3>
+<p>Connections to the router’s container.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>container</em> (string)</dt>
+<dd>The container for this connection</dd>
+</dl>
+<p><em>state</em> (One of [‘connecting’, ‘opening’, ‘operational’, ‘failed’, ‘user’])</p>
+<dl class="docutils">
+<dt><em>host</em> (string)</dt>
+<dd>IP address and port number in the form addr:port.</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’])</dt>
+<dd>Direction of connection establishment in or out of the router.</dd>
+</dl>
+<p><em>role</em> (string)</p>
+<dl class="docutils">
+<dt><em>sasl</em> (string)</dt>
+<dd>SASL mechanism used for authentication.</dd>
+</dl>
+</div>
+<div class="section" id="allocator">
+<h3>5.2.7. allocator<a class="headerlink" href="#allocator" title="Permalink to this headline">¶</a></h3>
+<p>Memory allocation pool.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<p><em>typeName</em> (string)</p>
+<p><em>typeSize</em> (integer)</p>
+<p><em>transferBatchSize</em> (integer)</p>
+<p><em>localFreeListMax</em> (integer)</p>
+<p><em>globalFreeListMax</em> (integer)</p>
+<p><em>totalAllocFromHeap</em> (integer)</p>
+<p><em>totalFreeToHeap</em> (integer)</p>
+<p><em>heldByThreads</em> (integer)</p>
+<p><em>batchesRebalancedToThreads</em> (integer)</p>
+<p><em>batchesRebalancedToGlobal</em> (integer)</p>
+</div>
+</div>
+<div class="section" id="management-operations">
+<h2>5.3. Management Operations<a class="headerlink" href="#management-operations" title="Permalink to this headline">¶</a></h2>
+<p>The <cite>qdstat(8)</cite> and <cite>qdmanage(8)</cite> tools allow you to view or modify management entity
+attributes. They work by invoking <em>management operations</em>. You can invoke these operations
+from any AMQP client by sending a message with the appropriate properties and body to the
+<cite>$management</cite> address. The message should have a <cite>reply-to</cite> address indicating where the
+response should be sent.</p>
+<div class="section" id="operations-for-all-entity-types">
+<h3>5.3.1. Operations for all entity types<a class="headerlink" href="#operations-for-all-entity-types" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="operation-read">
+<h4>5.3.1.1. Operation READ<a class="headerlink" href="#operation-read" title="Permalink to this headline">¶</a></h4>
+<p>Read attributes of an entity</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>type</em> (string)</dt>
+<dd>Type of desired entity.</dd>
+<dt><em>name</em> (string)</dt>
+<dd>Name of desired entity. Must supply name or identity.</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Identity of desired entity. Must supply name or identity.</dd>
+</dl>
+<p><strong>Response body</strong> (map)Attributes of the entity</p>
+</div>
+<div class="section" id="operation-create">
+<h4>5.3.1.2. Operation CREATE<a class="headerlink" href="#operation-create" title="Permalink to this headline">¶</a></h4>
+<p>Create a new entity.</p>
+<p><strong>Request body</strong> (map, required)Attributes for the new entity. Can include name and/or type.</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>type</em> (string, required)</dt>
+<dd>Type of new entity.</dd>
+<dt><em>name</em> (string)</dt>
+<dd>Name of new entity. Optional, defaults to identity.</dd>
+</dl>
+<p><strong>Response body</strong> (map)Attributes of the entity</p>
+</div>
+<div class="section" id="operation-update">
+<h4>5.3.1.3. Operation UPDATE<a class="headerlink" href="#operation-update" title="Permalink to this headline">¶</a></h4>
+<p>Update attributes of an entity</p>
+<p><strong>Request body</strong> (map)Attributes to update for the entity. Can include name or identity.</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>type</em> (string)</dt>
+<dd>Type of desired entity.</dd>
+<dt><em>name</em> (string)</dt>
+<dd>Name of desired entity. Must supply name or identity.</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Identity of desired entity. Must supply name or identity.</dd>
+</dl>
+<p><strong>Response body</strong> (map)Updated attributes of the entity</p>
+</div>
+<div class="section" id="operation-delete">
+<h4>5.3.1.4. Operation DELETE<a class="headerlink" href="#operation-delete" title="Permalink to this headline">¶</a></h4>
+<p>Delete an entity</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>type</em> (string)</dt>
+<dd>Type of desired entity.</dd>
+<dt><em>name</em> (string)</dt>
+<dd>Name of desired entity. Must supply name or identity.</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Identity of desired entity. Must supply name or identity.</dd>
+</dl>
+</div>
+</div>
+<div class="section" id="operations-for-org-amqp-management-entity-type">
+<h3>5.3.2. Operations for <cite>org.amqp.management</cite> entity type<a class="headerlink" href="#operations-for-org-amqp-management-entity-type" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id1">
+<h4>5.3.2.1. Operation GET-TYPES<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and their inheritance relationships</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of the entity types (strings) that it extends.</p>
+</div>
+<div class="section" id="id2">
+<h4>5.3.2.2. Operation GET-ATTRIBUTES<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and the annotations they implement</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is a list (of strings) of attributes on that entity type.</p>
+</div>
+<div class="section" id="id3">
+<h4>5.3.2.3. Operation GET-OPERATIONS<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
+<p>Get the set of entity types and the operations they support</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of operation names (strings) that it supports.</p>
+</div>
+<div class="section" id="id4">
+<h4>5.3.2.4. Operation GET-ANNOTATIONS<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)A map where each key is an entity type name (string) and the corresponding value is the list of annotations (strings) that it implements.</p>
+</div>
+<div class="section" id="id5">
+<h4>5.3.2.5. Operation QUERY<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
+<p>Query for attribute values of multiple entities.</p>
+<p><strong>Request body</strong> (map)A map containing the key <cite>attributeNames</cite> with value a list of (string) attribute names to return. If the list or the map is empty or the body is missing all attributes are returned.</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>count</em> (integer)</dt>
+<dd>If set, specifies the number of entries from the result set to return. If not set return all from <cite>offset</cite></dd>
+<dt><em>entityType</em> (string)</dt>
+<dd>If set, restrict query results to entities that extend (directly or indirectly) this type</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+<dt><em>offset</em> (integer)</dt>
+<dd>If set, specifies the number of the first element of the result set to be returned.</dd>
+</dl>
+<p><strong>Response body</strong> (map)A map with two entries. <cite>attributeNames</cite> is a list of the attribute names returned. <cite>results</cite> is a list of lists each containing the attribute values for a single entity in the same order as the names in the <cite>attributeNames</cite> entry. If an attribute name is not applicable for an entity then the corresponding value is <cite>null</cite></p>
+<p><strong>Response properties:</strong></p>
+<dl class="docutils">
+<dt><em>count</em> (integer)</dt>
+<dd>Number of results returned</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+</div>
+<div class="section" id="id6">
+<h4>5.3.2.6. Operation GET-MGMT-NODES<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h4>
+<p>Get the addresses of all management nodes known to this router</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (list)A list of addresses (strings) of management nodes known to this management node.</p>
+</div>
+</div>
+<div class="section" id="operations-for-management-entity-type">
+<h3>5.3.3. Operations for <cite>management</cite> entity type<a class="headerlink" href="#operations-for-management-entity-type" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id7">
+<h4>5.3.3.1. Operation GET-SCHEMA-JSON<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
+<p>Get the qdrouterd schema for this router in JSON format</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>indent</em> (integer)</dt>
+<dd>Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.</dd>
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (string)The qdrouter schema as a JSON string.</p>
+</div>
+<div class="section" id="id8">
+<h4>5.3.3.2. Operation GET-SCHEMA<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
+<p>Get the qdrouterd schema for this router in AMQP map format</p>
+<p><strong>Request properties:</strong></p>
+<dl class="docutils">
+<dt><em>identity</em> (string)</dt>
+<dd>Set to the value <cite>self</cite></dd>
+</dl>
+<p><strong>Response body</strong> (map)The qdrouter schema as a map.</p>
+</div>
+</div>
+</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><a href="../index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Apache Qpid <http://qpid.apache.org/>.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/using.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/using.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/using.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/book/using.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,360 @@
+
+
+<!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>2. Using Qpid Dispatch — Qpid Dispatch 0.4 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.4',
+ 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="Qpid Dispatch 0.4 documentation" href="../index.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><a href="../index.html">Qpid Dispatch 0.4 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="#">2. Using Qpid Dispatch</a><ul>
+<li><a class="reference internal" href="#configuration">2.1. Configuration</a></li>
+<li><a class="reference internal" href="#client-compatibility">2.2. Client Compatibility</a></li>
+<li><a class="reference internal" href="#tools">2.3. Tools</a><ul>
+<li><a class="reference internal" href="#qdstat">2.3.1. qdstat</a></li>
+<li><a class="reference internal" href="#qdmanage">2.3.2. qdmanage</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#features-and-examples">2.4. Features and Examples</a><ul>
+<li><a class="reference internal" href="#standalone-and-interior-modes">2.4.1. Standalone and Interior Modes</a></li>
+<li><a class="reference internal" href="#mobile-subscribers">2.4.2. Mobile Subscribers</a></li>
+<li><a class="reference internal" href="#dynamic-reply-to">2.4.3. Dynamic Reply-To</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/book/using.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="using-qpid-dispatch">
+<h1>2. Using Qpid Dispatch<a class="headerlink" href="#using-qpid-dispatch" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="configuration">
+<h2>2.1. Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
+<p>The default configuration file is installed in
+<cite>install-prefix</cite>/etc/qpid/qdrouterd.conf. This configuration file will
+cause the router to run in standalone mode, listening on the standard
+AMQP port (5672). Dispatch Router looks for the configuration file in
+the installed location by default. If you wish to use a different path,
+the “-c” command line option will instruct Dispatch Router as to which
+configuration to load.</p>
+<p>To run the router, invoke the executable: qdrouterd [-c my-config-file]</p>
+<p>For more details of the configuration file see the <cite>qdrouterd.conf(5)</cite>
+man page.</p>
+</div>
+<div class="section" id="client-compatibility">
+<h2>2.2. Client Compatibility<a class="headerlink" href="#client-compatibility" title="Permalink to this headline">¶</a></h2>
+<p>Dispatch Router should, in theory, work with any client that is
+compatible with AMQP 1.0. The following clients have been tested:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><em>Client</em></th>
+<th class="head"><em>Notes</em></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>qpid::messaging</td>
+<td>The Qpid messaging clients work with Dispatch Router as long as
+they are configured to use the 1.0 version of the protocol. To
+enable AMQP 1.0 in the C++ client, use the {protocol:amqp1.0}
+connection option.</td>
+</tr>
+<tr class="row-odd"><td>Proton Messenger</td>
+<td>Messenger works with Dispatch Router.</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="tools">
+<h2>2.3. Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="qdstat">
+<h3>2.3.1. qdstat<a class="headerlink" href="#qdstat" title="Permalink to this headline">¶</a></h3>
+<p><em>qdstat</em> is a command line tool that lets you view the status of a
+Dispatch Router. The following options are useful for seeing that the
+router is doing:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="89%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><em>Option</em></th>
+<th class="head"><em>Description</em></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>-l</td>
+<td>Print a list of AMQP links attached to the router. Links are
+unidirectional. Outgoing links are usually associated with a subscription
+address. The tool distinguishes between <em>endpoint</em> links and <em>router</em>
+links. Endpoint links are attached to clients using the router. Router links
+are attached to other routers in a network of routbers.</td>
+</tr>
+<tr class="row-odd"><td>-a</td>
+<td>Print a list of addresses known to the router.</td>
+</tr>
+<tr class="row-even"><td>-n</td>
+<td>Print a list of known routers in the network.</td>
+</tr>
+<tr class="row-odd"><td>-c</td>
+<td>Print a list of connections to the router.</td>
+</tr>
+</tbody>
+</table>
+<p>For complete details see the <cite>qdstat(8)</cite> man page and the output of
+<cite>qdstat –help</cite>.</p>
+</div>
+<div class="section" id="qdmanage">
+<h3>2.3.2. qdmanage<a class="headerlink" href="#qdmanage" title="Permalink to this headline">¶</a></h3>
+<p><em>qdmanage</em> is a general-purpose AMQP management client that allows you
+to not only view but modify the configuration of a running dispatch
+router.</p>
+<p>For example you can query all the connection entities in the router:</p>
+<div class="highlight-python"><pre>$ qdrouterd query --type connection</pre>
+</div>
+<p>To enable logging debug and higher level messages by default:</p>
+<div class="highlight-python"><pre>$ qdrouter update log/DEFAULT enable=debug+</pre>
+</div>
+<p>In fact, everything that can be configured in the configuration file can
+also be created in a running router via management. For example to
+create a new listener in a running router:</p>
+<div class="highlight-python"><pre>$ qdrouter create type=listener port=5555</pre>
+</div>
+<p>Now you can connect to port 5555, for exampple:</p>
+<div class="highlight-python"><pre>$ qdrouterd query -b localhost:5555 --type listener</pre>
+</div>
+<p>For complete details see the <cite>qdmanage(8)</cite> man page and the output of
+<cite>qdmanage –help</cite>. Also for details of what can be configured see the
+<cite>qdrouterd.conf(5)</cite> man page.</p>
+</div>
+</div>
+<div class="section" id="features-and-examples">
+<h2>2.4. Features and Examples<a class="headerlink" href="#features-and-examples" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="standalone-and-interior-modes">
+<h3>2.4.1. Standalone and Interior Modes<a class="headerlink" href="#standalone-and-interior-modes" title="Permalink to this headline">¶</a></h3>
+<p>The router can operate stand-alone or as a node in a network of routers.
+The mode is configured in the <em>router</em> section of the configuration
+file. In stand-alone mode, the router does not attempt to collaborate
+with any other routers and only routes messages among directly connected
+endpoints.</p>
+<p>If your router is running in stand-alone mode, <em>qdstat -a</em> will look
+like the following:</p>
+<div class="highlight-python"><pre>$ qdstat -a
+Router Addresses
+ class address in-proc local remote in out thru to-proc from-proc
+ ===============================================================================
+ local $management Y 0 0 1 0 0 1 0
+ local temp.AY81ga 1 0 0 0 0 0 0</pre>
+</div>
+<p>Note that there are two known addresses. <em>$management</em> is the address of
+the router’s embedded management agent. <em>temp.AY81ga</em> is the temporary
+reply-to address of the <em>qdstat</em> client making requests to the agent.</p>
+<p>If you change the mode to interior and restart the processs, the same
+command will yield two additional addresses which are used for
+inter-router communication:</p>
+<div class="highlight-python"><pre>$ qdstat -a
+Router Addresses
+ class address in-proc local remote in out thru to-proc from-proc
+ ===============================================================================
+ local $management Y 0 0 1 0 0 1 0
+ local qdhello Y 0 0 0 0 0 0 3
+ local qdrouter Y 0 0 0 0 0 0 1
+ local temp.khOpGb 1 0 0 0 0 0 0</pre>
+</div>
+</div>
+<div class="section" id="mobile-subscribers">
+<h3>2.4.2. Mobile Subscribers<a class="headerlink" href="#mobile-subscribers" title="Permalink to this headline">¶</a></h3>
+<p>The term “mobile subscriber” simply refers to the fact that a client may
+connect to the router and subscribe to an address to receive messages
+sent to that address. No matter where in the network the subscriber
+attaches, the messages will be routed to the appropriate destination.</p>
+<p>To illustrate a subscription on a stand-alone router, you can use the
+examples that are provided with Qpid Proton. Using the <em>recv.py</em> example
+receiver:</p>
+<div class="highlight-python"><pre>$ recv.py amqp://0.0.0.0/my-address</pre>
+</div>
+<p>This command creates a receiving link subscribed to the specified
+address. To verify the subscription:</p>
+<div class="highlight-python"><pre>$ qdstat -a
+Router Addresses
+ class address in-proc local remote in out thru to-proc from-proc
+ ================================================================================
+ local $management Y 0 0 1 0 0 1 0
+ mobile my-address 1 0 0 0 0 0 0
+ local temp.fDt8_a 1 0 0 0 0 0 0</pre>
+</div>
+<p>You can then, in a separate command window, run a sender to produce
+messages to that address:</p>
+<div class="highlight-python"><pre>$ send.py -a amqp://0.0.0.0/my-address</pre>
+</div>
+</div>
+<div class="section" id="dynamic-reply-to">
+<h3>2.4.3. Dynamic Reply-To<a class="headerlink" href="#dynamic-reply-to" title="Permalink to this headline">¶</a></h3>
+<p>Dynamic reply-to can be used to obtain a reply-to address that routes
+back to a client’s receiving link regardless of how many hops it has to
+take to get there. To illustrate this feature, see below a simple
+program (written in C++ against the qpid::messaging API) that queries
+the management agent of the attached router for a list of other known
+routers’ management addresses.</p>
+<div class="highlight-python"><pre>#include <qpid/messaging/Address.h>
+#include <qpid/messaging/Connection.h>
+#include <qpid/messaging/Message.h>
+#include <qpid/messaging/Receiver.h>
+#include <qpid/messaging/Sender.h>
+#include <qpid/messaging/Session.h>
+
+using namespace qpid::messaging;
+using namespace qpid::types;
+
+using std::stringstream;
+using std::string;
+
+int main() {
+ const char* url = "amqp:tcp:127.0.0.1:5672";
+ std::string connectionOptions = "{protocol:amqp1.0}";
+
+ Connection connection(url, connectionOptions);
+ connection.open();
+ Session session = connection.createSession();
+ Sender sender = session.createSender("mgmt");
+
+ // create reply receiver and get the reply-to address
+ Receiver receiver = session.createReceiver("#");
+ Address responseAddress = receiver.getAddress();
+
+ Message request;
+ request.setReplyTo(responseAddress);
+ request.setProperty("x-amqp-to", "amqp:/_local/$management");
+ request.setProperty("operation", "DISCOVER-MGMT-NODES");
+ request.setProperty("type", "org.amqp.management");
+ request.setProperty("name, "self");
+
+ sender.send(request);
+ Message response = receiver.fetch();
+ Variant content(response.getContentObject());
+ std::cout << "Response: " << content << std::endl << std::endl;
+
+ connection.close();
+}</pre>
+</div>
+<p>The equivalent program written in Python against the Proton Messenger
+API:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">proton</span> <span class="kn">import</span> <span class="n">Messenger</span><span class="p">,</span> <span class="n">Message</span>
+
+<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="s">"0.0.0.0:5672"</span>
+
+ <span class="n">messenger</span> <span class="o">=</span> <span class="n">Messenger</span><span class="p">()</span>
+ <span class="n">messenger</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
+ <span class="n">messenger</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s">"amqp:/*"</span><span class="p">,</span> <span class="s">"amqp://</span><span class="si">%s</span><span class="s">/$1"</span> <span class="o">%</span> <span class="n">host</span><span class="p">)</span>
+ <span class="n">reply_subscription</span> <span class="o">=</span> <span class="n">messenger</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="s">"amqp:/#"</span><span class="p">)</span>
+ <span class="n">reply_address</span> <span class="o">=</span> <span class="n">reply_subscription</span><span class="o">.</span><span class="n">address</span>
+
+ <span class="n">request</span> <span class="o">=</span> <span class="n">Message</span><span class="p">()</span>
+ <span class="n">response</span> <span class="o">=</span> <span class="n">Message</span><span class="p">()</span>
+
+ <span class="n">request</span><span class="o">.</span><span class="n">address</span> <span class="o">=</span> <span class="s">"amqp:/_local/$management"</span>
+ <span class="n">request</span><span class="o">.</span><span class="n">reply_to</span> <span class="o">=</span> <span class="n">reply_address</span>
+ <span class="n">request</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="p">{</span><span class="s">u'operation'</span> <span class="p">:</span> <span class="s">u'DISCOVER-MGMT-NODES'</span><span class="p">,</span>
+ <span class="s">u'type'</span> <span class="p">:</span> <span class="s">u'org.amqp.management'</span><span class="p">,</span>
+ <span class="s">u'name'</span> <span class="p">:</span> <span class="s">u'self'</span><span class="p">}</span>
+
+ <span class="n">messenger</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
+ <span class="n">messenger</span><span class="o">.</span><span class="n">send</span><span class="p">()</span>
+ <span class="n">messenger</span><span class="o">.</span><span class="n">recv</span><span class="p">()</span>
+ <span class="n">messenger</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
+
+ <span class="k">print</span> <span class="s">"Response: </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span> <span class="n">response</span><span class="o">.</span><span class="n">body</span>
+
+ <span class="n">messenger</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
+
+<span class="n">main</span><span class="p">()</span>
+</pre></div>
+</div>
+</div>
+</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><a href="../index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Apache Qpid <http://qpid.apache.org/>.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/genindex.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/genindex.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/genindex.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/genindex.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,95 @@
+
+
+
+
+<!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>Index — Qpid Dispatch 0.4 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.4',
+ 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="Qpid Dispatch 0.4 documentation" href="index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="#" title="General Index"
+ accesskey="I">index</a></li>
+ <li><a href="index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+
+
+
+<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">
+
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+
+</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="#" title="General Index"
+ >index</a></li>
+ <li><a href="index.html">Qpid Dispatch 0.4 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2013, Apache Qpid <http://qpid.apache.org/>.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org