From 6c99eda3cdf6a6a068baf8302e23a396f5d6153e Mon Sep 17 00:00:00 2001
From: Gordon Sim <gsim@apache.org>
Date: Thu, 29 Oct 2009 11:12:32 +0000
Subject: Added extra info to doxygen comments regarding use of
 SubscriptionManager::get().

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@830896 13f79535-47bb-0310-9956-ffa450edef68
---
 qpid/cpp/include/qpid/client/SubscriptionManager.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'qpid/cpp/include')

diff --git a/qpid/cpp/include/qpid/client/SubscriptionManager.h b/qpid/cpp/include/qpid/client/SubscriptionManager.h
index 632efe0f70..e70e05f73a 100644
--- a/qpid/cpp/include/qpid/client/SubscriptionManager.h
+++ b/qpid/cpp/include/qpid/client/SubscriptionManager.h
@@ -164,6 +164,9 @@ class SubscriptionManager : public sys::Runnable, public Handle<SubscriptionMana
 
 
     /** 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 @@ class SubscriptionManager : public sys::Runnable, public Handle<SubscriptionMana
     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.
-- 
cgit v1.2.1