summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Radestock <matthias@rabbitmq.com>2011-03-14 12:09:43 +0000
committerMatthias Radestock <matthias@rabbitmq.com>2011-03-14 12:09:43 +0000
commit80854415c2e1579d52127b9722c985c77d0791e4 (patch)
treedd8bf846bcc3a66c290c08504736aca6f3024bdb
parent69c03d61180b23a0a48d3a6bed911c11b3692107 (diff)
downloadrabbitmq-server-80854415c2e1579d52127b9722c985c77d0791e4.tar.gz
more docs
-rw-r--r--src/rabbit_backing_queue.erl12
1 files changed, 7 insertions, 5 deletions
diff --git a/src/rabbit_backing_queue.erl b/src/rabbit_backing_queue.erl
index 29d9331b..a15ff846 100644
--- a/src/rabbit_backing_queue.erl
+++ b/src/rabbit_backing_queue.erl
@@ -39,11 +39,13 @@ behaviour_info(callbacks) ->
%% 2. a boolean indicating whether the queue is durable
%% 3. a boolean indicating whether the queue is an existing queue
%% that should be recovered
- %% 4. an asynchronous callback which can be passed by the
- %% backing queue to other processes which need to call back
- %% into it when an event has occured that requires a
- %% state transition. Note that it can also be used in process.
- %% The callback accepts a function from state to state.
+ %% 4. an asynchronous callback which accepts a function from
+ %% state to state and invokes it with the current backing
+ %% queue state. This is useful for handling events, e.g. when
+ %% the backing queue does not have its own process to receive
+ %% such events, or when the processing of an event results in
+ %% a state transition the queue logic needs to know about
+ %% (such as messages getting confirmed).
%% 5. a synchronous callback. Same as the asynchronous callback
%% but waits for completion and returns 'error' on error.
{init, 5},