blob: ee7fc533a315de6c65650df2b196ac685d5e6f0d (
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
|
/*
*
* 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.client.util;
import java.util.Iterator;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A blocking queue that emits events above a user specified threshold allowing the caller to take action (e.g. flow
* control) to try to prevent the queue growing (much) further. The underlying queue itself is not bounded therefore the
* caller is not obliged to react to the events. <p/> This implementation is <b>only</b> safe where we have a single
* thread adding items and a single (different) thread removing items.
*
* @todo Make this implement java.util.Queue and hide the implementation. Then different queue types can be substituted.
*/
public class FlowControllingBlockingQueue
{
private static final Logger _logger = LoggerFactory.getLogger(FlowControllingBlockingQueue.class);
/** This queue is bounded and is used to store messages before being dispatched to the consumer */
private final Queue _queue = new ConcurrentLinkedQueue();
private final int _flowControlHighThreshold;
private final int _flowControlLowThreshold;
private final ThresholdListener _listener;
/** We require a separate count so we can track whether we have reached the threshold */
private int _count;
private boolean disableFlowControl;
public boolean isEmpty()
{
return _queue.isEmpty();
}
public interface ThresholdListener
{
void aboveThreshold(int currentValue);
void underThreshold(int currentValue);
}
public FlowControllingBlockingQueue(int threshold, ThresholdListener listener)
{
this(threshold, threshold, listener);
}
public FlowControllingBlockingQueue(int highThreshold, int lowThreshold, ThresholdListener listener)
{
_flowControlHighThreshold = highThreshold;
_flowControlLowThreshold = lowThreshold;
_listener = listener;
if (highThreshold == 0)
{
disableFlowControl = true;
}
}
public Object take() throws InterruptedException
{
Object o = _queue.poll();
if(o == null)
{
synchronized(this)
{
while((o = _queue.poll())==null)
{
wait();
}
}
}
if (!disableFlowControl && _listener != null)
{
synchronized (_listener)
{
if (_count-- == _flowControlLowThreshold)
{
_listener.underThreshold(_count);
}
}
}
return o;
}
public void add(Object o)
{
synchronized(this)
{
_queue.add(o);
notifyAll();
}
if (!disableFlowControl && _listener != null)
{
synchronized (_listener)
{
if (++_count == _flowControlHighThreshold)
{
_listener.aboveThreshold(_count);
}
}
}
}
public Iterator iterator()
{
return _queue.iterator();
}
}
|
