summaryrefslogtreecommitdiff
path: root/qpid/cpp
diff options
context:
space:
mode:
authorRobert Gemmell <robbie@apache.org>2010-11-22 23:34:33 +0000
committerRobert Gemmell <robbie@apache.org>2010-11-22 23:34:33 +0000
commitbfd07dc5e87c63803dcb45c492a4746d8a9fc391 (patch)
tree64a174bd50bdfeb5a0fd7df69b143824b6b86ad2 /qpid/cpp
parentf8c3956720ffa7277f801372e2aa7614800bfdec (diff)
downloadqpid-python-bfd07dc5e87c63803dcb45c492a4746d8a9fc391.tar.gz
copy updated readme files from trunk, because I cant be bothered doing that many merges :)
git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/0.8-release-candidates@1037942 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp')
-rw-r--r--qpid/cpp/README.txt46
-rw-r--r--qpid/cpp/examples/README.txt72
2 files changed, 104 insertions, 14 deletions
diff --git a/qpid/cpp/README.txt b/qpid/cpp/README.txt
index a16dec09c4..f200802342 100644
--- a/qpid/cpp/README.txt
+++ b/qpid/cpp/README.txt
@@ -1,5 +1,5 @@
- Qpid/C++
- ========
+ Qpid/C++
+ ========
Table of Contents
=================
@@ -17,22 +17,40 @@ This release of Qpid/C++ implements the AMQP 0-10.
It will not inter-operate with AMQP 0-8/0-9 implementations.
For additional software or information on the Qpid project go to:
-http://cwiki.apache.org/qpid/
+
+ http://qpid.apache.org
+
+For documentation, go to:
+
+ http://qpid.apache.org/documentation
2. Available Documentation
==========================
- - INSTALL - How to install Qpid/C++.
- - SSL - How to setup SSL
- - 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.
+ - INSTALL - How to install Qpid/C++.
+ - SSL - How to setup SSL
+ - 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.
3. Quick start
==============
-If you are impatient to get on, ./configure && make will usually be
-sufficient 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.
+
+In C++ distributions:
+
+ ./configure && make - compiles all sources
+
+ make check - runs tests
+
+ make install - installs the client and daemon
+
+In some distributions, no ./configure file is provided. To create the
+./configure file, you must have autotools installed. Run ./bootstrap
+from the qpid/cpp directory, then follow the above instructions.
+
+The INSTALL notes contain more detailed information on compiling and
+installing this software.
+
+qpid/cpp/examples/README.txt describes the C++ client API examples.
diff --git a/qpid/cpp/examples/README.txt b/qpid/cpp/examples/README.txt
index 7dc31aa645..494dab7cd9 100644
--- a/qpid/cpp/examples/README.txt
+++ b/qpid/cpp/examples/README.txt
@@ -4,6 +4,77 @@ This directory contains example C++ programs for Apache Qpid. They are
based on the 0-10 version of the AMQP specification (see www.amqp.org for
details). A short description of each example follows.
+= Messaging API Examples =
+
+Qpid now uses a new, simpler API called the Messaging API. The
+examples that use this API are in the cpp/examples/messaging
+directory. If you are new to Qpid, we encourage you to start with
+these examples.
+
+== hello_world.cpp ==
+
+hello_world.cpp is a simple example that creates a Sender and a
+Receiver for the same address, sends a message to the address, reads
+it, and prints it:
+
+$ ./hello_world
+Hello world!
+
+By default, this program connects to a broker running on
+localhost:5672. You can specify a host and port explicitly on the
+command line:
+
+$ ./hello_world localhost:5673
+
+== drain.cpp, spout.cpp ==
+
+drain and spout provide many features for sending or receiving
+messages. Use --help to see all available options.
+
+To learn how to specify various kinds of addresses using these
+programs, read the chapter on Addresses here:
+
+ http://qpid.apache.org/books/0.7/Programming-In-Apache-Qpid/html/
+
+If you do not have qpid-config installed, you can create queues
+explicitly as part of an address. For instance, to create a queue
+named 'hello-world' and send a message to it, you can use spout as
+follows:
+
+$ ./spout "hello-world ; { create: always }"
+
+Now you can read the message from this queue using drain:
+
+$ ./drain hello-world
+
+Message(properties={spout-id:c877e622-d57b-4df2-bf3e-6014c68da0ea:0}, content='')
+
+
+== map_sender.cpp, map_receiver.cpp ==
+
+These examples show how to send and receive typed data. Send the data
+with map_sender, then receive it with map_receiver:
+
+$ ./map_sender
+$ ./map_receiver
+{colours:[red, green, white], id:987654321, name:Widget, percent:0.98999999999999999, uuid:34935b4a-fd55-4212-9c41-e5baebc6e7a5}
+
+
+== hello-xml.cpp ==
+
+This example shows how to route XML messages with an XQuery using an
+XML Exchange.
+
+$ ./hello_xml
+<weather><station>Raleigh-Durham International Airport (KRDU)</station><wind_speed_mph>16</wind_speed_mph><temperature_f>70</temperature_f><dewpoint>35</dewpoint></weather>
+
+
+= Examples that use the Legacy API =
+
+The following examples use an older API that is now deprecated. If you
+are new to Qpid, we encourage you to use the Messaging API
+instead. These examples may not be part of future distributions.
+
Please note that by default these examples attempt to connect to a Qpid
broker running on the local host (127.0.0.1) at the standard AMQP port (5672).
It is possible to instruct the examples to connect to an alternate broker
@@ -25,6 +96,7 @@ on Windows. The default install locations are:
In a C++ source distribution the broker is located in the src subdirectory
(generally, from this examples directory, ../src).
+
== Direct ==
This example shows how to create Point-to-Point applications using Qpid. This