You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by tr...@apache.org on 2013/09/20 19:06:51 UTC

svn commit: r1525054 - in /qpid/site: docs/components/dispatch-router/amqp-mapping.html docs/components/dispatch-router/index.html input/components/dispatch-router/amqp-mapping.md input/components/dispatch-router/index.md

Author: tross
Date: Fri Sep 20 17:06:51 2013
New Revision: 1525054

URL: http://svn.apache.org/r1525054
Log:
QPID-5001 - Added details about address formats.

Modified:
    qpid/site/docs/components/dispatch-router/amqp-mapping.html
    qpid/site/docs/components/dispatch-router/index.html
    qpid/site/input/components/dispatch-router/amqp-mapping.md
    qpid/site/input/components/dispatch-router/index.md

Modified: qpid/site/docs/components/dispatch-router/amqp-mapping.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/components/dispatch-router/amqp-mapping.html?rev=1525054&r1=1525053&r2=1525054&view=diff
==============================================================================
--- qpid/site/docs/components/dispatch-router/amqp-mapping.html (original)
+++ qpid/site/docs/components/dispatch-router/amqp-mapping.html Fri Sep 20 17:06:51 2013
@@ -68,6 +68,8 @@ the details of Dispatch Router's use of 
 
 <h2 id="sourcetarget-capabilities">Source/Target Capabilities</h2>
 
+<p>The following Capability values are used in Sources and Targets.</p>
+
 <table>
 <tbody>
 <tr><td><em>Capability</em></td><td><em>Description</em></td></tr>
@@ -75,6 +77,33 @@ the details of Dispatch Router's use of 
 </tbody>
 </table>
 
+<h2 id="addresses-and-address-formats">Addresses and Address Formats</h2>
+
+<p>The following AMQP addresses and address patterns are used within Dispatch Router.</p>
+
+<h3 id="address-patterns">Address Patterns</h3>
+
+<table>
+<tbody>
+<tr><td><em>Pattern</em></td><td><em>Description</em></td></tr>
+<tr><td>/_local/&lt;addr&gt;</td><td>An address that references a locally attached endpoint.  Messages using this address pattern shall not be routed over more than one link.</td></tr>
+<tr><td><span style="white-space: nowrap;">/_topo/&lt;area&gt;/&lt;router&gt;/&lt;addr&gt;</span></td><td>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.</td></tr>
+<tr><td>/&lt;addr&gt;</td><td>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.</td></tr>
+</tbody>
+</table>
+
+<h3 id="supported-addresses">Supported Addresses</h3>
+
+<table>
+<tbody>
+<tr><td><em>Address</em></td><td><em>Description</em></td></tr>
+<tr><td>/_local/agent</td><td>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.</td></tr>
+<tr><td><span style="white-space: nowrap;">/_topo/A2/Router.E/agent</span></td><td>The management agent at Router.E in area A2.  This address would be used by a management client wishing to access management data from a specific container that is reachable within the network.</td></tr>
+<tr><td>/_local/qdx.router</td><td>The router entity in each of the connected routers.  This address is used by a router to communicate with all of its neighboring routers.</td></tr>
+<tr><td><span style="white-space: nowrap;">/_topo/A2/Router.E/qdx.router</span></td><td>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.</td></tr>
+</tbody>
+</table>
+
       </div>
       <div id="bottom">
         <ul id="apache-navigation">

Modified: qpid/site/docs/components/dispatch-router/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/components/dispatch-router/index.html?rev=1525054&r1=1525053&r2=1525054&view=diff
==============================================================================
--- qpid/site/docs/components/dispatch-router/index.html (original)
+++ qpid/site/docs/components/dispatch-router/index.html Fri Sep 20 17:06:51 2013
@@ -113,10 +113,14 @@ involving a broker at all.</p>
 
 <h2 id="technical-details">Technical Details</h2>
 
+<div class="two-column">
+
 <ul>
 <li><a href="amqp-mapping.html">Usage of AMQP</a></li>
 </ul>
 
+</div>
+
 <h2 id="issues">Issues</h2>
 
 <p>For more information about finding and reporting bugs, see

Modified: qpid/site/input/components/dispatch-router/amqp-mapping.md
URL: http://svn.apache.org/viewvc/qpid/site/input/components/dispatch-router/amqp-mapping.md?rev=1525054&r1=1525053&r2=1525054&view=diff
==============================================================================
--- qpid/site/input/components/dispatch-router/amqp-mapping.md (original)
+++ qpid/site/input/components/dispatch-router/amqp-mapping.md Fri Sep 20 17:06:51 2013
@@ -23,6 +23,7 @@ Dispatch Router is an AMQP router and as
 codepoints, and semantics for routing over AMQP.  This page documents
 the details of Dispatch Router's use of AMQP.
 
+
 ## Delivery Annotations
 
 The following Delivery Annotation fields are defined by Dispatch Router:
@@ -32,8 +33,30 @@ The following Delivery Annotation fields
   || qdx.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. ||
   || qdx.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. ||
 
+
 ## Source/Target Capabilities
 
+The following Capability values are used in Sources and Targets.
+
   || *Capability* || *Description* ||
   || qdx.router || This capability is added to sources and targets that are used for inter-router message exchange. ||
 
+
+## Addresses and Address Formats
+
+The following AMQP addresses and address patterns are used within Dispatch Router.
+
+### Address Patterns
+
+  || *Pattern* || *Description* ||
+  || /_local/&lt;addr&gt; || An address that references a locally attached endpoint.  Messages using this address pattern shall not be routed over more than one link. ||
+  || <span style="white-space: nowrap;">/_topo/&lt;area&gt;/&lt;router&gt;/&lt;addr&gt;</span> || 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. ||
+  || /&lt;addr&gt; || 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/agent || 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. ||
+  || <span style="white-space: nowrap;">/_topo/A2/Router.E/agent</span> || The management agent at Router.E in area A2.  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/qdx.router || The router entity in each of the connected routers.  This address is used by a router to communicate with all of its neighboring routers. ||
+  || <span style="white-space: nowrap;">/_topo/A2/Router.E/qdx.router</span> || 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. ||

Modified: qpid/site/input/components/dispatch-router/index.md
URL: http://svn.apache.org/viewvc/qpid/site/input/components/dispatch-router/index.md?rev=1525054&r1=1525053&r2=1525054&view=diff
==============================================================================
--- qpid/site/input/components/dispatch-router/index.md (original)
+++ qpid/site/input/components/dispatch-router/index.md Fri Sep 20 17:06:51 2013
@@ -72,8 +72,12 @@ involving a broker at all.
 
 ## Technical Details
 
+<div class="two-column" markdown="1">
+
  - [Usage of AMQP](amqp-mapping.html)
 
+</div>
+
 ## Issues
 
 For more information about finding and reporting bugs, see



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