1 |
dl |
1.2 |
/* |
2 |
|
|
* Written by Doug Lea with assistance from members of JCP JSR-166 |
3 |
|
|
* Expert Group and released to the public domain. Use, modify, and |
4 |
|
|
* redistribute this code in any way without acknowledgement. |
5 |
|
|
*/ |
6 |
|
|
|
7 |
tim |
1.1 |
package java.util.concurrent; |
8 |
tim |
1.9 |
|
9 |
|
|
import java.util.Collection; |
10 |
tim |
1.1 |
import java.util.Queue; |
11 |
|
|
|
12 |
|
|
/** |
13 |
dl |
1.4 |
* A {@link java.util.Queue} that additionally supports operations |
14 |
brian |
1.5 |
* that wait for elements to exist when retrieving them, and wait for |
15 |
dholmes |
1.10 |
* space to exist when storing them. |
16 |
dl |
1.2 |
* |
17 |
dholmes |
1.7 |
* <p>A <tt>BlockingQueue</tt> does not accept <tt>null</tt> elements. |
18 |
dholmes |
1.10 |
* Implementations throw <tt>NullPointerException</tt> on attempts |
19 |
dl |
1.2 |
* to <tt>add</tt>, <tt>put</tt> or <tt>offer</tt> a <tt>null</tt>. A |
20 |
|
|
* <tt>null</tt> is used as a sentinel value to indicate failure of |
21 |
|
|
* <tt>poll</tt> operations. |
22 |
|
|
* |
23 |
dholmes |
1.7 |
* <p>A <tt>BlockingQueue</tt> may be capacity bounded. At any given |
24 |
|
|
* time it may have a <tt>remainingCapacity</tt> beyond which no |
25 |
dl |
1.2 |
* additional elements can be <tt>put</tt> without blocking. |
26 |
dholmes |
1.7 |
* A <tt>BlockingQueue</tt> without any intrinsic capacity constraints always |
27 |
|
|
* reports a remaining capacity of <tt>Integer.MAX_VALUE</tt>. |
28 |
dl |
1.2 |
* |
29 |
dholmes |
1.7 |
* <p> While <tt>BlockingQueue</tt> is designed to be used primarily |
30 |
dholmes |
1.10 |
* for producer-consumer queues, it additionally supports the |
31 |
dl |
1.16 |
* {@link java.util.Collection} interface. So, for example, it is possible to |
32 |
|
|
* remove an arbitrary element from a queue using |
33 |
dl |
1.6 |
* <tt>remove(x)</tt>. However, such operations are in general |
34 |
|
|
* <em>NOT</em> performed very efficiently, and are intended for only |
35 |
|
|
* occasional use, such as when a queued message is cancelled. Also, |
36 |
|
|
* the bulk operations, most notably <tt>addAll</tt> are <em>NOT</em> |
37 |
|
|
* performed atomically, so it is possible for <tt>addAll(c)</tt> to |
38 |
|
|
* fail (throwing an exception) after adding only some of the elements |
39 |
|
|
* in <tt>c</tt>. |
40 |
dl |
1.2 |
* |
41 |
dholmes |
1.7 |
* <p>A <tt>BlockingQueue</tt> does <em>not</em> intrinsically support |
42 |
dl |
1.2 |
* any kind of "close" or "shutdown" operation to |
43 |
|
|
* indicate that no more items will be added. The needs and usage of |
44 |
brian |
1.5 |
* such features tend to be implementation-dependent. For example, a |
45 |
dl |
1.2 |
* common tactic is for producers to insert special |
46 |
|
|
* <em>end-of-stream</em> or <em>poison</em> objects, that are |
47 |
|
|
* interpreted accordingly when taken by consumers. |
48 |
tim |
1.1 |
* |
49 |
|
|
* <p> |
50 |
brian |
1.5 |
* Usage example, based on a typical producer-consumer scenario. |
51 |
tim |
1.9 |
* Note that a <tt>BlockingQueue</tt> can safely be used with multiple |
52 |
dholmes |
1.7 |
* producers and multiple consumers. |
53 |
tim |
1.1 |
* <pre> |
54 |
|
|
* class Producer implements Runnable { |
55 |
|
|
* private final BlockingQueue queue; |
56 |
|
|
* Producer(BlockingQueue q) { queue = q; } |
57 |
|
|
* public void run() { |
58 |
|
|
* try { |
59 |
|
|
* while(true) { queue.put(produce()); } |
60 |
tim |
1.15 |
* } catch (InterruptedException ex) { ... handle ...} |
61 |
tim |
1.1 |
* } |
62 |
|
|
* Object produce() { ... } |
63 |
|
|
* } |
64 |
|
|
* |
65 |
|
|
* class Consumer implements Runnable { |
66 |
|
|
* private final BlockingQueue queue; |
67 |
|
|
* Concumer(BlockingQueue q) { queue = q; } |
68 |
|
|
* public void run() { |
69 |
|
|
* try { |
70 |
|
|
* while(true) { consume(queue.take()); } |
71 |
tim |
1.15 |
* } catch (InterruptedException ex) { ... handle ...} |
72 |
tim |
1.1 |
* } |
73 |
|
|
* void consume(Object x) { ... } |
74 |
|
|
* } |
75 |
|
|
* |
76 |
|
|
* class Setup { |
77 |
|
|
* void main() { |
78 |
|
|
* BlockingQueue q = new SomeQueueImplementation(); |
79 |
|
|
* Producer p = new Producer(q); |
80 |
brian |
1.5 |
* Consumer c1 = new Consumer(q); |
81 |
|
|
* Consumer c2 = new Consumer(q); |
82 |
tim |
1.1 |
* new Thread(p).start(); |
83 |
brian |
1.5 |
* new Thread(c1).start(); |
84 |
|
|
* new Thread(c2).start(); |
85 |
tim |
1.1 |
* } |
86 |
|
|
* } |
87 |
|
|
* </pre> |
88 |
|
|
* |
89 |
|
|
* |
90 |
|
|
* @since 1.5 |
91 |
dl |
1.6 |
* @author Doug Lea |
92 |
tim |
1.1 |
*/ |
93 |
|
|
public interface BlockingQueue<E> extends Queue<E> { |
94 |
dholmes |
1.7 |
|
95 |
|
|
/** |
96 |
|
|
* @throws IllegalStateException if this queue is full |
97 |
dholmes |
1.11 |
* @throws NullPointerException if the specified element is <tt>null</tt>. |
98 |
dholmes |
1.7 |
*/ |
99 |
dholmes |
1.10 |
boolean add(E o); |
100 |
dholmes |
1.7 |
|
101 |
tim |
1.9 |
/** |
102 |
|
|
* @throws IllegalStateException if this queue is full |
103 |
tim |
1.14 |
* @throws NullPointerException if <tt>c</tt> or any element of <tt>c<tt> |
104 |
dholmes |
1.10 |
* is <tt>null</tt>. |
105 |
tim |
1.9 |
*/ |
106 |
|
|
boolean addAll(Collection<? extends E> c); |
107 |
dholmes |
1.7 |
|
108 |
tim |
1.9 |
/** |
109 |
dholmes |
1.11 |
* @throws NullPointerException if the specified element is <tt>null</tt>. |
110 |
dholmes |
1.7 |
*/ |
111 |
tim |
1.14 |
boolean offer(E o); |
112 |
dholmes |
1.7 |
|
113 |
tim |
1.1 |
/** |
114 |
dholmes |
1.12 |
* Adds the specified element to this queue, waiting if necessary up to the |
115 |
dholmes |
1.7 |
* specified wait time for space to become available. |
116 |
dholmes |
1.10 |
* @param o the element to add |
117 |
dholmes |
1.7 |
* @param timeout how long to wait before giving up, in units of |
118 |
|
|
* <tt>unit</tt> |
119 |
tim |
1.9 |
* @param unit a <tt>TimeUnit</tt> determining how to interpret the |
120 |
dholmes |
1.7 |
* <tt>timeout</tt> parameter |
121 |
|
|
* @return <tt>true</tt> if successful, or <tt>false</tt> if |
122 |
|
|
* the specified waiting time elapses before space is available. |
123 |
tim |
1.1 |
* @throws InterruptedException if interrupted while waiting. |
124 |
dholmes |
1.11 |
* @throws NullPointerException if the specified element is <tt>null</tt>. |
125 |
tim |
1.1 |
*/ |
126 |
dholmes |
1.10 |
boolean offer(E o, long timeout, TimeUnit unit) |
127 |
dholmes |
1.7 |
throws InterruptedException; |
128 |
tim |
1.1 |
|
129 |
|
|
/** |
130 |
dholmes |
1.12 |
* Retrieves and removes the head of this queue, waiting |
131 |
dholmes |
1.7 |
* if necessary up to the specified wait time if no elements are |
132 |
|
|
* present on this queue. |
133 |
dl |
1.6 |
* @param timeout how long to wait before giving up, in units of |
134 |
|
|
* <tt>unit</tt> |
135 |
tim |
1.9 |
* @param unit a <tt>TimeUnit</tt> determining how to interpret the |
136 |
dholmes |
1.7 |
* <tt>timeout</tt> parameter |
137 |
tim |
1.9 |
* @return the head of this queue, or <tt>null</tt> if the |
138 |
dholmes |
1.7 |
* specified waiting time elapses before an element is present. |
139 |
tim |
1.1 |
* @throws InterruptedException if interrupted while waiting. |
140 |
|
|
*/ |
141 |
tim |
1.9 |
E poll(long timeout, TimeUnit unit) |
142 |
tim |
1.1 |
throws InterruptedException; |
143 |
|
|
|
144 |
|
|
/** |
145 |
dholmes |
1.12 |
* Retrieves and removes the head of this queue, waiting |
146 |
dholmes |
1.7 |
* if no elements are present on this queue. |
147 |
|
|
* @return the head of this queue |
148 |
tim |
1.1 |
* @throws InterruptedException if interrupted while waiting. |
149 |
|
|
*/ |
150 |
dholmes |
1.7 |
E take() throws InterruptedException; |
151 |
|
|
|
152 |
tim |
1.1 |
|
153 |
|
|
/** |
154 |
dholmes |
1.12 |
* Adds the specified element to this queue, waiting if necessary for |
155 |
dholmes |
1.7 |
* space to become available. |
156 |
dholmes |
1.10 |
* @param o the element to add |
157 |
tim |
1.1 |
* @throws InterruptedException if interrupted while waiting. |
158 |
dholmes |
1.13 |
* @throws NullPointerException if the specified element is <tt>null</tt>. |
159 |
tim |
1.1 |
*/ |
160 |
dholmes |
1.10 |
void put(E o) throws InterruptedException; |
161 |
dholmes |
1.7 |
|
162 |
dl |
1.2 |
|
163 |
|
|
/** |
164 |
dholmes |
1.12 |
* Returns the number of elements that this queue can ideally (in |
165 |
dl |
1.2 |
* the absence of memory or resource constraints) accept without |
166 |
|
|
* blocking, or <tt>Integer.MAX_VALUE</tt> if there is no |
167 |
tim |
1.9 |
* intrinsic limit. |
168 |
dholmes |
1.7 |
* <p>Note that you <em>cannot</em> always tell if |
169 |
dl |
1.2 |
* an attempt to <tt>add</tt> an element will succeed by |
170 |
|
|
* inspecting <tt>remainingCapacity</tt> because it may be the |
171 |
|
|
* case that a waiting consumer is ready to <tt>take</tt> an |
172 |
|
|
* element out of an otherwise full queue. |
173 |
|
|
* @return the remaining capacity |
174 |
dl |
1.6 |
*/ |
175 |
|
|
int remainingCapacity(); |
176 |
tim |
1.1 |
|
177 |
|
|
} |
178 |
dholmes |
1.7 |
|
179 |
|
|
|
180 |
|
|
|
181 |
|
|
|
182 |
|
|
|
183 |
|
|
|
184 |
|
|
|
185 |
|
|
|