qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject svn commit: r1666288 [2/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...
Date Thu, 12 Mar 2015 20:25:45 GMT
Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/book/using.rst
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/book/using.rst?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/book/using.rst (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/book/using.rst Thu Mar 12 20:25:44 2015
@@ -0,0 +1,290 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+Using Qpid Dispatch
+===================
+
+Configuration
+-------------
+
+The default configuration file is installed in
+`install-prefix`/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.
+
+To run the router, invoke the executable: qdrouterd [-c my-config-file]
+
+For more details of the configuration file see the `qdrouterd.conf(5)`
+man page.
+
+Client Compatibility
+--------------------
+
+Dispatch Router should, in theory, work with any client that is
+compatible with AMQP 1.0. The following clients have been tested:
+
++-----------------+------------------------------------------------------------------+
+| *Client*        | *Notes*                                                          |
++=================+==================================================================+
+| qpid::messaging |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.                                                |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
+|                 |                                                                  |
++-----------------+------------------------------------------------------------------+
+| Proton Messenger| Messenger works with Dispatch Router.                            |
+|                 |                                                                  |
+|                 |                                                                  |
++-----------------+------------------------------------------------------------------+
+
+Tools
+-----
+
+qdstat
+~~~~~~
+
+*qdstat* 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:
+
++----------+-----------------------------------------------------------------------------+
+| *Option* | *Description*                                                               |
++==========+=============================================================================+
+| -l       |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 *endpoint* links and *router*        |
+|          |links. Endpoint links are attached to clients using the router. Router links |
+|          |are attached to other routers in a network of routbers.                      |
+|          |                                                                             |
++----------+-----------------------------------------------------------------------------+
+| -a       |Print a list of addresses known to the router.                               |
++----------+-----------------------------------------------------------------------------+
+| -n       |Print a list of known routers in the network.                                |
++----------+-----------------------------------------------------------------------------+
+| -c       |Print a list of connections to the router.                                   |
++----------+-----------------------------------------------------------------------------+
+
+For complete details see the `qdstat(8)` man page and the output of
+`qdstat --help`.
+
+qdmanage
+~~~~~~~~
+
+*qdmanage* is a general-purpose AMQP management client that allows you
+to not only view but modify the configuration of a running dispatch
+router.
+
+For example you can query all the connection entities in the router::
+
+   $ qdrouterd query --type connection
+
+To enable logging debug and higher level messages by default::
+
+   $ qdrouter update log/DEFAULT enable=debug+
+
+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::
+
+   $ qdrouter create type=listener port=5555
+
+Now you can connect to port 5555, for exampple::
+
+   $ qdrouterd query -b localhost:5555 --type listener
+
+For complete details see the `qdmanage(8)` man page and the output of
+`qdmanage --help`. Also for details of what can be configured see the
+`qdrouterd.conf(5)` man page.
+
+Features and Examples
+---------------------
+
+Standalone and Interior Modes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The router can operate stand-alone or as a node in a network of routers.
+The mode is configured in the *router* 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.
+
+If your router is running in stand-alone mode, *qdstat -a* will look
+like the following:
+
+::
+
+    $ 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
+
+Note that there are two known addresses. *$management* is the address of
+the router's embedded management agent. *temp.AY81ga* is the temporary
+reply-to address of the *qdstat* client making requests to the agent.
+
+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:
+
+::
+
+    $ 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
+
+Mobile Subscribers
+~~~~~~~~~~~~~~~~~~
+
+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.
+
+To illustrate a subscription on a stand-alone router, you can use the
+examples that are provided with Qpid Proton. Using the *recv.py* example
+receiver:
+
+::
+
+    $ recv.py amqp://0.0.0.0/my-address
+
+This command creates a receiving link subscribed to the specified
+address. To verify the subscription:
+
+::
+
+    $ 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
+
+You can then, in a separate command window, run a sender to produce
+messages to that address:
+
+::
+
+    $ send.py -a amqp://0.0.0.0/my-address
+
+Dynamic Reply-To
+~~~~~~~~~~~~~~~~
+
+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.
+
+::
+
+    #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();
+    }
+
+The equivalent program written in Python against the Proton Messenger
+API:
+
+::
+
+    from proton import Messenger, Message
+
+    def main():
+        host = "0.0.0.0:5672"
+
+        messenger = Messenger()
+        messenger.start()
+        messenger.route("amqp:/*", "amqp://%s/$1" % host)
+        reply_subscription = messenger.subscribe("amqp:/#")
+        reply_address = reply_subscription.address
+
+        request  = Message()
+        response = Message()
+
+        request.address = "amqp:/_local/$management"
+        request.reply_to = reply_address
+        request.properties = {u'operation' : u'DISCOVER-MGMT-NODES',
+                              u'type'      : u'org.amqp.management',
+                              u'name'      : u'self'}
+
+        messenger.put(request)
+        messenger.send()
+        messenger.recv()
+        messenger.get(response)
+
+        print "Response: %r" % response.body
+
+        messenger.stop()
+
+    main()

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/.buildinfo
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/.buildinfo?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/.buildinfo (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/.buildinfo Thu Mar 12 20:25:44 2015
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a8d4510d29fdfa85b8012bf14422c4b6
+tags: fbb0d17656682115ca4d033fb2f83ba1

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/README.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/README.html?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/README.html (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/README.html Thu Mar 12 20:25:44 2015
@@ -0,0 +1,139 @@
+
+
+<!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>Building documentation &mdash; 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> &raquo;</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="#">Building documentation</a></li>
+<li><a class="reference internal" href="#writing-documentation">Writing documentation</a></li>
+<li><a class="reference internal" href="#editing-the-book">Editing the book.</a></li>
+</ul>
+
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/README.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="building-documentation">
+<h1>Building documentation<a class="headerlink" href="#building-documentation" title="Permalink to this headline">¶</a></h1>
+<p>Build the documentation with <tt class="docutils literal"><span class="pre">make</span> <span class="pre">doc</span></tt>.</p>
+<p>If you have an older verbsion of cmake, the documentation may be built when you
+do <tt class="docutils literal"><span class="pre">make</span> <span class="pre">all</span></tt>. If so you can disable documentation build with</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">cmake</span> <span class="o">-</span><span class="n">DBUILD_DOCS</span><span class="o">=</span><span class="n">OFF</span>
+</pre></div>
+</div>
+<p>You need the following tools to build the documentation:</p>
+<ul class="simple">
+<li>python-sphinx (1.1.3) for book and man pages (requires python-docutils)</li>
+<li>doxygen (1.8) for API documentation.</li>
+<li>graphviz (2.34) for <tt class="docutils literal"><span class="pre">dot</span></tt> program needed to include diagrams in API documentation.</li>
+</ul>
+<p>The versions above are known to work, earlier versions may or may not.</p>
+</div>
+<div class="section" id="writing-documentation">
+<h1>Writing documentation<a class="headerlink" href="#writing-documentation" title="Permalink to this headline">¶</a></h1>
+<p>Documentation is written in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuedText</a></p>
+<p>All rst and html format documentation is installed in the share/doc directory.
+Man pages are also installed in the standard share/man locations.</p>
+<p>The <a class="reference external" href="http://qpid.apache.org/components/dispatch-router">dispatch web site</a>
+has pre-generated documentation for each release and a random snapshot of the
+trunk.</p>
+<p>Documentation sub-directories:</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">book/</span></tt>: Book-format documentation.</li>
+<li><tt class="docutils literal"><span class="pre">man/</span></tt>: Unix man pages.</li>
+<li><tt class="docutils literal"><span class="pre">api/</span></tt>: Generated API documentation.</li>
+<li><tt class="docutils literal"><span class="pre">notes/</span></tt>: Developer notes: project information, design notes, or
+anything else that&#8217;s primarily of developer interest. These are not
+installed.</li>
+</ul>
+</div>
+<div class="section" id="editing-the-book">
+<h1>Editing the book.<a class="headerlink" href="#editing-the-book" title="Permalink to this headline">¶</a></h1>
+<p>Most chapters of the book are <a class="reference external" href="http://docutils.sourceforge.net/rst.html">restructuredText</a> files, you can edit them with
+any text editor. See the <a class="reference external" href="http://docutils.sourceforge.net/docs/user/rst/quickref.html">quick reference</a> for a handy guide to syntax.</p>
+<p>Some chapters are generated by python scripts rather than being simple
+source files. For example <tt class="docutils literal"><span class="pre">schema.md</span></tt> is generated by <tt class="docutils literal"><span class="pre">schema_md.py</span></tt>
+from the documentation strings in the management schema
+<tt class="docutils literal"><span class="pre">qdrouterd.json</span></tt>.</p>
+</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> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2013, Apache Qpid &lt;http://qpid.apache.org/&gt;.
+      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/_sources/README.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/README.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/README.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/README.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,71 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   nspecific language governing permissions and limitations
+   under the License.
+
+Building documentation
+======================
+
+Build the documentation with ``make doc``.
+
+If you have an older verbsion of cmake, the documentation may be built when you
+do ``make all``. If so you can disable documentation build with
+
+::
+
+    cmake -DBUILD_DOCS=OFF
+
+You need the following tools to build the documentation:
+
+- python-sphinx (1.1.3) for book and man pages (requires python-docutils)
+- doxygen (1.8) for API documentation.
+- graphviz (2.34) for ``dot`` program needed to include diagrams in API documentation.
+
+The versions above are known to work, earlier versions may or may not.
+
+Writing documentation
+=====================
+
+Documentation is written in `reStructuedText <http://docutils.sourceforge.net/rst.html>`__
+
+All rst and html format documentation is installed in the share/doc directory.
+Man pages are also installed in the standard share/man locations.
+
+The `dispatch web site <http://qpid.apache.org/components/dispatch-router>`__
+has pre-generated documentation for each release and a random snapshot of the
+trunk.
+
+Documentation sub-directories:
+
+-  ``book/``: Book-format documentation.
+-  ``man/``: Unix man pages.
+-  ``api/``: Generated API documentation.
+-  ``notes/``: Developer notes: project information, design notes, or
+   anything else that's primarily of developer interest. These are not
+   installed.
+
+Editing the book.
+=================
+
+Most chapters of the book are restructuredText_ files, you can edit them with
+any text editor. See the `quick reference`_ for a handy guide to syntax.
+
+Some chapters are generated by python scripts rather than being simple
+source files. For example ``schema.md`` is generated by ``schema_md.py``
+from the documentation strings in the management schema
+``qdrouterd.json``.
+
+.. _restructuredText: http://docutils.sourceforge.net/rst.html
+.. _`quick reference`: http://docutils.sourceforge.net/docs/user/rst/quickref.html

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/addressing.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/addressing.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/addressing.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/addressing.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,127 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+Addressing
+==========
+
+AMQP addresses are used to control the flow of messages across a network
+of routers. Addresses are used in a number of different places in the
+AMQP 1.0 protocol. They can be used in a specific message in the `to`
+and `reply-to` fields of a message's properties. They are also used
+during the creation of links in the `address` field of a `source` or
+a `target`.
+
+Addresses designate various kinds of entities in a messaging network:
+
+-  Endpoint processes that consume data or offer a service
+-  Topics that match multiple consumers to multiple producers
+-  Entities within a messaging broker:
+   -  Queues
+   -  Durable Topics
+   -  Exchanges
+
+The syntax of an AMQP address is opaque as far as the router network is
+concerned. A syntactical structure may be used by the administrator that
+creates addresses, but the router treats them as opaque strings. Routers
+consider addresses to be mobile such that any address may be directly
+connected to any router in a network and may move around the topology.
+In cases where messages are broadcast to or balanced across multiple
+consumers, an address may be connected to multiple routers in the
+network.
+
+Addresses have semantics associated with them. When an address is
+created in the network, it is assigned a set of semantics (and access
+rules) during a process called provisioning. The semantics of an address
+control how routers behave when they see the address being used.
+
+Address semantics include the following considerations:
+
+-  *Routing pattern* - direct, multicast, balanced
+-  *Undeliverable action* - drop, hold and retry, redirect
+-  *Reliability* - N destinations, etc.
+
+Routing patterns
+----------------
+
+Routing patterns constrain the paths that a message can take across a
+network.
+
++---------------+-------------------------------------------------------------------------+
+| *Pattern*     | *Description*                                                           |
++===============+=========================================================================+
+| *Direct*      |Direct routing allows for only one consumer to use an address at a       |
+|               |time. Messages (or links) follow the lowest cost path across the network |
+|               |from the sender to the one receiver.                                     |
++---------------+-------------------------------------------------------------------------+
+| *Multicast*   |Multicast routing allows multiple consumers to use the same address at   |
+|               |the same time. Messages are routed such that each consumer receives a    |
+|               |copy of the message.                                                     |
++---------------+-------------------------------------------------------------------------+
+| *Balanced*    |Balanced routing also allows multiple consumers to use the same          |
+|               |address. In this case, messages are routed to exactly one of the         |
+|               |consumers, and the network attempts to balance the traffic load across   |
+|               |the set of consumers using the same address.                             |
++---------------+-------------------------------------------------------------------------+
+
+Routing mechanisms
+------------------
+
+The fact that addresses can be used in different ways suggests that
+message routing can be accomplished in different ways. Before going into
+the specifics of the different routing mechanisms, it would be good to
+first define what is meant by the term *routing*:
+
+    In a network built of multiple routers connected by connections
+    (i.e., nodes and edges in a graph), *routing* determines which
+    connection to use to send a message directly to its destination or
+    one step closer to its destination.
+
+Each router serves as the terminus of a collection of incoming and
+outgoing links. The links either connect directly to endpoints that
+produce and consume messages, or they connect to other routers in the
+network along previously established connections.
+
+Message routing
+~~~~~~~~~~~~~~~
+
+Message routing occurs upon delivery of a message and is done based on
+the address in the message's `to` field.
+
+When a delivery arrives on an incoming link, the router extracts the
+address from the delivered message's `to` field and looks the address
+up in its routing table. The lookup results in zero or more outgoing
+links onto which the message shall be resent.
+
++-----------------+-----------------------------------------------------------------------+
+| *Delivery*      | *Handling*                                                            |
++=================+=======================================================================+
+| *pre-settled*   |If the arriving delivery is pre-settled (i.e., fire and forget), the   |
+|                 |incoming delivery shall be settled by the router, and the outgoing     |
+|                 |deliveries shall also be pre-settled. In other words, the pre-settled  |
+|                 |nature of the message delivery is propagated across the network to the |
+|                 |message's destination.                                                 |
+|                 |                                                                       |
++-----------------+-----------------------------------------------------------------------+
+| *unsettled*     |Unsettled delivery is also propagated across the network. Because      |
+|                 |unsettled delivery records cannot be discarded, the router tracks the  |
+|                 |incoming deliveries and keeps the association of the incoming          |
+|                 |deliveries to the resulting outgoing deliveries. This kept association |
+|                 |allows the router to continue to propagate changes in delivery state   |
+|                 |(settlement and disposition) back and forth along the path which the   |
+|                 |message traveled.                                                      |
+|                 |                                                                       |
++-----------------+-----------------------------------------------------------------------+

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/amqp-mapping.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/amqp-mapping.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/amqp-mapping.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/amqp-mapping.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,204 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+AMQP Mapping
+============
+
+Dispatch Router is an AMQP router and as such, it provides extensions,
+code-points, and semantics for routing over AMQP. This page documents the
+details of Dispatch Router's use of AMQP.
+
+Message Annotations
+-------------------
+
+The following Message Annotation fields are defined by Dispatch Router:
+
++--------------------+------------------+-------------------------------------------------------+
+| *Field*            | *Type*           | *Description*                                         |
++====================+==================+=======================================================+
+| x-opt-qd.ingress   | string           |The identity of the ingress router for a message-routed|
+|                    |                  |message. The ingress router is the first router        |
+|                    |                  |encountered by a transiting message. The router will,  |
+|                    |                  |if this field is present, leave it unaltered. If the   |
+|                    |                  |field is not present, the router shall insert the field|
+|                    |                  |with its own identity.                                 |
+|                    |                  |                                                       |
+|                    |                  |                                                       |
+|                    |                  |                                                       |
++--------------------+------------------+-------------------------------------------------------+
+| x-opt-qd.trace     | list of string   |The list of routers through which this message-routed  |
+|                    |                  |message has transited. If this field is not present,   |
+|                    |                  |the router shall do nothing. If the field is present,  |
+|                    |                  |the router shall append its own identity to the end of |
+|                    |                  |the list.                                              |
+|                    |                  |                                                       |
+|                    |                  |                                                       |
++--------------------+------------------+-------------------------------------------------------+
+| x-opt-qd.to        | string           |To-Override for message-routed messages. If this field |
+|                    |                  |is present, the address in this field shall be used for|
+|                    |                  |routing in lieu of the *to* field in the message       |
+|                    |                  |properties. A router may append, remove, or modify this|
+|                    |                  |annotation field depending on the policy in place for  |
+|                    |                  |routing the message.                                   |
+|                    |                  |                                                       |
+|                    |                  |                                                       |
+|                    |                  |                                                       |
++--------------------+------------------+-------------------------------------------------------+
+| x-opt-qd.class     | string           |Message class. This is used to allow the router to     |
+|                    |                  |provide separate paths for different classes of        |
+|                    |                  |traffic.                                               |
++--------------------+------------------+-------------------------------------------------------+
+
+Source/Target Capabilities
+--------------------------
+
+The following Capability values are used in Sources and Targets.
+
++----------------+----------------------------------------------------------------------------+
+| *Capability*   | *Description*                                                              |
++================+============================================================================+
+| qd.router      |This capability is added to sources and targets that are used for           |
+|                |inter-router message exchange.                                              |
+|                |                                                                            |
++----------------+----------------------------------------------------------------------------+
+
+Dynamic-Node-Properties
+-----------------------
+
+The following dynamic-node-properties are used by Dispatch in Sources.
+
++--------------------+-----------------------------------------------------------------------+
+| *Property*         | *Description*                                                         |
++====================+=======================================================================+
+| x-opt-qd.address   |The node address describing the destination desired for a dynamic      |
+|                    |source. If this is absent, the router will terminate any dynamic       |
+|                    |receivers. If this address is present, the router will use the address |
+|                    |to route the dynamic link attach to the proper destination container.  |
+|                    |                                                                       |
++--------------------+-----------------------------------------------------------------------+
+
+Addresses and Address Formats
+-----------------------------
+
+The following AMQP addresses and address patterns are used within
+Dispatch Router.
+
+Address Patterns
+~~~~~~~~~~~~~~~~
+
++--------------------------------+-------------------------------------------------------+
+| *Pattern*                      | *Description*                                         |
++================================+=======================================================+
+| `_local/<addr>`                |An address that references a locally attached          |
+|                                |endpoint. Messages using this address pattern shall not|
+|                                |be routed over more than one link.                     |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
++--------------------------------+-------------------------------------------------------+
+| `_topo/<area>/<router>/<addr>` |An address that references an endpoint attached to a   |
+|                                |specific router node in the network topology. Messages |
+|                                |with addresses that follow this pattern shall be routed|
+|                                |along the shortest path to the specified router. Note  |
+|                                |that addresses of this form are a-priori routable in   |
+|                                |that the address itself contains enough information to |
+|                                |route the message to its destination.                  |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
++--------------------------------+-------------------------------------------------------+
+| `<addr>`                       |A mobile address. An address of this format represents |
+|                                |an endpoint or a set of distinct endpoints that are    |
+|                                |attached to the network in arbitrary locations. It is  |
+|                                |the responsibility of the router network to determine  |
+|                                |which router nodes are valid destinations for mobile   |
+|                                |addresses.                                             |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
+|                                |                                                       |
++--------------------------------+-------------------------------------------------------+
+
+Supported Addresses
+~~~~~~~~~~~~~~~~~~~
+
++------------------------------+------------------------------------------------------------+
+| *Address*                    | *Description*                                              |
++==============================+============================================================+
+| `_local/$management`         |The management agent on the attached router/container. This |
+|                              |address would be used by an endpoint that is a management   |
+|                              |client/console/tool wishing to access management data from  |
+|                              |the attached container.                                     |
++------------------------------+------------------------------------------------------------+
+| `_topo/0/Router.E/agent`     |The management agent at Router.E in area 0. This address    |
+|                              |would be used by a management client wishing to access      |
+|                              |management data from a specific container that is reachable |
+|                              |within the network.                                         |
++------------------------------+------------------------------------------------------------+
+| `_local/qdhello`             |The router entity in each of the connected routers. This    |
+|                              |address is used to communicate with neighbor routers and is |
+|                              |exclusively for the HELLO discovery protocol.               |
++------------------------------+------------------------------------------------------------+
+| `_local/qdrouter`            |The router entity in each of the connected routers. This    |
+|                              |address is used by a router to communicate with other       |
+|                              |routers in the network.                                     |
++------------------------------+------------------------------------------------------------+
+| `_topo/0/Router.E/qdxrouter` |The router entity at the specifically indicated router. This|
+|                              |address form is used by a router to communicate with a      |
+|                              |specific router that may or may not be a neighbor.          |
++------------------------------+------------------------------------------------------------+
+
+Implementation of the AMQP Management Specification
+---------------------------------------------------
+
+Qpid Dispatch is manageable remotely via AMQP. It is compliant with the
+emerging AMQP Management specification (draft 9).
+
+Differences from the specification:
+
+-  The `name` attribute is not required when an entity is created. If
+   not supplied it will be set to the same value as the system-generated
+   "identity" attribute. Otherwise it is treated as per the standard.
+-  The `REGISTER` and `DEREGISTER` operations are not implemented. The router
+   automatically discovers peer routers via the router network and makes
+   their management addresses available via the standard GET-MGMT-NODES
+   operation.

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/book.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/book.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/book.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/book.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,17 @@
+.. Qpid Dispatch documentation master file, created by
+   sphinx-quickstart on Tue Feb 24 11:25:59 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Qpid Dispatch Router Book
+=========================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   introduction
+   using
+   addressing
+   amqp-mapping
+   schema

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/introduction.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/introduction.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/introduction.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/introduction.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,113 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+Introduction
+============
+
+Overview
+--------
+
+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.
+
+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.
+
+The router is an intermediary for messages but it is *not* a broker. It
+does not *take responsibility for* 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, *and* it will route
+the acknowledgement of that message by the ultimate reciever back across
+the same path. This means that *responsibility* for the message is
+transfered from the original sender to the ultimate receiver *as if they
+were directly connected*. However this is done via a flexible network
+that allows highly configurable routing of the message transparent to
+both sender and receiver.
+
+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.
+
+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.
+
+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,
+*all* the receivers are connected to *all* the brokers. If there is a
+message anywhere it can be delivered to any receiver.
+
+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.
+
+Benefits
+--------
+
+Simplifies connectivity
+
+- An endpoint can do all of its messaging through a single transport connection
+- Avoid opening holes in firewalls for incoming connections
+
+Simplifies reliability
+
+- Reliability and availability are provided using redundant topology, not server clustering
+- Reliable end-to-end messaging without persistent stores
+- Use a message broker only when you need store-and-forward semantics
+
+Features
+--------
+
+-  Supports arbitrary topology - no restrictions on redundancy
+-  Automatic route computation - adjusts quickly to changes in topology
+-  Cost-based route computation
+-  `Rich addressing semantics <#addressing>`__
+-  Security

Added: qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/schema.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/schema.txt?rev=1666288&view=auto
==============================================================================
--- qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/schema.txt (added)
+++ qpid/dispatch/branches/0.4/doc/pre_built/doc/qpid-dispatch/html/_sources/book/schema.txt Thu Mar 12 20:25:44 2015
@@ -0,0 +1,828 @@
+
+Management Schema
+=================
+
+
+This chapter documents the set of *management entity types* that define
+configuration and management of a Dispatch Router. A management entity type has
+a set of *attributes* that can be read, some attributes can also be
+updated. Some entity types also support *operations* that can be called.
+
+All management entity types have the following standard attributes:
+
+*type*
+  The fully qualified type of the entity,
+  e.g. `org.apache.qpid.dispatch.router`. This document uses the short name
+  without the `org.apache.qpid.dispatch` prefix e.g. `router`. The dispatch
+  tools will accept the short or long name.
+
+*identity*
+  A system-generated identity of the entity. It includes
+  the short type name and some identifying information. E.g. `log/AGENT` or
+  `listener/localhost:amqp`
+
+There are two main categories of management entity type.
+
+*Configuration* Entities
+  Parameters that can be set in the configuration file
+  (see `qdrouterd.conf(5)` man page) or set at run-time with the `qdmanage(8)`
+  tool.
+
+*Operational* Entities
+   Run-time status values that can be queried using `qdstat(8)` or `qdmanage(8)` tools.
+
+
+Configuration Entities
+----------------------
+
+
+Configuration entities define the attributes allowed in the configuration file
+(see `qdrouterd.conf(5)`) but you can also create entities once the router is
+running using the `qdrouterd(8)` tool's `create` operation. Some entities can also
+be modified using the `update` operation, see the entity descriptions below.
+
+
+container
++++++++++
+
+Attributes related to the AMQP container.
+
+Operations allowed: `READ`
+
+
+
+*containerName* (string, `CREATE`)
+  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.
+
+*workerThreads* (integer, default=1, `CREATE`)
+  The number of threads that will be created to process message traffic and other application work (timers, non-amqp file descriptors, etc.) .
+
+*debugDump* (path, `CREATE`)
+  A file to dump debugging information that can't be logged normally.
+
+
+router
+++++++
+
+Tracks peer routers and computes routes to destinations.
+
+Operations allowed: `READ`
+
+
+
+*routerId* (string, `CREATE`)
+  Router's unique identity.
+
+*mode* (One of ['standalone', 'interior', 'edge', 'endpoint'], default='standalone', `CREATE`)
+  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.
+
+*area* (string)
+  Unused placeholder.
+
+*helloInterval* (integer, default=1, `CREATE`)
+  Interval in seconds between HELLO messages sent to neighbor routers.
+
+*helloMaxAge* (integer, default=3, `CREATE`)
+  Time in seconds after which a neighbor is declared lost if no HELLO is received.
+
+*raInterval* (integer, default=30, `CREATE`)
+  Interval in seconds between Router-Advertisements sent to all routers in a stable network.
+
+*raIntervalFlux* (integer, default=4, `CREATE`)
+  Interval in seconds between Router-Advertisements sent to all routers during topology fluctuations.
+
+*remoteLsMaxAge* (integer, default=60, `CREATE`)
+  Time in seconds after which link state is declared stale if no RA is received.
+
+*mobileAddrMaxAge* (integer, default=60, `CREATE`)
+  Deprecated - This value is no longer used in the router.
+
+*addrCount* (integer)
+  Number of addresses known to the router.
+
+*linkCount* (integer)
+  Number of links attached to the router node.
+
+*nodeCount* (integer)
+  Number of known peer router nodes.
+
+
+listener
+++++++++
+
+Listens for incoming connections to the router.
+
+Operations allowed: `CREATE`, `READ`
+
+
+
+*addr* (string, default='0.0.0.0', `CREATE`)
+  IP address: ipv4 or ipv6 literal or a host name.
+
+*port* (string, default='amqp', `CREATE`)
+  Port number or symbolic service name.
+
+*role* (One of ['normal', 'inter-router', 'on-demand'], default='normal', `CREATE`)
+  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.
+
+*certDb* (path, `CREATE`)
+  The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
+*certFile* (path, `CREATE`)
+  The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
+*keyFile* (path, `CREATE`)
+  The path to the file containing the PEM-formatted private key for the above certificate.
+
+*passwordFile* (path, `CREATE`)
+  If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
+*password* (string, `CREATE`)
+  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.
+
+*saslMechanisms* (string, required, `CREATE`)
+  Comma separated list of accepted SASL authentication mechanisms.
+
+*requirePeerAuth* (boolean, default=True, `CREATE`)
+  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.
+
+*trustedCerts* (path, `CREATE`)
+  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.
+
+*allowUnsecured* (boolean, `CREATE`)
+  For listeners using SSL only.  If set to 'yes' the listener will allow both SSL-secured clients and non-SSL clients to connect.
+
+*allowNoSasl* (boolean, `CREATE`)
+  If set to 'yes', this option causes the listener to allow clients to connect even if they skip the SASL authentication protocol.
+
+*maxFrameSize* (integer, default=65536, `CREATE`)
+  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.
+
+
+connector
++++++++++
+
+Establishes an outgoing connections from the router.
+
+Operations allowed: `CREATE`, `READ`
+
+
+
+*addr* (string, default='0.0.0.0', `CREATE`)
+  IP address: ipv4 or ipv6 literal or a host name.
+
+*port* (string, default='amqp', `CREATE`)
+  Port number or symbolic service name.
+
+*role* (One of ['normal', 'inter-router', 'on-demand'], default='normal', `CREATE`)
+  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.
+
+*certDb* (path, `CREATE`)
+  The path to the database that contains the public certificates of trusted certificate authorities (CA).
+
+*certFile* (path, `CREATE`)
+  The path to the file containing the PEM-formatted public certificate to be used on the local end of any connections using this profile.
+
+*keyFile* (path, `CREATE`)
+  The path to the file containing the PEM-formatted private key for the above certificate.
+
+*passwordFile* (path, `CREATE`)
+  If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.
+
+*password* (string, `CREATE`)
+  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.
+
+*saslMechanisms* (string, required, `CREATE`)
+  Comma separated list of accepted SASL authentication mechanisms.
+
+*allowRedirect* (boolean, default=True, `CREATE`)
+  Allow the peer to redirect this connection to another address.
+
+*maxFrameSize* (integer, default=65536, `CREATE`)
+  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.
+
+
+log
++++
+
+Configure logging for a particular module. You can use the `UPDATE` operation to change log settings while the router is running.
+
+Operations allowed: `UPDATE`, `READ`
+
+
+
+*module* (One of ['ROUTER', 'ROUTER_HELLO', 'ROUTER_LS', 'ROUTER_MA', 'MESSAGE', 'SERVER', 'AGENT', 'CONTAINER', 'CONFIG', 'ERROR', 'DISPATCH', 'DEFAULT'], required)
+  Module to configure. The special module 'DEFAULT' specifies defaults for all modules.
+
+*enable* (string, default='default', required, `UPDATE`)
+  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.
+
+*timestamp* (boolean, `UPDATE`)
+  Include timestamp in log messages.
+
+*source* (boolean, `UPDATE`)
+  Include source file and line number in log messages.
+
+*output* (string, `UPDATE`)
+  Where to send log messages. Can be 'stderr', 'syslog' or a file name.
+
+
+fixedAddress
+++++++++++++
+
+Establishes semantics for addresses starting with a prefix.
+
+Operations allowed: `CREATE`, `READ`
+
+
+
+*prefix* (string, required, `CREATE`)
+  The address prefix (always starting with '/').
+
+*phase* (integer, `CREATE`)
+  The phase of a multi-hop address passing through one or more waypoints.
+
+*fanout* (One of ['multiple', 'single'], default='multiple', `CREATE`)
+  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.
+
+*bias* (One of ['closest', 'spread'], default='closest', `CREATE`)
+  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.
+
+
+waypoint
+++++++++
+
+A remote node that messages for an address pass through.
+
+Operations allowed: `CREATE`, `READ`
+
+
+
+*address* (string, required, `CREATE`)
+  The AMQP address of the waypoint.
+
+*connector* (string, required, `CREATE`)
+  The name of the on-demand connector used to reach the waypoint's container.
+
+*inPhase* (integer, default=-1, `CREATE`)
+  The phase of the address as it is routed _to_ the waypoint.
+
+*outPhase* (integer, default=-1, `CREATE`)
+  The phase of the address as it is routed _from_ the waypoint.
+
+
+linkRoutePattern
+++++++++++++++++
+
+A pattern to match a connected container to endpoints for routed links.
+
+Operations allowed: `CREATE`, `READ`
+
+
+
+*prefix* (string, required, `CREATE`)
+  The AMQP address prefix for nodes on the container.
+
+*connector* (string, `CREATE`)
+  The name of the on-demand connector used to reach the waypoint's container.
+
+
+Operational Entities
+--------------------
+
+
+Operational entities provide statistics and other run-time attributes of the router.
+The `qdstat(8)` tool provides a convenient way to query run-time statistics.
+You can also use the general-purpose management tool `qdmanage(8)` to query
+operational attributes.
+
+
+org.amqp.management
++++++++++++++++++++
+
+The standard AMQP management node interface.
+
+Operations allowed: `QUERY`, `GET-TYPES`, `GET-ANNOTATIONS`, `GET-OPERATIONS`, `GET-ATTRIBUTES`, `GET-MGMT-NODES`, `READ`
+
+
+
+
+Operation GET-TYPES
+^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and their inheritance relationships
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-ATTRIBUTES
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and the annotations they implement
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-OPERATIONS
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and the operations they support
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-ANNOTATIONS
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation QUERY
+^^^^^^^^^^^^^^^
+
+Query for attribute values of multiple entities.
+
+**Request body**  (map)A map containing the key `attributeNames` 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.
+
+**Request properties:**
+
+*count* (integer)
+  If set, specifies the number of entries from the result set to return. If not set return all from `offset`
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+*offset* (integer)
+  If set, specifies the number of the first element of the result set to be returned.
+
+**Response body**  (map)A map with two entries. `attributeNames` is a list of the attribute names returned. `results` is a list of lists each containing the attribute values for a single entity in the same order as the names in the `attributeNames` entry. If an attribute name is not applicable for an entity then the corresponding value is `null`
+
+**Response properties:**
+
+*count* (integer)
+  Number of results returned
+
+*identity* (string)
+  Set to the value `self`
+
+
+Operation GET-MGMT-NODES
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the addresses of all management nodes known to this router
+
+**Request properties:**
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (list)A list of addresses (strings) of management nodes known to this management node.
+
+
+management
+++++++++++
+
+Qpid dispatch router extensions to the standard org.amqp.management interface.
+
+Operations allowed: `GET-SCHEMA`, `GET-JSON-SCHEMA`, `QUERY`, `GET-TYPES`, `GET-ANNOTATIONS`, `GET-OPERATIONS`, `GET-ATTRIBUTES`, `GET-MGMT-NODES`, `READ`
+
+
+
+
+Operation GET-SCHEMA-JSON
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the qdrouterd schema for this router in JSON format
+
+**Request properties:**
+
+*indent* (integer)
+  Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (string)The qdrouter schema as a JSON string.
+
+
+Operation GET-SCHEMA
+^^^^^^^^^^^^^^^^^^^^
+
+Get the qdrouterd schema for this router in AMQP map format
+
+**Request properties:**
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (map)The qdrouter schema as a map.
+
+
+router.link
++++++++++++
+
+Link to another AMQP endpoint: router node, client or other AMQP process.
+
+Operations allowed: `READ`
+
+
+
+*linkName* (string)
+
+*linkType* (One of ['endpoint', 'waypoint', 'inter-router', 'inter-area'])
+
+*linkDir* (One of ['in', 'out'])
+
+*owningAddr* (string)
+
+*eventFifoDepth* (integer)
+
+*msgFifoDepth* (integer)
+
+*remoteContainer* (string)
+
+
+router.address
+++++++++++++++
+
+AMQP address managed by the router.
+
+Operations allowed: `READ`
+
+
+
+*inProcess* (boolean)
+
+*subscriberCount* (integer)
+
+*remoteCount* (integer)
+
+*deliveriesIngress* (integer)
+
+*deliveriesEgress* (integer)
+
+*deliveriesTransit* (integer)
+
+*deliveriesToContainer* (integer)
+
+*deliveriesFromContainer* (integer)
+
+*key* (string)
+  Internal unique (to this router) key to identify the address
+
+
+router.node
++++++++++++
+
+Remote router node connected to this router.
+
+Operations allowed: `READ`
+
+
+
+*routerId* (string)
+  Remote node identifier.
+
+*instance* (integer)
+  Remote node boot number.
+
+*linkState* (list)
+  List of remote node's neighbours.
+
+*nextHop* (string)
+  Neighbour ID of next hop to remote node from here.
+
+*validOrigins* (list)
+  List of valid origin nodes for messages arriving via the remote node, used for duplicate elimination in redundant networks.
+
+*address* (string)
+  Address of the remote node
+
+*routerLink* (entityId)
+  Local link to remote node
+
+
+connection
+++++++++++
+
+Connections to the router's container.
+
+Operations allowed: `READ`
+
+
+
+*container* (string)
+  The container for this connection
+
+*state* (One of ['connecting', 'opening', 'operational', 'failed', 'user'])
+
+*host* (string)
+  IP address and port number in the form addr:port.
+
+*dir* (One of ['in', 'out'])
+  Direction of connection establishment in or out of the router.
+
+*role* (string)
+
+*sasl* (string)
+  SASL mechanism used for authentication.
+
+
+allocator
++++++++++
+
+Memory allocation pool.
+
+Operations allowed: `READ`
+
+
+
+*typeName* (string)
+
+*typeSize* (integer)
+
+*transferBatchSize* (integer)
+
+*localFreeListMax* (integer)
+
+*globalFreeListMax* (integer)
+
+*totalAllocFromHeap* (integer)
+
+*totalFreeToHeap* (integer)
+
+*heldByThreads* (integer)
+
+*batchesRebalancedToThreads* (integer)
+
+*batchesRebalancedToGlobal* (integer)
+
+
+Management Operations
+---------------------
+
+
+The `qdstat(8)` and `qdmanage(8)` tools allow you to view or modify management entity
+attributes. They work by invoking *management operations*. You can invoke these operations
+from any AMQP client by sending a message with the appropriate properties and body to the
+`$management` address. The message should have a `reply-to` address indicating where the
+response should be sent.
+
+
+Operations for all entity types
++++++++++++++++++++++++++++++++
+
+
+Operation READ
+^^^^^^^^^^^^^^
+
+Read attributes of an entity
+
+**Request properties:**
+
+*type* (string)
+  Type of desired entity.
+
+*name* (string)
+  Name of desired entity. Must supply name or identity.
+
+*identity* (string)
+  Identity of desired entity. Must supply name or identity.
+
+**Response body**  (map)Attributes of the entity
+
+
+Operation CREATE
+^^^^^^^^^^^^^^^^
+
+Create a new entity.
+
+**Request body**  (map, required)Attributes for the new entity. Can include name and/or type.
+
+**Request properties:**
+
+*type* (string, required)
+  Type of new entity.
+
+*name* (string)
+  Name of new entity. Optional, defaults to identity.
+
+**Response body**  (map)Attributes of the entity
+
+
+Operation UPDATE
+^^^^^^^^^^^^^^^^
+
+Update attributes of an entity
+
+**Request body**  (map)Attributes to update for the entity. Can include name or identity.
+
+**Request properties:**
+
+*type* (string)
+  Type of desired entity.
+
+*name* (string)
+  Name of desired entity. Must supply name or identity.
+
+*identity* (string)
+  Identity of desired entity. Must supply name or identity.
+
+**Response body**  (map)Updated attributes of the entity
+
+
+Operation DELETE
+^^^^^^^^^^^^^^^^
+
+Delete an entity
+
+**Request properties:**
+
+*type* (string)
+  Type of desired entity.
+
+*name* (string)
+  Name of desired entity. Must supply name or identity.
+
+*identity* (string)
+  Identity of desired entity. Must supply name or identity.
+
+
+Operations for `org.amqp.management` entity type
+++++++++++++++++++++++++++++++++++++++++++++++++
+
+
+Operation GET-TYPES
+^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and their inheritance relationships
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-ATTRIBUTES
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and the annotations they implement
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-OPERATIONS
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the set of entity types and the operations they support
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation GET-ANNOTATIONS
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Request properties:**
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (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.
+
+
+Operation QUERY
+^^^^^^^^^^^^^^^
+
+Query for attribute values of multiple entities.
+
+**Request body**  (map)A map containing the key `attributeNames` 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.
+
+**Request properties:**
+
+*count* (integer)
+  If set, specifies the number of entries from the result set to return. If not set return all from `offset`
+
+*entityType* (string)
+  If set, restrict query results to entities that extend (directly or indirectly) this type
+
+*identity* (string)
+  Set to the value `self`
+
+*offset* (integer)
+  If set, specifies the number of the first element of the result set to be returned.
+
+**Response body**  (map)A map with two entries. `attributeNames` is a list of the attribute names returned. `results` is a list of lists each containing the attribute values for a single entity in the same order as the names in the `attributeNames` entry. If an attribute name is not applicable for an entity then the corresponding value is `null`
+
+**Response properties:**
+
+*count* (integer)
+  Number of results returned
+
+*identity* (string)
+  Set to the value `self`
+
+
+Operation GET-MGMT-NODES
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the addresses of all management nodes known to this router
+
+**Request properties:**
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (list)A list of addresses (strings) of management nodes known to this management node.
+
+
+Operations for `management` entity type
++++++++++++++++++++++++++++++++++++++++
+
+
+Operation GET-SCHEMA-JSON
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Get the qdrouterd schema for this router in JSON format
+
+**Request properties:**
+
+*indent* (integer)
+  Number of spaces to indent the formatted result. If not specified, the result is in minimal format, no unnecessary spaces or newlines.
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (string)The qdrouter schema as a JSON string.
+
+
+Operation GET-SCHEMA
+^^^^^^^^^^^^^^^^^^^^
+
+Get the qdrouterd schema for this router in AMQP map format
+
+**Request properties:**
+
+*identity* (string)
+  Set to the value `self`
+
+**Response body**  (map)The qdrouter schema as a map.
+



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message