Author: gsim
Date: Wed Jan 23 06:37:15 2008
New Revision: 614551
URL: http://svn.apache.org/viewvc?rev=614551&view=rev
Log:
Some minor changes to doc; primarily aimed at making the list of classes
listed as client API more useful.
Modified:
incubator/qpid/trunk/qpid/cpp/rubygen/templates/Session.rb
incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckMode.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckPolicy.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Channel.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Exchange.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Execution.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/LocalQueue.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/MessageQueue.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Queue.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Session.h
incubator/qpid/trunk/qpid/cpp/src/qpid/client/SubscriptionManager.h
incubator/qpid/trunk/qpid/cpp/src/qpid/sys/BlockingQueue.h
Modified: incubator/qpid/trunk/qpid/cpp/rubygen/templates/Session.rb
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/rubygen/templates/Session.rb?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/rubygen/templates/Session.rb (original)
+++ incubator/qpid/trunk/qpid/cpp/rubygen/templates/Session.rb Wed Jan 23
06:37:15 2008
@@ -174,6 +174,7 @@
which provides the same set of functions using normal non-keyword
declarations.
+\\ingroup clientapi
EOS
}
# Session class.
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckMode.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckMode.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckMode.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckMode.h Wed Jan 23 06:37:15
2008
@@ -27,9 +27,9 @@
namespace client {
/**
- * The available acknowledgements modes.
+ * DEPRECATED
*
- * \ingroup clientapi
+ * The available acknowledgements modes for Channel (now also deprecated).
*/
enum AckMode {
/** No acknowledgement will be sent, broker can
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckPolicy.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckPolicy.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckPolicy.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/AckPolicy.h Wed Jan 23
06:37:15 2008
@@ -26,6 +26,8 @@
/**
* Policy for automatic acknowledgement of messages.
+ *
+ * \ingroup clientapi
*/
class AckPolicy
{
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Channel.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Channel.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Channel.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Channel.h Wed Jan 23 06:37:15
2008
@@ -51,11 +51,12 @@
class ReturnedMessageHandler;
/**
+ * THIS CLASS IS DEPRECATED AND WILL BE SHORTLY REMOVED
+ *
* Represents an AMQP channel, i.e. loosely a session of work. It
* is through a channel that most of the AMQP 'methods' are
* exposed.
*
- * \ingroup clientapi
*/
class Channel : private sys::Runnable
{
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Exchange.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Exchange.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Exchange.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Exchange.h Wed Jan 23
06:37:15 2008
@@ -27,6 +27,8 @@
namespace client {
/**
+ * DEPRECATED
+ *
* A 'handle' used to represent an AMQP exchange in the Channel
* methods. Exchanges are the destinations to which messages are
* published.
@@ -45,8 +47,6 @@
* (member DEFAULT_EXCHANGE) which is nameless and of type
* 'direct' and has every declared queue bound to it by queue
* name.
- *
- * \ingroup clientapi
*/
class Exchange{
const std::string name;
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Execution.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Execution.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Execution.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Execution.h Wed Jan 23
06:37:15 2008
@@ -27,6 +27,9 @@
namespace qpid {
namespace client {
+/**
+ * Provides more detailed access to the amqp 'execution layer'.
+ */
class Execution
{
public:
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/LocalQueue.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/LocalQueue.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/LocalQueue.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/LocalQueue.h Wed Jan 23
06:37:15 2008
@@ -31,6 +31,8 @@
/**
* Local representation of a remote queue.
+ *
+ * \ingroup clientapi
*/
class LocalQueue
{
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/MessageQueue.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/MessageQueue.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/MessageQueue.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/MessageQueue.h Wed Jan 23
06:37:15 2008
@@ -34,14 +34,11 @@
*
* \ingroup clientapi
*/
-class MessageQueue : public MessageListener,
- public sys::BlockingQueue<Message>
+class MessageQueue : public sys::BlockingQueue<Message>, public
MessageListener
{
- std::queue<Message> messages;
public:
void received(Message& msg)
{
- std::cout << "Adding message to queue: " << msg.getData() << std::endl;
push(msg);
}
};
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Queue.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Queue.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Queue.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Queue.h Wed Jan 23 06:37:15
2008
@@ -27,6 +27,8 @@
namespace client {
/**
+ * DEPRECATED
+ *
* A 'handle' used to represent an AMQP queue in the Channel
* methods. Creating an instance of this class does not cause the
* queue to be created on the broker. Rather, an instance of this
@@ -48,8 +50,6 @@
*
* We use the term 'temporary queue' to refer to an exclusive
* queue.
- *
- * \ingroup clientapi
*/
class Queue{
std::string name;
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Session.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Session.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Session.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Session.h Wed Jan 23 06:37:15
2008
@@ -26,6 +26,11 @@
namespace qpid {
namespace client {
+/**
+ * Session is currently just an alias for Session_0_10
+ *
+ * \ingroup clientapi
+ */
typedef Session_0_10 Session;
}} // namespace qpid::client
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/SubscriptionManager.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/SubscriptionManager.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/SubscriptionManager.h
(original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/SubscriptionManager.h Wed Jan
23 06:37:15 2008
@@ -35,6 +35,11 @@
namespace qpid {
namespace client {
+/**
+ * Utility to assist with creating subscriptions.
+ *
+ * \ingroup clientapi
+ */
class SubscriptionManager : public sys::Runnable
{
typedef sys::Mutex::ScopedLock Lock;
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/sys/BlockingQueue.h
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/sys/BlockingQueue.h?rev=614551&r1=614550&r2=614551&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/sys/BlockingQueue.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/sys/BlockingQueue.h Wed Jan 23
06:37:15 2008
@@ -29,6 +29,9 @@
namespace qpid {
namespace sys {
+/**
+ * A simple blocking queue template
+ */
template <class T>
class BlockingQueue
{
