1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License
%% at http://www.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and
%% limitations under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is VMware, Inc.
%% Copyright (c) 2007-2011 VMware, Inc. All rights reserved.
%%
-module(rabbit_backing_queue).
-export([behaviour_info/1]).
behaviour_info(callbacks) ->
[
%% Called on startup with a list of durable queue names. The
%% queues aren't being started at this point, but this call
%% allows the backing queue to perform any checking necessary for
%% the consistency of those queues, or initialise any other
%% shared resources.
{start, 1},
%% Called to tear down any state/resources. NB: Implementations
%% should not depend on this function being called on shutdown
%% and instead should hook into the rabbit supervision hierarchy.
{stop, 0},
%% Initialise the backing queue and its state.
{init, 3},
%% Called on queue shutdown when queue isn't being deleted.
{terminate, 1},
%% Called when the queue is terminating and needs to delete all
%% its content.
{delete_and_terminate, 1},
%% Remove all messages in the queue, but not messages which have
%% been fetched and are pending acks.
{purge, 1},
%% Publish a message.
{publish, 3},
%% Called for messages which have already been passed straight
%% out to a client. The queue will be empty for these calls
%% (i.e. saves the round trip through the backing queue).
{publish_delivered, 4},
%% Drop messages from the head of the queue while the supplied
%% predicate returns true.
{dropwhile, 2},
%% Produce the next message.
{fetch, 2},
%% Acktags supplied are for messages which can now be forgotten
%% about. Must return 1 msg_id per Ack, in the same order as Acks.
{ack, 2},
%% A publish, but in the context of a transaction.
{tx_publish, 4},
%% Acks, but in the context of a transaction.
{tx_ack, 3},
%% Undo anything which has been done in the context of the
%% specified transaction.
{tx_rollback, 2},
%% Commit a transaction. The Fun passed in must be called once
%% the messages have really been commited. This CPS permits the
%% possibility of commit coalescing.
{tx_commit, 4},
%% Reinsert messages into the queue which have already been
%% delivered and were pending acknowledgement.
{requeue, 3},
%% How long is my queue?
{len, 1},
%% Is my queue empty?
{is_empty, 1},
%% For the next three functions, the assumption is that you're
%% monitoring something like the ingress and egress rates of the
%% queue. The RAM duration is thus the length of time represented
%% by the messages held in RAM given the current rates. If you
%% want to ignore all of this stuff, then do so, and return 0 in
%% ram_duration/1.
%% The target is to have no more messages in RAM than indicated
%% by the duration and the current queue rates.
{set_ram_duration_target, 2},
%% Optionally recalculate the duration internally (likely to be
%% just update your internal rates), and report how many seconds
%% the messages in RAM represent given the current rates of the
%% queue.
{ram_duration, 1},
%% Should 'idle_timeout' be called as soon as the queue process
%% can manage (either on an empty mailbox, or when a timer
%% fires)?
{needs_idle_timeout, 1},
%% Called (eventually) after needs_idle_timeout returns
%% 'true'. Note this may be called more than once for each 'true'
%% returned from needs_idle_timeout.
{idle_timeout, 1},
%% Called immediately before the queue hibernates.
{handle_pre_hibernate, 1},
%% Exists for debugging purposes, to be able to expose state via
%% rabbitmqctl list_queues backing_queue_status
{status, 1}
];
behaviour_info(_Other) ->
undefined.
|
