diff options
Diffstat (limited to 'trunk/qpid/cpp/src/qpid/doxygen_mainpage.h')
| -rw-r--r-- | trunk/qpid/cpp/src/qpid/doxygen_mainpage.h | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/trunk/qpid/cpp/src/qpid/doxygen_mainpage.h b/trunk/qpid/cpp/src/qpid/doxygen_mainpage.h new file mode 100644 index 0000000000..1502ef536e --- /dev/null +++ b/trunk/qpid/cpp/src/qpid/doxygen_mainpage.h @@ -0,0 +1,28 @@ +// This header file is just for doxygen documentation purposes. + +/** \mainpage Qpid C++ Developer Kit. + * + * The <a href=http://incubator.apache.org/qpid>Qpid project</a> provides implementations of the <a href="http://amqp.org/">AMQP messaging specification</a> in several programming language. + * + * Qpidc provides APIs and libraries to implement AMQP clients in + * C++. Qpidc clients can interact with any compliant AMQP message + * broker. The Qpid project also provides an AMQP broker daemon called + * qpidd that you can use with your qpidc clients. + * + * See the \ref clientapi "client API reference" to get started. + * + */ + + +/** + * \defgroup clientapi Application API for an AMQP client. + * + * A typical client takes the following steps: + * - Connect to the broker using qpid::client::Connection::open() + * - Create a qpid::client::Session object. + * + * Once a session is created the client can work with the broker: + * - Create and bind queues using the qpid::client::Session commands. + * - Send messages using qpid::client::Session::messageTransfer. + * - Subscribe to queues using qpid::client::SubscriptionManager + */ |