summaryrefslogtreecommitdiff
path: root/java/broker/src/main/java/org/apache/qpid/server/queue/SubscriptionSet.java
blob: 871f06372521feae979c0f77cfe4c34aa2c3db3d (plain)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.server.queue;

import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.CopyOnWriteArrayList;

import org.apache.log4j.Logger;
import org.apache.qpid.AMQException;

/**
 * Holds a set of subscriptions for a queue and manages the round
 * robin-ing of deliver etc.
 */
class SubscriptionSet implements WeightedSubscriptionManager
{
    private static final Logger _log = Logger.getLogger(SubscriptionSet.class);

    /**
     * List of registered subscribers
     */
    private List<Subscription> _subscriptions = new CopyOnWriteArrayList<Subscription>();

    /**
     * Used to control the round robin delivery of content
     */
    private int _currentSubscriber;

    /**
     * Accessor for unit tests.
     */
    int getCurrentSubscriber()
    {
        return _currentSubscriber;
    }

    public void addSubscriber(Subscription subscription)
    {
        _subscriptions.add(subscription);
    }

    /**
     * Remove the subscription, returning it if it was found
     *
     * @param subscription
     * @return null if no match was found
     */
    public Subscription removeSubscriber(Subscription subscription)
    {
        boolean isRemoved = _subscriptions.remove(subscription); // TODO: possibly need O(1) operation here.
        if (isRemoved)
        {
            return subscription;
        }
        else
        {
            debugDumpSubscription(subscription);
            return null;
        }
    }

    private void debugDumpSubscription(Subscription subscription)
    {
        if (_log.isDebugEnabled())
        {
            _log.debug("Subscription " + subscription + " not found. Dumping subscriptions:");
            for (Subscription s : _subscriptions)
            {
                _log.debug("Subscription: " + s);
            }
            _log.debug("Subscription dump complete");
        }
    }

    /**
     * Return the next unsuspended subscription or null if not found.
     * <p/>
     * Performance note:
     * This method can scan all items twice when looking for a subscription that is not
     * suspended. The worst case occcurs when all subscriptions are suspended. However, it is does this
     * without synchronisation and subscriptions may be added and removed concurrently. Also note that because of
     * race conditions and when subscriptions are removed between calls to nextSubscriber, the
     * IndexOutOfBoundsException also causes the scan to start at the beginning.
     */
    public Subscription nextSubscriber(AMQMessage msg)
    {
        if (_subscriptions.isEmpty())
        {
            return null;
        }

        try
        {
            final Subscription result = nextSubscriberImpl(msg);
            if (result == null)
            {
                _currentSubscriber = 0;
                return nextSubscriberImpl(msg);
            }
            else
            {
                return result;
            }
        }
        catch (IndexOutOfBoundsException e)
        {
            _currentSubscriber = 0;
            return nextSubscriber(msg);
        }
    }

    private Subscription nextSubscriberImpl(AMQMessage msg)
    {
        final ListIterator<Subscription> iterator = _subscriptions.listIterator(_currentSubscriber);
        while (iterator.hasNext())
        {
            Subscription subscription = iterator.next();
            ++_currentSubscriber;
            subscriberScanned();

            if (!(subscription.isSuspended() || subscription.wouldSuspend(msg)))
            {
                if (subscription.hasInterest(msg))
                {
                    // if the queue is not empty then this client is ready to receive a message.
                    //FIXME the queue could be full of sent messages.
                    // Either need to clean all PDQs after sending a message
                    // OR have a clean up thread that runs the PDQs expunging the messages.
                    if (!subscription.hasFilters() || subscription.getPreDeliveryQueue().isEmpty())
                    {
                        return subscription;
                    }
                }
            }
        }

        return null;
    }

    /**
     * Overridden in test classes.
     */
    protected void subscriberScanned()
    {
    }

    public boolean isEmpty()
    {
        return _subscriptions.isEmpty();
    }

    public List<Subscription> getSubscriptions()
    {
        return _subscriptions;
    }

    public boolean hasActiveSubscribers()
    {
        for (Subscription s : _subscriptions)
        {
            if (!s.isSuspended())
            {
                return true;
            }
        }
        return false;
    }

    public int getWeight()
    {
        int count = 0;
        for (Subscription s : _subscriptions)
        {
            if (!s.isSuspended())
            {
                count++;
            }
        }
        return count;
    }

    /**
     * Notification that a queue has been deleted. This is called so that the subscription can inform the
     * channel, which in turn can update its list of unacknowledged messages.
     *
     * @param queue
     */
    public void queueDeleted(AMQQueue queue) throws AMQException
    {
        for (Subscription s : _subscriptions)
        {
            s.queueDeleted(queue);
        }
    }

    int size()
    {
        return _subscriptions.size();
    }
}