summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGordon Sim <gsim@apache.org>2008-08-22 09:51:55 +0000
committerGordon Sim <gsim@apache.org>2008-08-22 09:51:55 +0000
commit513a46b070c554b3f5b3ec380dd610e22859674e (patch)
treee105c8644d36ba021872082759f9f28d49775776
parent87e653db6eb29330802bf5e7bfa2ef730ad3843f (diff)
downloadqpid-python-513a46b070c554b3f5b3ec380dd610e22859674e.tar.gz
Update & correct some of the notes included with the release.
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk@688045 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--qpid/cpp/DESIGN3
-rw-r--r--qpid/cpp/README16
-rw-r--r--qpid/cpp/RELEASE_NOTES45
-rw-r--r--qpid/cpp/examples/README120
-rw-r--r--qpid/python/RELEASE_NOTES29
-rw-r--r--qpid/ruby/RELEASE_NOTES21
6 files changed, 146 insertions, 88 deletions
diff --git a/qpid/cpp/DESIGN b/qpid/cpp/DESIGN
index 7e9ba6755c..c814f1c53d 100644
--- a/qpid/cpp/DESIGN
+++ b/qpid/cpp/DESIGN
@@ -9,9 +9,8 @@ Project contains:
* Client library (lib/libqpid_client): src/qpid/client
* Broker library (lib/libqpid_broker): src/qpid/broker
* Common classes
- * src/qpid/concurrent: concurrecy
* src/qpid/framing: wire encoding/decoding
- * src/qpid/io: reading/writing
+ * src/qpid/sys: io, threading etc
* src/qpid/Exception.cpp, QpidError.cpp: Exception classes.
* Qpid Daemon (bin/qpidd): src/qpidd.cpp
diff --git a/qpid/cpp/README b/qpid/cpp/README
index e008f5b45b..7b3ceaddb2 100644
--- a/qpid/cpp/README
+++ b/qpid/cpp/README
@@ -5,6 +5,7 @@ Table of Contents
=================
1. Introduction
2. Available Documentation
+3. Quick start
1. Introduction
@@ -23,7 +24,14 @@ http://cwiki.apache.org/qpid/
==========================
- INSTALL - How to install Qpid/C++.
- RELEASE_NOTES - Release notes.
- - DESIGN - Qpid/C++ implementation.
- - LICENSE - Apache license.
- - NOTICE - Corresponds to the section 4 d of
- the Apache License, Version 2.0.
+ - DESIGN - Qpid/C++ implementation.
+ - LICENSE - Apache license.
+ - NOTICE - Corresponds to the section 4 d of
+ the Apache License, Version 2.0.
+
+3. Quick start
+==============
+If you are impatient to get on, ./configure && make will usually be
+sifficient to compile. Running make check will run tests, make install
+will install the client and daemon. For more detailed information,
+please see the INSTALL notes.
diff --git a/qpid/cpp/RELEASE_NOTES b/qpid/cpp/RELEASE_NOTES
index 819539b1ec..40031e401f 100644
--- a/qpid/cpp/RELEASE_NOTES
+++ b/qpid/cpp/RELEASE_NOTES
@@ -1,41 +1,16 @@
-Apache Incubator Qpid C++ M2 Release Notes
+Apache Incubator Qpid C++ M3 Release Notes
-------------------------------------------
-The Qpid M2 release contains support the for AMQP 0-8 specification.
-You can access the 0-8 specification using the following link.
-http://www.amqp.org/tikiwiki/tiki-index.php?page=Download
+The Qpid M3 release of the c++ client and broker support the 0-10
+version of the AMQP specification. You can access this specification
+from:
-For full details of Qpid capabilities, as they currently stand, see our
-detailed project documentation at:
+http://jira.amqp.org/confluence/display/AMQP/Download
-http://cwiki.apache.org/confluence/pages/viewpage.action?pageId=28284
-
-Please take time to go through the README file provided with the distro to get a good understanding about build system etc.
-
-
-Known Issues
-------------
-
-You can view the outstanding task list for Qpid by visiting our JIRA:
-http://issues.apache.org/jira/browse/QPID
-
-Bug QPID-437 c++ broker doesn't obey the mandatory flag
+For full details of Qpid c++ capabilities, as they currently stand,
+see our project documentation at:
+http://cwiki.apache.org/confluence/pages/viewpage.action?pageId=28284
-M2 Tasks Completed
--------------------
-
-Test QPID-412 Implement initial C++ interop tests
-Task QPID-124 Connect AMQP version from ProtocolInitiation object to all version-aware objects
-
-New Feature QPID-154 Logging/tracing for C++.
-New Feature QPID-98 implement durable exchanges
-New Feature QPID-41 Persistent storage for messages & durable queues
-
-Improvement QPID-450 C++ demos
-Improvement QPID-64 C++ cluster design.
-Improvement QPID-62 C++ event queue design.
-
-Bug QPID-481 c++ broker dosen't implement channel.flow
-Bug QPID-467 Complete Interop Testing
-Bug QPID-123 Sporadic failure on Python tests
+Please take time to go through the README file provided with the
+distro to get a good understanding about build system etc.
diff --git a/qpid/cpp/examples/README b/qpid/cpp/examples/README
index d15adce58d..fcab6b4856 100644
--- a/qpid/cpp/examples/README
+++ b/qpid/cpp/examples/README
@@ -1,26 +1,114 @@
= Qpid C++ Examples =
-For more information read examples/README.
+Apache Qpid Examples in C++ are found inside this directory, they are
+based on the 0-10 version of the AMQP specification (see amqp.org for
+details). A short description on each example is found below.
-== The Verify All Script ==
+Please note that you will have to start the Qpid broker on port 5672,
+on your localhost (127.0.0.1) before running these examples. However,
+it is possible to alternatively specify the host and port when running
+each example.
-The verify_all script will run C++ examples against itself and against the
-Python examples. The success of the script is determined by comparing its output
-against what is expected.
+ Ex:- ./declare_queues 127.0.0.1 5673
-=== Arguments ===
+The qpid C++ broker (known as qpidd) is found
+- if installed, installed as /usr/sbin/qpidd
+- in /path-to-qpid-source/cpp/src/
-The verify_all script expects the path to Qpid trunk as an argument, in order to
-setup the environment for Python examples.
+== Direct ==
-== The Verify Script ==
+This is an example on how to create Point-to-Point applications using Qpid. This
+example contains three main components.
-The verify script is capable of running one or many scripts designed to verify
-the success of Qpid examples. The verify script is utilized by the verify_all
-scripts.
+ 1. declare_queues
+ This will bind a queue to the amq.direct exchange, so that the messages sent
+ to the amq.direct exchange, with a given routing key (routing_key) are
+ delivered to a specific queue (message_queue).
+
+ 2. direct_producer
+ Publishes messages to the amq.direct exchange using the given routing key
+ (routing_key) discussed above.
+
+ 3. listener
+ Uses a message listener to listen messages from a specific queue
+ (message_queue) as discussed above.
+
+In order to run this example,
+
+On Linux:
+ # ./declare_queues
+ # ./direct_producer
+ # ./listener
+
+== Fanout ==
+
+This is an example on how to create Fanout exchange applications using Qpid.
+This example has two components unlike the previous. This is because Fanout
+exchange not needing a routing key to be specified.
+
+ 1. fanout_producer
+ Publishes a message to the amq.fanout exchange, without using a routing key.
+
+ 2. listener
+ Uses a message listener to listen messages from the amq.fanout exchange.
+
+Another difference between the above example and this example is that in the
+above example there is no requirement for the listener to be activated before
+the messages being published. However, in this example, it is required that a
+listener be active before the messages being published, if not they will be
+lost.
+
+In order to run this example,
+
+On Linux:
+ # ./listener
+ # ./fanout_producer
+
+== Publisher/Subscriber ==
+
+Showing The ability to create topic Publishers and Subscribers using Qpid is
+the main objective of this example. It is required that you subscribe first,
+before publishing any message due to the construction of this example. There
+are two main applications in this.
+
+ 1. topic_publisher
+ This application is used to publish messages to the amq.topic exchange using
+ multipart routing keys, usa.weather, europe.weather, usa.news and europe.news.
+
+ 2. topic_listener
+ This application is used to subscribe to several private queues, such as usa,
+ europe, weather and news. In here, each private queue created is bound to the
+ amq.topic exchange using bindings that match the corresponding parts of the
+ multipart routing keys.
+ Ex:- #.news will retrieve news irrespective of destination.
+
+This example also shows the use of the 'control' routing key which is used by
+control messages.
+
+In order to run this example,
+
+On Linux:
+ # ./topic_listener
+ # ./topic_publisher
+
+== Request/Response ==
+
+This example shows a simple server that will accept string from a client and
+convert them to upper case and send them back to the client. This too has two
+main application like the previous sample.
+
+ 1. client
+ This sends lines of poetry to the server.
+
+ 2. server
+ This is a simple service that will convert incoming strings to upper case and
+ send the result to amq.direct exchange on which the client listens. It uses the
+ request's reply_to property as the response's routing key.
+
+In order to run this example,
+
+On Linux:
+ # ./server
+ # ./client
-=== Verifying an individual example ===
-This will require you using the verify script, and providing the necessary sub
-script(s) it will utilize in the process. Please note that it is your
-responsibility to setup the necessary environment for the verification process
diff --git a/qpid/python/RELEASE_NOTES b/qpid/python/RELEASE_NOTES
index 7005aa83cb..0e75988ae9 100644
--- a/qpid/python/RELEASE_NOTES
+++ b/qpid/python/RELEASE_NOTES
@@ -1,25 +1,18 @@
-Apache Incubator Qpid Python M2 Release Notes
+Apache Incubator Qpid Python M3 Release Notes
-------------------------------------------
-The Qpid M2 release contains support the for AMQP 0-8 specification.
-You can access the 0-8 specification using the following link.
-http://www.amqp.org/tikiwiki/tiki-index.php?page=Download
+The Qpid M3 release of the python client contains support the for both
+ 0-8 and 0-10 of the AMQP specification as well as support for the
+non-WIP portion of the 0-9 specification. You can access these
+specficiations from:
-For full details of Qpid capabilities, as they currently stand, see our
-detailed project documentation at:
-
-http://cwiki.apache.org/confluence/pages/viewpage.action?pageId=28284
-
-Please take time to go through the README file provided with the distro.
+http://jira.amqp.org/confluence/display/AMQP/Download
+For full details of Qpid capabilities, as they currently stand, see our
+project page at:
-Known Issues/Outstanding Work
------------------------------
-
-There are no known issues for the Phyton client.
-
+http://cwiki.apache.org/confluence/display/qpid/Index
-M2 Tasks Completed
--------------------
+The README file provided contains some details on running the python
+based test suite that is included with this distro.
-Bug QPID-467 Complete Interop Testing
diff --git a/qpid/ruby/RELEASE_NOTES b/qpid/ruby/RELEASE_NOTES
index 5ea0bd8eec..1eae2e1ecb 100644
--- a/qpid/ruby/RELEASE_NOTES
+++ b/qpid/ruby/RELEASE_NOTES
@@ -1,19 +1,14 @@
-Apache Incubator Qpid Ruby M2 Release Notes
+Apache Incubator Qpid Ruby M3 Release Notes
---------------------------------------------
-The Qpid M2 release contains support the for AMQP 0-8 specification.
-You can access the 0-8 specification using the following link.
-http://www.amqp.org/tikiwiki/tiki-index.php?page=Download
+The Qpid M3 release of the ruby client contains support the for AMQP
+0-8 specification (as well as support for the non-WIP portion of the
+0-9 specification). See:
-For full details of Qpid capabilities, as they currently stand, see our
-detailed project documentation at:
+http://jira.amqp.org/confluence/display/AMQP/Download
-http://cwiki.apache.org/confluence/pages/viewpage.action?pageId=28284
+For full details of Qpid capabilities, as they currently stand, see
+our project page at:
-Please take time to go through the README file provided with the distro.
+http://cwiki.apache.org/confluence/display/qpid/Index
-
-Known Issues/Outstanding Work
------------------------------
-
-Bug QPID-467 Complete Interop Testing