DISPATCH-851: Move the new book into primary position and reorg the docs
Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/f77f92cb Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/f77f92cb Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/f77f92cb Branch: refs/heads/master Commit: f77f92cbeb5cf88c9ddcd577ab4b2deadb3dedf5 Parents: 7c8f311 Author: Justin Ross <jr...@apache.org> Authored: Tue Jun 26 14:32:56 2018 -0700 Committer: Justin Ross <jr...@apache.org> Committed: Tue Jun 26 14:32:56 2018 -0700 ---------------------------------------------------------------------- CMakeLists.txt | 2 +- doc/CMakeLists.txt | 170 ---- doc/README | 48 -- doc/asciidoc.conf.in | 31 - doc/book/addressing.adoc | 133 ---- doc/book/amqp-mapping.adoc | 175 ----- doc/book/auto_links.adoc | 323 -------- doc/book/basic_usage.adoc | 203 ----- doc/book/book.adoc | 71 -- doc/book/client_compatibility.adoc | 39 - doc/book/console1.png | Bin 40412 -> 0 bytes doc/book/console_charts.png | Bin 70070 -> 0 bytes doc/book/console_entity.png | Bin 69319 -> 0 bytes doc/book/console_installation.adoc | 68 -- doc/book/console_login.png | Bin 39915 -> 0 bytes doc/book/console_operation.adoc | 71 -- doc/book/console_overview.adoc | 27 - doc/book/console_overview.png | Bin 87960 -> 0 bytes doc/book/console_schema.png | Bin 68025 -> 0 bytes doc/book/console_topology.png | Bin 67338 -> 0 bytes doc/book/default_config.adoc | 35 - doc/book/introduction.adoc | 128 --- doc/book/link_routing.adoc | 166 ---- doc/book/policy.adoc | 456 ----------- doc/book/schema_txt.py | 109 --- doc/book/theory_of_operation.adoc | 395 ---------- doc/book/tools.adoc | 92 --- doc/common/fragment-router-sasl-para.adoc | 20 - doc/common/fragment-starting-router-step.adoc | 29 - doc/index.adoc | 35 - doc/man/help2txt.py | 69 -- doc/man/qdmanage.8.adoc | 139 ---- doc/man/qdrouterd.8.adoc | 54 -- doc/man/qdrouterd.conf.5.py | 155 ---- doc/man/qdstat.8.adoc | 277 ------- doc/new-book/attributes.adoc | 78 -- doc/new-book/book.adoc | 61 -- doc/new-book/common | 1 - doc/new-book/configuration-connections.adoc | 90 --- doc/new-book/configuration-reference.adoc | 225 ------ doc/new-book/configuration-security.adoc | 773 ------------------- doc/new-book/cyrus-sasl.adoc | 90 --- doc/new-book/getting-started.adoc | 156 ---- doc/new-book/images/01-peer-to-peer.png | Bin 20101 -> 0 bytes doc/new-book/images/balanced-routing.png | Bin 43261 -> 0 bytes doc/new-book/images/brokered-messaging.png | Bin 50206 -> 0 bytes doc/new-book/images/closest-routing.png | Bin 39803 -> 0 bytes doc/new-book/images/console1.png | Bin 40412 -> 0 bytes doc/new-book/images/console_charts.png | Bin 70070 -> 0 bytes doc/new-book/images/console_entity.png | Bin 69319 -> 0 bytes doc/new-book/images/console_login.png | Bin 39915 -> 0 bytes doc/new-book/images/console_overview.png | Bin 87960 -> 0 bytes doc/new-book/images/console_schema.png | Bin 68025 -> 0 bytes doc/new-book/images/console_topology.png | Bin 67338 -> 0 bytes doc/new-book/images/link-routing.png | Bin 46968 -> 0 bytes doc/new-book/images/message-routing.png | Bin 35861 -> 0 bytes doc/new-book/images/multicast-routing.png | Bin 44923 -> 0 bytes doc/new-book/images/path-redundancy-01.png | Bin 47995 -> 0 bytes doc/new-book/images/path-redundancy-02.png | Bin 42131 -> 0 bytes .../path-redundancy-temp-decoupling-01.png | Bin 47766 -> 0 bytes .../path-redundancy-temp-decoupling-02.png | Bin 49105 -> 0 bytes doc/new-book/images/sharded-queue-01.png | Bin 28383 -> 0 bytes doc/new-book/images/sharded-queue-02.png | Bin 62233 -> 0 bytes doc/new-book/introduction.adoc | 124 --- doc/new-book/logging.adoc | 346 --------- doc/new-book/management-entities.adoc | 24 - doc/new-book/management.adoc | 38 - doc/new-book/managing-using-qdmanage.adoc | 679 ---------------- doc/new-book/monitoring-using-qdstat.adoc | 392 ---------- doc/new-book/reliability.adoc | 701 ----------------- doc/new-book/revision-info.adoc | 20 - doc/new-book/routing.adoc | 721 ----------------- .../technical-details-specifications.adoc | 190 ----- doc/new-book/theory_of_operation.adoc | 394 ---------- .../understand-router-configuration.adoc | 206 ----- doc/new-book/using-console.adoc | 126 --- doc/notes/code-conventions.txt | 32 - docs/CMakeLists.txt | 27 + docs/README.md | 40 + docs/books/CMakeLists.txt | 54 ++ .../books/common/fragment-router-sasl-para.adoc | 20 + .../common/fragment-starting-router-step.adoc | 29 + docs/books/old-user-guide/addressing.adoc | 133 ++++ docs/books/old-user-guide/amqp-mapping.adoc | 175 +++++ docs/books/old-user-guide/auto_links.adoc | 323 ++++++++ docs/books/old-user-guide/basic_usage.adoc | 203 +++++ docs/books/old-user-guide/book.adoc | 71 ++ .../old-user-guide/client_compatibility.adoc | 39 + docs/books/old-user-guide/console1.png | Bin 0 -> 40412 bytes docs/books/old-user-guide/console_charts.png | Bin 0 -> 70070 bytes docs/books/old-user-guide/console_entity.png | Bin 0 -> 69319 bytes .../old-user-guide/console_installation.adoc | 68 ++ docs/books/old-user-guide/console_login.png | Bin 0 -> 39915 bytes .../books/old-user-guide/console_operation.adoc | 71 ++ docs/books/old-user-guide/console_overview.adoc | 27 + docs/books/old-user-guide/console_overview.png | Bin 0 -> 87960 bytes docs/books/old-user-guide/console_schema.png | Bin 0 -> 68025 bytes docs/books/old-user-guide/console_topology.png | Bin 0 -> 67338 bytes docs/books/old-user-guide/default_config.adoc | 35 + docs/books/old-user-guide/introduction.adoc | 128 +++ docs/books/old-user-guide/link_routing.adoc | 166 ++++ docs/books/old-user-guide/policy.adoc | 456 +++++++++++ docs/books/old-user-guide/schema_txt.py | 109 +++ .../old-user-guide/theory_of_operation.adoc | 395 ++++++++++ docs/books/old-user-guide/tools.adoc | 92 +++ docs/books/user-guide/attributes.adoc | 78 ++ docs/books/user-guide/book.adoc | 61 ++ docs/books/user-guide/common | 1 + .../user-guide/configuration-connections.adoc | 90 +++ .../user-guide/configuration-reference.adoc | 225 ++++++ .../user-guide/configuration-security.adoc | 773 +++++++++++++++++++ docs/books/user-guide/cyrus-sasl.adoc | 90 +++ docs/books/user-guide/getting-started.adoc | 156 ++++ .../books/user-guide/images/01-peer-to-peer.png | Bin 0 -> 20101 bytes .../user-guide/images/balanced-routing.png | Bin 0 -> 43261 bytes .../user-guide/images/brokered-messaging.png | Bin 0 -> 50206 bytes .../books/user-guide/images/closest-routing.png | Bin 0 -> 39803 bytes docs/books/user-guide/images/console1.png | Bin 0 -> 40412 bytes docs/books/user-guide/images/console_charts.png | Bin 0 -> 70070 bytes docs/books/user-guide/images/console_entity.png | Bin 0 -> 69319 bytes docs/books/user-guide/images/console_login.png | Bin 0 -> 39915 bytes .../user-guide/images/console_overview.png | Bin 0 -> 87960 bytes docs/books/user-guide/images/console_schema.png | Bin 0 -> 68025 bytes .../user-guide/images/console_topology.png | Bin 0 -> 67338 bytes docs/books/user-guide/images/link-routing.png | Bin 0 -> 46968 bytes .../books/user-guide/images/message-routing.png | Bin 0 -> 35861 bytes .../user-guide/images/multicast-routing.png | Bin 0 -> 44923 bytes .../user-guide/images/path-redundancy-01.png | Bin 0 -> 47995 bytes .../user-guide/images/path-redundancy-02.png | Bin 0 -> 42131 bytes .../path-redundancy-temp-decoupling-01.png | Bin 0 -> 47766 bytes .../path-redundancy-temp-decoupling-02.png | Bin 0 -> 49105 bytes .../user-guide/images/sharded-queue-01.png | Bin 0 -> 28383 bytes .../user-guide/images/sharded-queue-02.png | Bin 0 -> 62233 bytes docs/books/user-guide/introduction.adoc | 124 +++ docs/books/user-guide/logging.adoc | 346 +++++++++ docs/books/user-guide/management-entities.adoc | 24 + docs/books/user-guide/management.adoc | 38 + .../user-guide/managing-using-qdmanage.adoc | 679 ++++++++++++++++ .../user-guide/monitoring-using-qdstat.adoc | 392 ++++++++++ docs/books/user-guide/reliability.adoc | 701 +++++++++++++++++ docs/books/user-guide/revision-info.adoc | 20 + docs/books/user-guide/routing.adoc | 721 +++++++++++++++++ .../technical-details-specifications.adoc | 190 +++++ docs/books/user-guide/theory_of_operation.adoc | 394 ++++++++++ .../understand-router-configuration.adoc | 206 +++++ docs/books/user-guide/using-console.adoc | 126 +++ docs/man/CMakeLists.txt | 125 +++ docs/man/asciidoc.conf.in | 31 + docs/man/help2txt.py | 69 ++ docs/man/qdmanage.8.adoc | 139 ++++ docs/man/qdrouterd.8.adoc | 54 ++ docs/man/qdrouterd.conf.5.py | 155 ++++ docs/man/qdstat.8.adoc | 277 +++++++ docs/notes/code-conventions.txt | 32 + 154 files changed, 8979 insertions(+), 8986 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/CMakeLists.txt b/CMakeLists.txt index 62b65a8..af2e004 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -237,7 +237,7 @@ if (NOT UNITTEST2_MISSING) endif(NOT UNITTEST2_MISSING) add_subdirectory(python) add_subdirectory(router) -add_subdirectory(doc) +add_subdirectory(docs) add_subdirectory(console) # reconfigure.in is a workaround to force cmake re-configuration. For example, http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt deleted file mode 100644 index 0fc7435..0000000 --- a/doc/CMakeLists.txt +++ /dev/null @@ -1,170 +0,0 @@ -## -## 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. -## - -# In old cmake (< 2.8) documentation is built by "make all" so set BUILD_DOC OFF -# if you don't want that. For new cmake it is only built by "make doc" -option(BUILD_DOCS "Generate documentation with 'make doc'" ON) -option(DOC_VERBOSE "Verbose output from doc tools for debugging" OFF) -option(DOC_XMLLINT "Use xmllint to verify XML output" OFF) - -if(BUILD_DOCS) - if ("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}" VERSION_LESS "2.8") - # OPTIONAL does not exist in install before 2.8 so always make and install docs - set(DOC_TARGET ALL) - macro(install_doc) - install(${ARGN}) - endmacro() - else() - macro(install_doc) - install(${ARGN} OPTIONAL) - endmacro() - endif() - - # Popular locations - set(src ${CMAKE_CURRENT_SOURCE_DIR}) - set(bin ${CMAKE_CURRENT_BINARY_DIR}) - set(tools ${CMAKE_SOURCE_DIR}/tools) - set(schema ../python/qpid_dispatch/management/qdrouter.json) - set(py_management ../python/qpid_dispatch_internal/management) - set(schema_depends ${schema} ${py_management}/schema_doc.py ${py_management}/schema.py) - - # Flags for doc tools, based on cmake options - set(ADOC_FLAGS "--conf-file=${bin}/asciidoc.conf") - set(A2X_FLAGS "--asciidoc-opts=--conf-file=${bin}/asciidoc.conf" -D${bin}) - if (DOC_VERBOSE) - set(ADOC_FLAGS ${ADOC_FLAGS} -v) - set(A2X_FLAGS ${A2X_FLAGS} -v) - endif() - if (NOT DOC_XMLLINT) - set(A2X_FLAGS ${A2X_FLAGS} --no-xmllint) - endif() - - # Generate asciidoc fragments from management schema to incorporate in text - macro(schema_gen script output) - add_custom_command( - OUTPUT ${output} - COMMAND ${RUN} -s ${script} 1> ${output} - DEPENDS ${script} ${schema_depends}) - list(APPEND GENERATED_TXT "${output}") - endmacro() - - schema_gen(${src}/book/schema_txt.py ${bin}/book/schema.adoc) - schema_gen(${src}/man/qdrouterd.conf.5.py ${bin}/man/qdrouterd.conf.5.adoc) - - # Generate asciidoc .adoc from --help output for man pages - macro(help2txt program) - get_filename_component(name ${program} NAME) - set(output ${bin}/man/${name}_help.adoc) - add_custom_command( - OUTPUT ${output} - COMMAND ${RUN} -s ${src}/man/help2txt.py ${program} --help 1> ${output} - DEPENDS ${program} ${schema_depends} ${src}/man/help2txt.py) - list(APPEND GENERATED_TXT "${output}") - endmacro() - - help2txt(${CMAKE_BINARY_DIR}/router/qdrouterd) - help2txt(${tools}/qdmanage) - help2txt(${tools}/qdstat) - - add_custom_target(doc_gen ALL DEPENDS ${GENERATED_TXT}) - install(DIRECTORY ${src}/book/ DESTINATION ${QD_DOC_INSTALL_DIR}) - - install(FILES ${bin}/book/schema.adoc DESTINATION ${QD_DOC_INSTALL_DIR}) - install(FILES ${bin}/man/qdrouterd.conf.5.adoc DESTINATION ${QD_DOC_INSTALL_DIR}) - - EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_directory ${src}/book/ ${bin}/book) - EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_directory ${src}/man/ ${bin}/man) - - find_program(ASCIIDOC_EXE asciidoc DOC "Generate HTML documentation") - if (ASCIIDOC_EXE) - configure_file(${src}/asciidoc.conf.in ${bin}/asciidoc.conf) - configure_file(${src}/index.adoc ${bin}/index.adoc) - - # Copy the book dir images for HTML viewing in the build directory. - # Don't use configure_file since it truncates .png files at 1st ^Z character - - # Copy the images. Don't use configure_file since it truncates .png files at 1st ^Z character - file(GLOB_RECURSE PNG_SRC RELATIVE ${src} *.png) - foreach(file ${PNG_SRC}) - get_filename_component(name ${file} NAME) - EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${src}/${file} ${bin}/_images/${name}) - endforeach() - - # Generate HTML - file(GLOB_RECURSE ADOC_SRC *.adoc) - foreach(source index book/book man/qdmanage.8 man/qdrouterd.8 man/qdstat.8 man/qdrouterd.conf.5) - get_filename_component(name ${source} NAME) - get_filename_component(dir ${source} PATH) - string(FIND ${name} "." dot) - if(dot GREATER 0) - string(LENGTH ${name} length) - MATH(EXPR desired_length "${length}-2") - string(SUBSTRING ${name} "0" ${desired_length} name) - endif(dot GREATER 0) - set(output ${bin}/${dir}/${name}.html) - add_custom_command( - OUTPUT ${output} ${output}.in - # Pretty .html for direct viewing. - COMMAND ${ASCIIDOC_EXE} ${ADOC_FLAGS} -o ${output} ${source}.adoc - # Raw .html.in body for inclusion in Qpid website. - COMMAND ${ASCIIDOC_EXE} ${ADOC_FLAGS} -s -o ${output}.in ${source}.adoc - DEPENDS ${source}.adoc ${GENERATED_TXT} ${ADOC_SRC} ${bin}/asciidoc.conf - WORKING_DIRECTORY ${bin} - ) - list(APPEND DOC_DEPENDS ${output}) - install_doc(FILES ${output} DESTINATION ${QD_DOC_INSTALL_DIR}) - endforeach() - - find_program(A2X_EXE a2x DOC DOC "Generate Unix man pages") - if (A2X_EXE) - # Generate man pages. - foreach(source ${bin}/man/qdmanage.8 ${bin}/man/qdrouterd.8 ${bin}/man/qdstat.8 ${bin}/man/qdrouterd.conf.5) - get_filename_component(name ${source} NAME) - get_filename_component(dir ${source} PATH) - string(REGEX REPLACE ".*\\.([0-9])$" "\\1" section ${source}) # Man section number - set(output ${bin}/${name}) - add_custom_command( - OUTPUT ${output} - COMMAND ${A2X_EXE} ${A2X_FLAGS} -f manpage -D ${bin} ${source}.adoc - DEPENDS ${source}.adoc ${GENERATED_TXT}) - list(APPEND DOC_DEPENDS ${output}) - install_doc(FILES ${output} DESTINATION ${CMAKE_INSTALL_PREFIX}/${MAN_INSTALL_DIR}/man${section}) - endforeach() - - # Generate PDF if we have the latex tool - find_program(DBLATEX_EXE dblatex "Generate PDF documentation") - if (DBLATEX_EXE) - add_custom_command( - OUTPUT ${bin}/book.pdf - COMMAND ${A2X_EXE} ${A2X_FLAGS} -f pdf ${src}/book/book.adoc - DEPENDS ${src}/book/book.adoc ${GENERATED_TXT}) - list(APPEND DOC_DEPENDS ${bin}/book.pdf) - install_doc(FILES ${bin}/book.pdf DESTINATION ${QD_DOC_INSTALL_DIR}) - else(DBLATEX_EXE) - message(STATUS "dblatex not found: not generating PDF") - endif(DBLATEX_EXE) - else(A2X_EXE) - message(STATUS "a2x not found: not generating man pages or PDF") - endif(A2X_EXE) - else(ASCIIDOC_EXE) - message(STATUS "asciidoc not found: not generating HTML, man pages or PDF") - endif(ASCIIDOC_EXE) - - add_custom_target(doc ${DOC_TARGET} DEPENDS ${DOC_DEPENDS}) -endif(BUILD_DOCS) http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/README ---------------------------------------------------------------------- diff --git a/doc/README b/doc/README deleted file mode 100644 index 52c12e4..0000000 --- a/doc/README +++ /dev/null @@ -1,48 +0,0 @@ -//// -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 -//// - -Building documentation ----------------------- - -Documentation is built when you run `make doc`. - -(On old versions of cmake it is always built, use `cmake -DBUILD_DOCS=OFF` to -prevent it being built.) - -You need the following tools to build the documentation: - -* asciidoc (8.6.8) for HTML book and man pages -* dblatex (0.3.6) for PDF book. - -The versions above are known to work, earlier versions may or may not. - -Writing documentation ---------------------- - -Documentation is written in asciidoc markup. Sub-directories: - -* 'book/': Asciidoc source for the user guide. -* 'man/': Asciidoc source for Unix man pages. -* 'notes': Developer notes: project information, design notes, or:: - anything else that's primarily of developer interest. These are not - installed. - -Some book chapters are generated by python scripts rather than being text -files. For example `schema.adoc` is generated by `schema_txt.py` from the -documentation strings in the management schema `qdrouterd.json`. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/asciidoc.conf.in ---------------------------------------------------------------------- diff --git a/doc/asciidoc.conf.in b/doc/asciidoc.conf.in deleted file mode 100644 index b122cc4..0000000 --- a/doc/asciidoc.conf.in +++ /dev/null @@ -1,31 +0,0 @@ -# -# 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. -# - -[attributes] -SYSCONF_INSTALL_DIR=${SYSCONF_INSTALL_DIR} -CMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX} -QD_DOC_INSTALL_DIR=${QD_DOC_INSTALL_DIR} -QPID_DISPATCH_VERSION=${QPID_DISPATCH_VERSION} - -generated=${CMAKE_CURRENT_BINARY_DIR} -generated_book=${CMAKE_CURRENT_BINARY_DIR}/book -generated_man=${CMAKE_CURRENT_BINARY_DIR}/man - -[footer-text] -Qpid Dispatch ${QPID_DISPATCH_VERSION} - generated {localdate} {localtime} http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/addressing.adoc ---------------------------------------------------------------------- diff --git a/doc/book/addressing.adoc b/doc/book/addressing.adoc deleted file mode 100644 index d138425..0000000 --- a/doc/book/addressing.adoc +++ /dev/null @@ -1,133 +0,0 @@ -//// -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]] -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 -~~~~~~~~~~~~~~~~ - -Routing patterns constrain the paths that a message can take across a -network. - -[width="100%",cols="18%,82%",options="header",] -|======================================================================= -|_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]] -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 -^^^^^^^^^^^^^^^ - -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. - -[width="100%",cols="20%,80%",options="header",] -|======================================================================= -|_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. -|======================================================================= http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/amqp-mapping.adoc ---------------------------------------------------------------------- diff --git a/doc/book/amqp-mapping.adoc b/doc/book/amqp-mapping.adoc deleted file mode 100644 index 4f540c5..0000000 --- a/doc/book/amqp-mapping.adoc +++ /dev/null @@ -1,175 +0,0 @@ -//// -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]] -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]] -Message Annotations -~~~~~~~~~~~~~~~~~~~ - -The following Message Annotation fields are defined by Dispatch Router: - -[width="100%",cols="23%,19%,58%",options="header",] -|======================================================================= -|_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.phase |integer |The address-phase, if not zero, for messages -flowing between routers. -|======================================================================= - -[[sourcetarget-capabilities]] -Source/Target Capabilities -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following Capability values are used in Sources and Targets. - -[width="100%",cols="19%,81%",options="header",] -|======================================================================= -|_Capability_ |_Description_ -|qd.router |This capability is added to sources and targets that are -used for inter-router message exchange. This capability denotes a link -used for router-control messages flowing between routers. - -|qd.router-data |This capability is added to sources and targets that -are used for inter-router message exchange. This capability denotes a -link used for user messages being message-routed across an inter-router -connection. -|======================================================================= - -[[dynamic-node-properties]] -Dynamic-Node-Properties -~~~~~~~~~~~~~~~~~~~~~~~ - -The following dynamic-node-properties are used by Dispatch in Sources. - -[width="100%",cols="23%,77%",options="header",] -|======================================================================= -|_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]] -Addresses and Address Formats -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following AMQP addresses and address patterns are used within -Dispatch Router. - -[[address-patterns]] -Address Patterns -^^^^^^^^^^^^^^^^ - -[width="100%",cols="38%,62%",options="header",] -|======================================================================= -|_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/0/<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. - -The '0' component immediately preceding the router-id is a placeholder -for an _area_ which may be used in the future if area routing is -implemented. - -|`<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]] -Supported Addresses -^^^^^^^^^^^^^^^^^^^ - -[width="100%",cols="36%,64%",options="header",] -|======================================================================= -|_Address_ |_Description_ -|`$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/$management` |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/qdrouter` |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]] -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. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/auto_links.adoc ---------------------------------------------------------------------- diff --git a/doc/book/auto_links.adoc b/doc/book/auto_links.adoc deleted file mode 100644 index 5ef8bc7..0000000 --- a/doc/book/auto_links.adoc +++ /dev/null @@ -1,323 +0,0 @@ -//// -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 -//// - -[[indirect-waypoints-and-auto-links]] -Indirect Waypoints and Auto-Links ---------------------------------- - -This feature was introduced in Qpid Dispatch 0.6. It is a significant -improvement on an earlier somewhat experimental feature called -Waypoints. - -Auto-link is a feature of Qpid Dispatch Router that enables a router to -actively attach a link to a node on an external AMQP container. The -obvious application for this feature is to route messages through a -queue on a broker, but other applications are possible as well. - -An auto-link manages the lifecycle of one AMQP link. If messages are to -be routed to and from a queue on a broker, then two auto-links are -needed: one for sending messages to the queue and another for receiving -messages from the queue. The container to which an auto-link attempts to -attach may be identified in one of two ways: - -_________________________________________________________________________________________ -* The name of the connector/listener that resulted in the connection of -the container, or -* The AMQP container-id of the remote container. -_________________________________________________________________________________________ - -[[queue-waypoint-example]] -Queue Waypoint Example -~~~~~~~~~~~~~~~~~~~~~~ - -Here is an example configuration for routing messages deliveries through -a pair of queues on a broker: - ----- -connector { - name: broker - role: route-container - host: <hostname> - port: <port> - saslMechanisms: ANONYMOUS -} - -address { - prefix: queue - waypoint: yes -} - -autoLink { - addr: queue.first - dir: in - connection: broker -} - -autoLink { - addr: queue.first - dir: out - connection: broker -} - -autoLink { - addr: queue.second - dir: in - connection: broker -} - -autoLink { - addr: queue.second - dir: out - connection: broker -} ----- - -The +address+ entity identifies a namespace 'queue.' that will be used -for routing messages through queues via autolinks. The four +autoLink+ entities -identify the head and tail of two queues on the broker that will be connected -via auto-links. - -If there is no broker connected, the auto-links shall remain -_inactive_. This can be observed by using the `qdstat` tool: - ---------------------------- -$ qdstat --autolinks -AutoLinks - addr dir phs extAddr link status lastErr - ======================================================== - queue.first in 1 inactive - queue.first out 0 inactive - queue.second in 1 inactive - queue.second out 0 inactive ---------------------------- - -If a broker comes online with a queue called 'queue.first', the -auto-links will attempt to activate: - --------------------- -$ qdstat --autolinks -AutoLinks - addr dir phs extAddr link status lastErr - =========================================================================== - queue.first in 1 6 active - queue.first out 0 7 active - queue.second in 1 failed Node not found: queue.second - queue.second out 0 failed Node not found: queue.second --------------------- - -Note that two of the auto-links are in _failed_ state because the queue -does not exist on the broker. - -If we now use the Qpid Proton example application `simple_send.py` to send -three messages to 'queue.first' via the router: - --------------------------- -$ python simple_send.py -a 127.0.0.1/queue.first -m3 -all messages confirmed --------------------------- - -and then look at the address statistics on the router: - ----------------------------- -$ qdstat -a -Router Addresses - class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc - ======================================================================================================== - mobile queue.first 1 balanced 0 0 0 0 0 0 0 0 0 - mobile queue.first 0 balanced 0 1 0 0 3 3 0 0 0 ----------------------------- - -we see that 'queue.first' appears twice in the list of addresses. The -+phs+, or phase column shows that there are two phases for the -address. Phase '0' is for routing message deliveries from producers to -the tail of the queue (the +out+ auto-link associated with the queue). -Phase 1 is for routing deliveries from the head of the queue to -subscribed consumers. - -Note that three deliveries have been counted in the "in" and "out" -columns for phase '0'. The "in" column represents the three messages -that arrived from `simple_send.py` and the +out+ column represents the three -deliveries to the queue on the broker. - -If we now use `simple_recv.py` to receive three messages from this address: - --------------- -$ python simple_recv.py -a 127.0.0.1:5672/queue.first -m3 -{u'sequence': int32(1)} -{u'sequence': int32(2)} -{u'sequence': int32(3)} --------------- - -We receive the three queued messages. Looking at the addresses again, we -see that phase 1 was used to deliver those messages from the queue to -the consumer. - ----------------------------- -$ qdstat -a -Router Addresses - class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc - ======================================================================================================== - mobile queue.first 1 balanced 0 0 0 0 3 3 0 0 0 - mobile queue.first 0 balanced 0 1 0 0 3 3 0 0 0 ----------------------------- - -Note that even in a multi-router network, and with multiple producers -and consumers for 'queue.first', all deliveries will be routed through -the queue on the connected broker. - -[[sharded-queue-example]] -Sharded Queue Example -~~~~~~~~~~~~~~~~~~~~~ - -Here is an extension of the above example to illustrate how Qpid -Dispatch Router can be used to create a distributed queue in which -multiple brokers share the message-queueing load. - ----- -connector { - name: broker1 - role: route-container - host: <hostname> - port: <port> - saslMechanisms: ANONYMOUS -} - -connector { - name: broker2 - role: route-container - host: <hostname> - port: <port> - saslMechanisms: ANONYMOUS -} - -address { - prefix: queue - waypoint: yes -} - -autoLink { - addr: queue.first - dir: in - connection: broker1 -} - -autoLink { - addr: queue.first - dir: out - connection: broker1 -} - -autoLink { - addr: queue.first - dir: in - connection: broker2 -} - -autoLink { - addr: queue.first - dir: out - connection: broker2 -} ----- - -In the above configuration, there are two instances of _queue.first_ on -brokers 1 and 2. Message traffic from producers to address _queue.first_ -shall be balanced between the two instance and messages from the queues -shall be balanced across the collection of subscribers to the same -address. - -[[dynamically-adding-shards]] -Dynamically Adding Shards -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Since configurable entities in the router can also be accessed via the -management protocol, we can remotely add a shard to the above example -using `qdmanage`: - ----- -qdmanage create --type org.apache.qpid.dispatch.connector host=<host> port=<port> name=broker3 -qdmanage create --type org.apache.qpid.dispatch.router.config.autoLink addr=queue.first dir=in connection=broker3 -qdmanage create --type org.apache.qpid.dispatch.router.config.autoLink addr=queue.first dir=out connection=broker3 ----- - -[[address-renaming]] -Using a Different External Address on an Auto-Link -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes, greater flexibility is needed with regard to the addressing -of a waypoint. For example, the above sharded-queue example requires -that the two instances of the queue have the same name/address. -Auto-links can be configured with an independent +externalAddr+ that -allows the waypoint to have a different address than that which is -used by the senders and receivers. - -Here's an example: - ----- -connector { - name: broker - role: route-container - host: <hostname> - port: <port> - saslMechanisms: ANONYMOUS -} - -address { - prefix: queue - waypoint: yes -} - -autoLink { - addr: queue.first - externalAddr: broker_queue - dir: in - connection: broker -} - -autoLink { - addr: queue.first - externalAddr: broker_queue - dir: out - connection: broker -} - ----- - -In the above configuration, the router network provides waypoint -routing for the address _queue.first_, where senders and receivers use -that address to send and receive messages. However, the queue on the -broker is named "broker_queue". The address is translated through the -auto-link that is established to the broker. - -In this example, the endpoints (senders and receivers) are unaware of -the _broker_queue_ address and simply interact with _queue.first_. -Likewise, the broker is unaware of the _queue.first_ address and -behaves as though a sender and a receiver is attached each using the -address _broker_queue_. - -The +qdstat+ tool shows the external address for auto-links. - --------------------- -$ qdstat --autolinks -AutoLinks - addr dir phs extAddr link status lastErr - =========================================================== - queue.first in 1 broker_queue 6 active - queue.first out 0 broker_queue 7 active --------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/basic_usage.adoc ---------------------------------------------------------------------- diff --git a/doc/book/basic_usage.adoc b/doc/book/basic_usage.adoc deleted file mode 100644 index 2eb030a..0000000 --- a/doc/book/basic_usage.adoc +++ /dev/null @@ -1,203 +0,0 @@ -//// -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 -//// - -[[basic-usage-and-examples]] -Basic Usage and Examples ------------------------- - -[[standalone-and-interior-modes]] -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 addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc - =============================================================================================================== - local $_management_internal closest 1 0 0 0 0 0 0 0 0 - local $displayname closest 1 0 0 0 0 0 0 0 0 - mobile $management 0 closest 1 0 0 0 1 0 0 1 0 - local $management closest 1 0 0 0 0 0 0 0 0 - local temp.1GThUllfR7N+BDP closest 0 1 0 0 0 0 0 0 0 ------------------------------------------------------------------------------------------------------------------ - -Note that there are a number of known addresses. _$management_ is the -address of the router's embedded management agent. -_temp.1GThUllfR7N+BDP_ 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 additional addresses which are used for inter-router -communication: - -------------------------------------------------------------------------------------------------------------------- -$ qdstat -a -Router Addresses - class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc - ================================================================================================================= - local $_management_internal closest 1 0 0 0 0 0 0 0 0 - local $displayname closest 1 0 0 0 0 0 0 0 0 - mobile $management 0 closest 1 0 0 0 1 0 0 1 0 - local $management closest 1 0 0 0 0 0 0 0 0 - local qdhello flood 1 0 0 0 0 0 0 0 10 - local qdrouter flood 1 0 0 0 0 0 0 0 0 - topo qdrouter flood 1 0 0 0 0 0 0 0 1 - local qdrouter.ma multicast 1 0 0 0 0 0 0 0 0 - topo qdrouter.ma multicast 1 0 0 0 0 0 0 0 0 - local temp.wfx54+zf+YWQF3T closest 0 1 0 0 0 0 0 0 0 -------------------------------------------------------------------------------------------------------------------- - -[[mobile-subscribers]] -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 _simple_recv.py_ -example receiver: - -------------------------------------------------- -$ python ./simple_recv.py -a 127.0.0.1/my-address -------------------------------------------------- - -This command creates a receiving link subscribed to the specified -address. To verify the subscription: - ------------------------------------------------------------------------------------------------------------------ -$ qdstat -a -Router Addresses - class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc - =============================================================================================================== - local $_management_internal closest 1 0 0 0 0 0 0 0 0 - local $displayname closest 1 0 0 0 0 0 0 0 0 - mobile $management 0 closest 1 0 0 0 2 0 0 2 0 - local $management closest 1 0 0 0 0 0 0 0 0 - mobile my-address 0 closest 0 1 0 0 0 0 0 0 0 - local temp.75_d2X23x_KOT51 closest 0 1 0 0 0 0 0 0 0 ------------------------------------------------------------------------------------------------------------------ - -You can then, in a separate command window, run a sender to produce -messages to that address: - -------------------------------------------------- -$ python ./simple_send.py -a 127.0.0.1/my-address -------------------------------------------------- - -[[dynamic-reply-to]] -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() ----------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/book.adoc ---------------------------------------------------------------------- diff --git a/doc/book/book.adoc b/doc/book/book.adoc deleted file mode 100644 index a51419a..0000000 --- a/doc/book/book.adoc +++ /dev/null @@ -1,71 +0,0 @@ -//// -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 -//// - -Qpid Dispatch Router Book -========================= -:toc: -:numbered: -:doctype: book - -include::introduction.adoc[] -include::theory_of_operation.adoc[] - -[[using-qpid-dispatch]] -Using Qpid Dispatch -------------------- - -:leveloffset: 1 - -include::default_config.adoc[] -include::tools.adoc[] -include::basic_usage.adoc[] -include::link_routing.adoc[] -include::auto_links.adoc[] - -:leveloffset: 0 - -:leveloffset: 2 - -include::policy.adoc[] - -:leveloffset: 0 - -[[technical-details-and-specifications]] -Technical Details and Specifications ------------------------------------- - -:leveloffset: 1 - -include::client_compatibility.adoc[] -include::addressing.adoc[] -include::amqp-mapping.adoc[] -include::{generated_book}/schema.adoc[] - -:leveloffset: 0 - -[[console]] -Console -------- -:leveloffset: 1 - -include::console_overview.adoc[] -include::console_installation.adoc[] -include::console_operation.adoc[] - -:leveloffset: 0 http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/client_compatibility.adoc ---------------------------------------------------------------------- diff --git a/doc/book/client_compatibility.adoc b/doc/book/client_compatibility.adoc deleted file mode 100644 index 7930240..0000000 --- a/doc/book/client_compatibility.adoc +++ /dev/null @@ -1,39 +0,0 @@ -//// -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 -//// - -[[client-compatibility]] -Client Compatibility --------------------- - -Dispatch Router should, in theory, work with any client that is -compatible with AMQP 1.0. The following clients have been tested: - -[width="100%",cols="22%,78%",options="header",] -|======================================================================= -|_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 Reactor |The Proton Reactor API is compatible with Dispatch -Router. - -|Proton Messenger |Messenger works with Dispatch Router. -|======================================================================= http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console1.png ---------------------------------------------------------------------- diff --git a/doc/book/console1.png b/doc/book/console1.png deleted file mode 100644 index f131884..0000000 Binary files a/doc/book/console1.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_charts.png ---------------------------------------------------------------------- diff --git a/doc/book/console_charts.png b/doc/book/console_charts.png deleted file mode 100644 index 169c2ca..0000000 Binary files a/doc/book/console_charts.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_entity.png ---------------------------------------------------------------------- diff --git a/doc/book/console_entity.png b/doc/book/console_entity.png deleted file mode 100644 index 130c7e7..0000000 Binary files a/doc/book/console_entity.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_installation.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_installation.adoc b/doc/book/console_installation.adoc deleted file mode 100644 index cda9f18..0000000 --- a/doc/book/console_installation.adoc +++ /dev/null @@ -1,68 +0,0 @@ -//// -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 -//// - -[[console-installation]] -Console installation --------------------- - -[[prerequisites]] -Prerequisites -~~~~~~~~~~~~~ - -The following need to be installed before running a console: - -* One or more dispatch routers. See the documentation for the dispatch -router for help in starting a router network. -* A websockets to tcp proxy. -* A web server. This can be any server capable of serving static -html/js/css/image files. - -To install a websockets to tcp proxy: - ----- -sudo dnf install python-websockify -websockify localhost:5673 localhost:5672 ----- - -This will start the proxy listening to ws traffic on port 5673 and -translating it to tcp on port 5672. One of the routers in the network -needs to have a listener configured on port 5672. That listener's role -should be 'normal'. For example: - ----- -listener { - host: 0.0.0.0 - role: normal - port: amqp - saslMechanisms: ANONYMOUS -} ----- - -[[the-console-files]] -The console files -~~~~~~~~~~~~~~~~~ - -The files for the console are located under the console/stand-alone -directory in the source tree -* 'index.html' -* 'plugin/' - -Copy these files to a directory under the the html or webapps directory -of your web server. For example, for apache tomcat the files should be -under webapps/dispatch. Then the console is available as 'http://localhost:8080/dispatch' http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_login.png ---------------------------------------------------------------------- diff --git a/doc/book/console_login.png b/doc/book/console_login.png deleted file mode 100644 index 63e22c6..0000000 Binary files a/doc/book/console_login.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_operation.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_operation.adoc b/doc/book/console_operation.adoc deleted file mode 100644 index 233ffc8..0000000 --- a/doc/book/console_operation.adoc +++ /dev/null @@ -1,71 +0,0 @@ -//// -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 -//// -[[console-operation]] -Console operation ------------------ - -[[logging-in-to-a-router-network]] -Logging in to a router network -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -image:console_login.png[image] - -Enter the address of the websockets to tcp proxy that is connected to a router in the network. - -The Autostart checkbox, when checked, will automatically log in with the previous host:port the next time you start the console. - -[[overview-page]] -Overview page -~~~~~~~~~~~~~ - -image:book/console_overview.png[image] - -On the overview page, aggregate information about routers, addresses, and connections is displayed. - -[[topology-page]] -Topology page -~~~~~~~~~~~~~ - -image:console_topology.png[image] - -This page displays the router network in a graphical form showing how the routers are connected and information about the individual routers and links. - -[[list-page]] -List page -~~~~~~~~~ - -image:console_entity.png[image] - -Displays detailed information about entities such as routers, links, addresses, memory. - -[[charts-page]] -Charts page -~~~~~~~~~~~ - -image:console_charts.png[image] - -This page displays graphs of numeric values that are on the list page. - -[[schema-page]] -Schema page -~~~~~~~~~~~ - -image:console_schema.png[image] - -This page displays the json schema that is used to manage the router network. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_overview.adoc ---------------------------------------------------------------------- diff --git a/doc/book/console_overview.adoc b/doc/book/console_overview.adoc deleted file mode 100644 index 10cf023..0000000 --- a/doc/book/console_overview.adoc +++ /dev/null @@ -1,27 +0,0 @@ -//// -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 -//// -[[console-overview]] -Console overview ----------------- - -The console is an HTML based web site that displays information about a qpid dispatch router network. - -The console requires an HTML web server that can serve static html, javascript, style sheets, and images. - -The console only provides limited information about the clients that are attached to the router network and is therfore more appropriate for administrators needing to know the layout and health of the router network. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_overview.png ---------------------------------------------------------------------- diff --git a/doc/book/console_overview.png b/doc/book/console_overview.png deleted file mode 100644 index af25f36..0000000 Binary files a/doc/book/console_overview.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_schema.png ---------------------------------------------------------------------- diff --git a/doc/book/console_schema.png b/doc/book/console_schema.png deleted file mode 100644 index ba56c7b..0000000 Binary files a/doc/book/console_schema.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/console_topology.png ---------------------------------------------------------------------- diff --git a/doc/book/console_topology.png b/doc/book/console_topology.png deleted file mode 100644 index ae4b22a..0000000 Binary files a/doc/book/console_topology.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/default_config.adoc ---------------------------------------------------------------------- diff --git a/doc/book/default_config.adoc b/doc/book/default_config.adoc deleted file mode 100644 index b0122be..0000000 --- a/doc/book/default_config.adoc +++ /dev/null @@ -1,35 +0,0 @@ -//// -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 -//// - -[[configuration]] -Configuration -------------- - -The default configuration file is installed in -'{CMAKE_INSTALL_PREFIX}/etc/qpid-dispatch/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. http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/introduction.adoc ---------------------------------------------------------------------- diff --git a/doc/book/introduction.adoc b/doc/book/introduction.adoc deleted file mode 100644 index 8a67bc9..0000000 --- a/doc/book/introduction.adoc +++ /dev/null @@ -1,128 +0,0 @@ -//// -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]] -Introduction ------------- - -[[overview]] -Overview -~~~~~~~~ - -The Dispatch router is an AMQP 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 receiver 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 difficulty 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]] -Benefits -~~~~~~~~ - -Simplifies connectivity - -* An endpoint can do all of its messaging through a single transport -connection -* Avoid opening holes in firewalls for incoming connections - -Provides messaging connectivity where there is no TCP/IP connectivity - -* A server or broker can be in a private IP network (behind a NAT -firewall) and be accessible by messaging endpoints in other networks -(learn more). - -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]] -Features -~~~~~~~~ - -* Can be deployed stand-alone or in a network of routers -** Supports arbitrary network topology - no restrictions on redundancy -+ -- Automatic route computation - adjusts quickly to changes in topology -* Provides remote access to brokers or other AMQP servers -* Security http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f77f92cb/doc/book/link_routing.adoc ---------------------------------------------------------------------- diff --git a/doc/book/link_routing.adoc b/doc/book/link_routing.adoc deleted file mode 100644 index bc52230..0000000 --- a/doc/book/link_routing.adoc +++ /dev/null @@ -1,166 +0,0 @@ -//// -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 -//// - -[[link-routing]] -Link Routing ------------- - -This feature was introduced in Qpid Dispatch 0.4. This feature was -significantly updated in Qpid Dispatch 0.6. - -Link-routing is an alternative strategy for routing messages across a -network of routers. With the existing message-routing strategy, each -router makes a routing decision on a per-message basis when the message -is delivered. Link-routing is different because it makes routing -decisions when link-attach frames arrive. A link is effectively chained -across the network of routers from the establishing node to the -destination node. Once the link is established, the transfer of message -deliveries, flow frames, and dispositions is performed across the routed -link. - -The main benefit to link-routing is that endpoints can use the full link -protocol to interact with other endpoints in far-flung parts of the -network. For example, a client can establish a receiver across the -network to a queue on a remote broker and use link credit to control -the flow of messages from the broker. Similarly, a receiver can -establish a link to a topic on a remote broker using a server-side -filter. - -Why would one want to do this? One reason is to provide client -isolation. A network like the following can be deployed: - ----- - - Public Network - +-----------------+ - | +-----+ | - | B1 | Rp | | - | +/--\-+ | - | / \ | - | / \ | - +----/--------\---+ - / \ - / \ - / \ - Private Net A / \ Private Net B - +--------------/--+ +---\-------------+ - | +---/-+ | | +--\--+ | - | B2 | Ra | | | | Rb | C1 | - | +-----+ | | +-----+ | - | | | | - | | | | - +-----------------+ +-----------------+ ----- - -The clients in Private Net B can be constrained (by firewall policy) -to only connect to the Router in their own network. Using -link-routing, these clients can access queues, topics, and other AMQP -services that are in the Public Network or even in Private Net A. - -For example, The router Ra can be configured to expose queues in -broker B2 to the network. Client C1 can then establish a connection -to Rb, the local router, open a subscribing link to "b2.event-queue", -and receive messages stored on that queue in broker B2. - -C1 is unable to create a TCP/IP connection to B1 because of its -isolation (and because B2 is itself in a private network). However, with -link routing, C1 can interact with B2 using the AMQP link protocol. - -Note that in this case, neither C1 nor B2 have been modified in any way -and neither need be aware of the fact that there is a message-router -network between them. - -[[link-routing-configuration]] -Configuration -~~~~~~~~~~~~~ - -Starting with the configured topology shown above, how is link-routing -configured to support the example described above? - -First, router Ra needs to be told how to make a connection to the broker -B2: - ------------------------------- -connector { - name: broker - role: route-container - host: <B2-url> - port: <B2-port> - saslMechanisms: ANONYMOUS -} ------------------------------- - -This _route-container_ connector tells the router how to connect to an -external AMQP container when it is needed. The name "broker" will be -used later to refer to this connection. - -Now, the router must be configured to route certain addresses to B2: - ----------------------- -linkRoute { - prefix: b2 - direction: in - connection: broker -} - -linkRoute { - prefix: b2 - direction: out - connection: broker -} ----------------------- - -The linkRoute tells router Ra that any sender or receiver that is -attached with a target or source (respectively) whos address begins with -"b2", should be routed to the broker B2 (via the route-container -connector). - -Note that receiving and sending links are configured and routed -separately. This allows configuration of link routes for listeners only -or senders only. A direction of "in" matches client senders (i.e. links -that carry messages inbound to the router network). Direction "out" -matches client receivers. - -Examples of addresses that "begin with 'b2'" include: - - * b2 - * b2.queues - * b2.queues.app1 - -When the route-container connector is configured, router Ra establishes -a connection to the broker. Once the connection is open, Ra tells the -other routers (Rp and Rb) that it is a valid destination for link-routes -to the "b2" prefix. This means that sender or receiver links attached to -Rb or Rp will be routed via the shortest path to Ra where they are then -routed outbound to the broker B2. - -On Rp and Rb, it is advisable to add the identical configuration. It is -permissible for a linkRoute configuration to reference a connection that -does not exist. - -This configuration tells the routers that link-routing is intended to be -available for targets and sources starting with "b2". This is important -because it is possible that B2 might be unavailable or shut off. If B2 -is unreachable, Ra will not advertize itself as a destination for "b2" -and the other routers might never know that "b2" was intended for -link-routing. - -The above configuration allows Rb and Rp to reject attaches that should -be routed to B2 with an error message that indicates that there is no -route available to the destination. --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
