summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrancesco Mazzoli <francesco@rabbitmq.com>2012-04-19 18:55:34 +0100
committerFrancesco Mazzoli <francesco@rabbitmq.com>2012-04-19 18:55:34 +0100
commita03f41b8beeca6306fc149894b9ae5680db5b0cf (patch)
tree65bb8fcd26a45ab2428b2100fc7a0d62d80fff08
parent01aa6010d87a4e4870360d5523fd05c58f1d1990 (diff)
downloadrabbitmq-server-a03f41b8beeca6306fc149894b9ae5680db5b0cf.tar.gz
Update comment for bq:dropwhile spec
-rw-r--r--src/rabbit_backing_queue.erl7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/rabbit_backing_queue.erl b/src/rabbit_backing_queue.erl
index f069575f..150c2551 100644
--- a/src/rabbit_backing_queue.erl
+++ b/src/rabbit_backing_queue.erl
@@ -118,9 +118,10 @@
%% be ignored.
-callback drain_confirmed(state()) -> {[rabbit_guid:guid()], state()}.
-%% Drop messages from the head of the queue while the supplied
-%% predicate returns true. A callback function is supplied allowing
-%% callers access to messages that are about to be dropped.
+%% Drop messages from the head of the queue while the supplied predicate returns
+%% true. Also accepts a boolean parameter that determines whether the messages
+%% are to be acked or not. If they are, the messages and the acktags are
+%% returned.
-callback dropwhile(msg_pred(), true, state())
-> {[{rabbit_types:basic_message(), ack()}], state()};
(msg_pred(), false, state())