summaryrefslogtreecommitdiff
path: root/src/mongo/util/queue.h
diff options
context:
space:
mode:
authorEric Milkie <milkie@10gen.com>2015-01-14 15:55:45 -0500
committerEric Milkie <milkie@10gen.com>2015-01-15 08:26:01 -0500
commitb19f1aa26afe5d8b8cbd62b067fc67a353eb48a9 (patch)
treee10158bac538f191f92d7232a357a849fdd4d17c /src/mongo/util/queue.h
parent8820ec71f6a30caf20723524426650467bdf73e2 (diff)
downloadmongo-b19f1aa26afe5d8b8cbd62b067fc67a353eb48a9.tar.gz
SERVER-16834 add comments
Diffstat (limited to 'src/mongo/util/queue.h')
-rw-r--r--src/mongo/util/queue.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/mongo/util/queue.h b/src/mongo/util/queue.h
index d6faaccddcc..214e27c164b 100644
--- a/src/mongo/util/queue.h
+++ b/src/mongo/util/queue.h
@@ -48,6 +48,8 @@ namespace mongo {
* Simple blocking queue with optional max size (by count or custom sizing function).
* A custom sizing function can optionally be given. By default the getSize function
* returns 1 for each item, resulting in size equaling the number of items queued.
+ *
+ * Note that use of this class is deprecated. This class only works with a single consumer and * a single producer.
*/
template<typename T>
class BlockingQueue : boost::noncopyable {