summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/client/LocalQueue.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/src/qpid/client/LocalQueue.h')
-rw-r--r--cpp/src/qpid/client/LocalQueue.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/cpp/src/qpid/client/LocalQueue.h b/cpp/src/qpid/client/LocalQueue.h
index 3be2293810..2b878b2939 100644
--- a/cpp/src/qpid/client/LocalQueue.h
+++ b/cpp/src/qpid/client/LocalQueue.h
@@ -58,11 +58,13 @@ class LocalQueue {
/** Get the next message off the local queue, or wait up to the timeout
* for message from the broker queue.
- *@exception ClosedException if subscription is closed or timeout exceeded.
+ *@param timeout wait up this timeout for a message to appear.
+ *@return message from the queue.
+ *@throw ClosedException if subscription is closed or timeout exceeded.
*/
Message get(sys::Duration timeout=sys::TIME_INFINITE);
- /** Synonym for get(). */
+ /** Synonym for get() */
Message pop(sys::Duration timeout=sys::TIME_INFINITE);
/** Return true if local queue is empty. */