Author: gsim
Date: Thu Oct 29 11:12:32 2009
New Revision: 830896
URL: http://svn.apache.org/viewvc?rev=830896&view=rev
Log:
Added extra info to doxygen comments regarding use of
SubscriptionManager::get().
Modified:
qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionManager.h
Modified: qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionManager.h
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionManager.h?rev=830896&r1=830895&r2=830896&view=diff
==============================================================================
--- qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionManager.h (original)
+++ qpid/trunk/qpid/cpp/include/qpid/client/SubscriptionManager.h Thu Oct 29
11:12:32 2009
@@ -164,6 +164,9 @@
/** Get a single message from a queue.
+ * (Note: this currently uses a subscription per invocation and is
+ * thus relatively expensive. The subscription is cancelled as
+ * part of each call which can trigger auto-deletion).
*...@param result is set to the message from the queue.
*...@param timeout wait up this timeout for a message to appear.
*...@return true if result was set, false if no message available after
timeout.
@@ -171,6 +174,9 @@
QPID_CLIENT_EXTERN bool get(Message& result, const std::string& queue,
sys::Duration timeout=0);
/** Get a single message from a queue.
+ * (Note: this currently uses a subscription per invocation and is
+ * thus relatively expensive. The subscription is cancelled as
+ * part of each call which can trigger auto-deletion).
*...@param timeout wait up this timeout for a message to appear.
*...@return message from the queue.
*...@throw Exception if the timeout is exceeded.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:commits-subscr...@qpid.apache.org
