1 |
/* |
2 |
* Written by Doug Lea with assistance from members of JCP JSR-166 |
3 |
* Expert Group and released to the public domain, as explained at |
4 |
* http://creativecommons.org/publicdomain/zero/1.0/ |
5 |
*/ |
6 |
|
7 |
package java.util.concurrent; |
8 |
|
9 |
import java.util.ArrayList; |
10 |
import java.util.function.Consumer; |
11 |
import java.util.function.Function; |
12 |
import java.util.stream.Stream; |
13 |
|
14 |
/** |
15 |
* Interrelated interfaces and static methods for establishing |
16 |
* flow-controlled components in which {@link Publisher Publishers} |
17 |
* produce items consumed by one or more {@link Subscriber |
18 |
* Subscribers}, each managed by a {@link Subscription |
19 |
* Subscription}. |
20 |
* |
21 |
* <p>These interfaces correspond to the <a |
22 |
* href="http://www.reactive-streams.org/"> reactive-streams</a> |
23 |
* specification. They apply in both concurrent and distributed |
24 |
* asynchronous settings: All (seven) methods are defined in {@code |
25 |
* void} "one-way" message style. Communication relies on a simple form |
26 |
* of flow control (method {@link Subscription#request}) that can be |
27 |
* used to avoid resource management problems that may otherwise occur |
28 |
* in "push" based systems. |
29 |
* |
30 |
* <p><b>Examples.</b> A {@link Publisher} usually defines its own |
31 |
* {@link Subscription} implementation; constructing one in method |
32 |
* {@code subscribe} and issuing it to the calling {@link |
33 |
* Subscriber}. It publishes items to the subscriber asynchronously, |
34 |
* normally using an {@link Executor}. For example, here is a very |
35 |
* simple publisher that only issues (when requested) a single {@code |
36 |
* TRUE} item to a single subscriber. Because the subscriber receives |
37 |
* only a single item, this class does not use buffering and ordering |
38 |
* control required in most implementations (for example {@link |
39 |
* SubmissionPublisher}). |
40 |
* |
41 |
* <pre> {@code |
42 |
* class OneShotPublisher implements Publisher<Boolean> { |
43 |
* final ExecutorService executor = ForkJoinPool.commonPool(); // daemon-based |
44 |
* boolean subscribed = false; // true after first subscribe |
45 |
* public synchronized void subscribe(Subscriber<? super Boolean> subscriber) { |
46 |
* if (subscribed) |
47 |
* subscriber.onError(new IllegalStateException()); // only one allowed |
48 |
* else { |
49 |
* subscribed = true; |
50 |
* subscriber.onSubscribe(new OneShotSubscription(subscriber, executor)); |
51 |
* } |
52 |
* } |
53 |
* static class OneShotSubscription implements Subscription { |
54 |
* final Subscriber<? super Boolean> subscriber; |
55 |
* final ExecutorService executor; |
56 |
* Future<?> future; // to allow cancellation |
57 |
* boolean completed = false; |
58 |
* OneShotSubscription(Subscriber<? super Boolean> subscriber, |
59 |
* ExecutorService executor) { |
60 |
* this.subscriber = subscriber; |
61 |
* this.executor = executor; |
62 |
* } |
63 |
* public synchronized void request(long n) { |
64 |
* if (n != 0 && !completed) { |
65 |
* completed = true; |
66 |
* if (n < 0) { |
67 |
* IllegalStateException ex = new IllegalStateException(); |
68 |
* executor.submit(() -> subscriber.onError(ex)); |
69 |
* } |
70 |
* else { |
71 |
* future = executor.submit(() -> { |
72 |
* subscriber.onNext(Boolean.TRUE); |
73 |
* subscriber.onComplete(); |
74 |
* }); |
75 |
* } |
76 |
* } |
77 |
* } |
78 |
* public synchronized void cancel() { |
79 |
* completed = true; |
80 |
* if (future != null) future.cancel(false); |
81 |
* } |
82 |
* } |
83 |
* }}</pre> |
84 |
* |
85 |
* <p>A {@link Subscriber} arranges that items be requested and |
86 |
* processed. Items (invocations of {@link Subscriber#onNext}) are |
87 |
* not issued unless requested, but multiple items may be requested. |
88 |
* Many Subscriber implementations can arrange this in the style of |
89 |
* the following example, where a buffer size of 1 single-steps, and |
90 |
* larger sizes usually allow for more efficient overlapped processing |
91 |
* with less communication; for example with a value of 64, this keeps |
92 |
* total outstanding requests between 32 and 64. (See also {@link |
93 |
* #consume(long, Publisher, Consumer)} that automates a common case.) |
94 |
* Because Subscriber method invocations for a given {@link |
95 |
* Subscription} are strictly ordered, there is no need for these |
96 |
* methods to use locks or volatiles unless a Subscriber maintains |
97 |
* multiple Subscriptions (in which case it is better to instead |
98 |
* define multiple Subscribers, each with its own Subscription). |
99 |
* |
100 |
* <pre> {@code |
101 |
* class SampleSubscriber<T> implements Subscriber<T> { |
102 |
* final Consumer<? super T> consumer; |
103 |
* Subscription subscription; |
104 |
* final long bufferSize; |
105 |
* long count; |
106 |
* SampleSubscriber(long bufferSize, Consumer<? super T> consumer) { |
107 |
* this.bufferSize = bufferSize; |
108 |
* this.consumer = consumer; |
109 |
* } |
110 |
* public void onSubscribe(Subscription subscription) { |
111 |
* (this.subscription = subscription).request(bufferSize); |
112 |
* count = bufferSize - bufferSize / 2; // re-request when half consumed |
113 |
* } |
114 |
* public void onNext(T item) { |
115 |
* if (--count <= 0) |
116 |
* subscription.request(count = bufferSize - bufferSize / 2); |
117 |
* consumer.accept(item); |
118 |
* } |
119 |
* public void onError(Throwable ex) { ex.printStackTrace(); } |
120 |
* public void onComplete() {} |
121 |
* }}</pre> |
122 |
* |
123 |
* <p>The default value of {@link #defaultBufferSize} may provide a |
124 |
* useful starting point for choosing request sizes and capacities in |
125 |
* Flow components based on expected rates, resources, and usages. |
126 |
* Or, when flow control is known to be always inapplicable, a |
127 |
* subscriber may initially request an effectively unbounded number of |
128 |
* items, as in: |
129 |
* |
130 |
* <pre> {@code |
131 |
* class UnboundedSubscriber<T> implements Subscriber<T> { |
132 |
* public void onSubscribe(Subscription subscription) { |
133 |
* subscription.request(Long.MAX_VALUE); // effectively unbounded |
134 |
* } |
135 |
* public void onNext(T item) { use(item); } |
136 |
* public void onError(Throwable ex) { ex.printStackTrace(); } |
137 |
* public void onComplete() {} |
138 |
* void use(T item) { ... } |
139 |
* }}</pre> |
140 |
* |
141 |
* @author Doug Lea |
142 |
* @since 1.9 |
143 |
*/ |
144 |
public final class Flow { |
145 |
|
146 |
private Flow() {} // uninstantiable |
147 |
|
148 |
/** |
149 |
* A producer of items (and related control messages) received by |
150 |
* Subscribers. Each current {@link Subscriber} receives the same |
151 |
* items (via method {@code onNext}) in the same order, unless |
152 |
* drops or errors are encountered. If a Publisher encounters an |
153 |
* error that does not allow items to be issued to a Subscriber, |
154 |
* that Subscriber receives {@code onError}, and then receives no |
155 |
* further messages. Otherwise, when it is known that no further |
156 |
* messages will be issued to it, a subscriber receives {@code |
157 |
* onComplete}. Publishers ensure that Subscriber method |
158 |
* invocations for each subscription are strictly ordered in <a |
159 |
* href="package-summary.html#MemoryVisibility"><i>happens-before</i></a> |
160 |
* order. |
161 |
* |
162 |
* <p>Publishers may vary in policy about whether drops (failures |
163 |
* to issue an item because of resource limitations) are treated |
164 |
* as unrecoverable errors. Publishers may also vary about |
165 |
* whether Subscribers receive items that were produced or |
166 |
* available before they subscribed. |
167 |
* |
168 |
* @param <T> the published item type |
169 |
*/ |
170 |
@FunctionalInterface |
171 |
public static interface Publisher<T> { |
172 |
/** |
173 |
* Adds the given Subscriber if possible. If already |
174 |
* subscribed, or the attempt to subscribe fails due to policy |
175 |
* violations or errors, the Subscriber's {@code onError} |
176 |
* method is invoked with an {@link IllegalStateException}. |
177 |
* Otherwise, the Subscriber's {@code onSubscribe} method is |
178 |
* invoked with a new {@link Subscription}. Subscribers may |
179 |
* enable receiving items by invoking the {@code request} |
180 |
* method of this Subscription, and may unsubscribe by |
181 |
* invoking its {@code cancel} method. |
182 |
* |
183 |
* @param subscriber the subscriber |
184 |
* @throws NullPointerException if subscriber is null |
185 |
*/ |
186 |
public void subscribe(Subscriber<? super T> subscriber); |
187 |
} |
188 |
|
189 |
/** |
190 |
* A receiver of messages. The methods in this interface are |
191 |
* invoked in strict sequential order for each {@link |
192 |
* Subscription}. |
193 |
* |
194 |
* @param <T> the subscribed item type |
195 |
*/ |
196 |
public static interface Subscriber<T> { |
197 |
/** |
198 |
* Method invoked prior to invoking any other Subscriber |
199 |
* methods for the given Subscription. If this method throws |
200 |
* an exception, resulting behavior is not guaranteed, but may |
201 |
* cause the Subscription to be cancelled. |
202 |
* |
203 |
* <p>Typically, implementations of this method invoke {@code |
204 |
* subscription.request} to enable receiving items. |
205 |
* |
206 |
* @param subscription a new subscription |
207 |
*/ |
208 |
public void onSubscribe(Subscription subscription); |
209 |
|
210 |
/** |
211 |
* Method invoked with a Subscription's next item. If this |
212 |
* method throws an exception, resulting behavior is not |
213 |
* guaranteed, but may cause the Subscription to be cancelled. |
214 |
* |
215 |
* @param item the item |
216 |
*/ |
217 |
public void onNext(T item); |
218 |
|
219 |
/** |
220 |
* Method invoked upon an unrecoverable error encountered by a |
221 |
* Publisher or Subscription, after which no other Subscriber |
222 |
* methods are invoked by the Subscription. If this method |
223 |
* itself throws an exception, resulting behavior is |
224 |
* undefined. |
225 |
* |
226 |
* @param throwable the exception |
227 |
*/ |
228 |
public void onError(Throwable throwable); |
229 |
|
230 |
/** |
231 |
* Method invoked when it is known that no additional |
232 |
* Subscriber method invocations will occur for a Subscription |
233 |
* that is not already terminated by error, after which no |
234 |
* other Subscriber methods are invoked by the Subscription. |
235 |
* If this method throws an exception, resulting behavior is |
236 |
* undefined. |
237 |
*/ |
238 |
public void onComplete(); |
239 |
} |
240 |
|
241 |
/** |
242 |
* Message control linking a {@link Publisher} and {@link |
243 |
* Subscriber}. Subscribers receive items only when requested, |
244 |
* and may cancel at any time. The methods in this interface are |
245 |
* intended to be invoked only by their Subscribers; usages in |
246 |
* other contexts have undefined effects. |
247 |
*/ |
248 |
public static interface Subscription { |
249 |
/** |
250 |
* Adds the given number {@code n} of items to the current |
251 |
* unfulfilled demand for this subscription. If {@code n} is |
252 |
* negative, the Subscriber will receive an {@code onError} |
253 |
* signal with an {@link IllegalArgumentException} argument. |
254 |
* Otherwise, the Subscriber will receive up to {@code n} |
255 |
* additional {@code onNext} invocations (or fewer if |
256 |
* terminated). |
257 |
* |
258 |
* @param n the increment of demand; a value of {@code |
259 |
* Long.MAX_VALUE} may be considered as effectively unbounded |
260 |
*/ |
261 |
public void request(long n); |
262 |
|
263 |
/** |
264 |
* Causes the Subscriber to (eventually) stop receiving |
265 |
* messages. Implementation is best-effort -- additional |
266 |
* messages may be received after invoking this method. A |
267 |
* cancelled subscription need not ever receive an {@code |
268 |
* onComplete} signal. |
269 |
*/ |
270 |
public void cancel(); |
271 |
} |
272 |
|
273 |
/** |
274 |
* A component that acts as both a Subscriber and Publisher. |
275 |
* |
276 |
* @param <T> the subscribed item type |
277 |
* @param <R> the published item type |
278 |
*/ |
279 |
public static interface Processor<T,R> extends Subscriber<T>, Publisher<R> { |
280 |
} |
281 |
|
282 |
// Support for static methods |
283 |
|
284 |
static final int DEFAULT_BUFFER_SIZE = 256; |
285 |
|
286 |
/** |
287 |
* Returns a default value for Publisher or Subscriber buffering, |
288 |
* that may be used in the absence of other constraints. |
289 |
* |
290 |
* @implNote |
291 |
* The current value returned is 256. |
292 |
* |
293 |
* @return the buffer size value |
294 |
*/ |
295 |
public static int defaultBufferSize() { |
296 |
return DEFAULT_BUFFER_SIZE; |
297 |
} |
298 |
|
299 |
abstract static class CompletableSubscriber<T,U> |
300 |
implements Subscriber<T>, Consumer<T> |
301 |
{ |
302 |
final CompletableFuture<U> status; |
303 |
Subscription subscription; |
304 |
long requestSize; |
305 |
long count; |
306 |
CompletableSubscriber(long bufferSize, CompletableFuture<U> status) { |
307 |
this.status = status; |
308 |
this.requestSize = bufferSize; |
309 |
} |
310 |
public final void onSubscribe(Subscription subscription) { |
311 |
(this.subscription = subscription).request(requestSize); |
312 |
count = requestSize -= (requestSize >>> 1); |
313 |
} |
314 |
public final void onError(Throwable ex) { |
315 |
status.completeExceptionally(ex); |
316 |
} |
317 |
public void onNext(T item) { |
318 |
try { |
319 |
if (--count <= 0) |
320 |
subscription.request(count = requestSize); |
321 |
accept(item); |
322 |
} catch (Throwable ex) { |
323 |
status.completeExceptionally(ex); |
324 |
} |
325 |
} |
326 |
} |
327 |
|
328 |
static final class ConsumeSubscriber<T> extends CompletableSubscriber<T,Void> { |
329 |
final Consumer<? super T> consumer; |
330 |
ConsumeSubscriber(long bufferSize, |
331 |
CompletableFuture<Void> status, |
332 |
Consumer<? super T> consumer) { |
333 |
super(bufferSize, status); |
334 |
this.consumer = consumer; |
335 |
} |
336 |
public void accept(T item) { consumer.accept(item); } |
337 |
public void onComplete() { status.complete(null); } |
338 |
} |
339 |
|
340 |
/** |
341 |
* Creates and subscribes a Subscriber that consumes all items |
342 |
* from the given publisher using the given Consumer function, and |
343 |
* using the given bufferSize for buffering. Returns a |
344 |
* CompletableFuture that is completed normally when the publisher |
345 |
* signals {@code onComplete}, or completed exceptionally upon any |
346 |
* error, including an exception thrown by the Consumer (in which |
347 |
* case the subscription is cancelled if not already terminated). |
348 |
* |
349 |
* @param <T> the published item type |
350 |
* @param bufferSize the request size for subscriptions |
351 |
* @param publisher the publisher |
352 |
* @param consumer the function applied to each onNext item |
353 |
* @return a CompletableFuture that is completed normally |
354 |
* when the publisher signals onComplete, and exceptionally |
355 |
* upon any error |
356 |
* @throws NullPointerException if publisher or consumer are null |
357 |
* @throws IllegalArgumentException if bufferSize not positive |
358 |
*/ |
359 |
public static <T> CompletableFuture<Void> consume( |
360 |
long bufferSize, Publisher<T> publisher, Consumer<? super T> consumer) { |
361 |
if (bufferSize <= 0L) |
362 |
throw new IllegalArgumentException("bufferSize must be positive"); |
363 |
if (publisher == null || consumer == null) |
364 |
throw new NullPointerException(); |
365 |
CompletableFuture<Void> status = new CompletableFuture<>(); |
366 |
publisher.subscribe(new ConsumeSubscriber<T>( |
367 |
bufferSize, status, consumer)); |
368 |
return status; |
369 |
} |
370 |
|
371 |
/** |
372 |
* Equivalent to {@link #consume(long, Publisher, Consumer)} |
373 |
* with {@link #defaultBufferSize}. |
374 |
* |
375 |
* @param <T> the published item type |
376 |
* @param publisher the publisher |
377 |
* @param consumer the function applied to each onNext item |
378 |
* @return a CompletableFuture that is completed normally |
379 |
* when the publisher signals onComplete, and exceptionally |
380 |
* upon any error |
381 |
* @throws NullPointerException if publisher or consumer are null |
382 |
*/ |
383 |
public static <T> CompletableFuture<Void> consume( |
384 |
Publisher<T> publisher, Consumer<? super T> consumer) { |
385 |
return consume(defaultBufferSize(), publisher, consumer); |
386 |
} |
387 |
|
388 |
/** |
389 |
* Temporary implementation for Stream, collecting all items |
390 |
* and then applying stream operation. |
391 |
*/ |
392 |
static final class StreamSubscriber<T,R> extends CompletableSubscriber<T,R> { |
393 |
final Function<? super Stream<T>, ? extends R> fn; |
394 |
final ArrayList<T> items; |
395 |
StreamSubscriber(long bufferSize, |
396 |
CompletableFuture<R> status, |
397 |
Function<? super Stream<T>, ? extends R> fn) { |
398 |
super(bufferSize, status); |
399 |
this.fn = fn; |
400 |
this.items = new ArrayList<T>(); |
401 |
} |
402 |
public void accept(T item) { items.add(item); } |
403 |
public void onComplete() { status.complete(fn.apply(items.stream())); } |
404 |
} |
405 |
|
406 |
/** |
407 |
* Creates and subscribes a Subscriber that applies the given |
408 |
* stream operation to items, and uses the given bufferSize for |
409 |
* buffering. Returns a CompletableFuture that is completed |
410 |
* normally with the result of this function when the publisher |
411 |
* signals {@code onComplete}, or is completed exceptionally upon |
412 |
* any error. |
413 |
* |
414 |
* <p><b>Preliminary release note:</b> Currently, this method |
415 |
* collects all items before executing the stream |
416 |
* computation. Improvements are pending Stream integration. |
417 |
* |
418 |
* @param <T> the published item type |
419 |
* @param <R> the result type of the stream function |
420 |
* @param bufferSize the request size for subscriptions |
421 |
* @param publisher the publisher |
422 |
* @param streamFunction the operation on elements |
423 |
* @return a CompletableFuture that is completed normally with the |
424 |
* result of the given function as result when the publisher signals |
425 |
* onComplete, and exceptionally upon any error |
426 |
* @throws NullPointerException if publisher or function are null |
427 |
* @throws IllegalArgumentException if bufferSize not positive |
428 |
*/ |
429 |
public static <T,R> CompletableFuture<R> stream( |
430 |
long bufferSize, Publisher<T> publisher, |
431 |
Function<? super Stream<T>, ? extends R> streamFunction) { |
432 |
if (bufferSize <= 0L) |
433 |
throw new IllegalArgumentException("bufferSize must be positive"); |
434 |
if (publisher == null || streamFunction == null) |
435 |
throw new NullPointerException(); |
436 |
CompletableFuture<R> status = new CompletableFuture<>(); |
437 |
publisher.subscribe(new StreamSubscriber<T,R>( |
438 |
bufferSize, status, streamFunction)); |
439 |
return status; |
440 |
} |
441 |
|
442 |
/** |
443 |
* Equivalent to {@link #stream(long, Publisher, Function)} |
444 |
* with {@link #defaultBufferSize}. |
445 |
* |
446 |
* @param <T> the published item type |
447 |
* @param <R> the result type of the stream function |
448 |
* @param publisher the publisher |
449 |
* @param streamFunction the operation on elements |
450 |
* @return a CompletableFuture that is completed normally with the |
451 |
* result of the given function as result when the publisher signals |
452 |
* onComplete, and exceptionally upon any error |
453 |
* @throws NullPointerException if publisher or function are null |
454 |
*/ |
455 |
public static <T,R> CompletableFuture<R> stream( |
456 |
Publisher<T> publisher, |
457 |
Function<? super Stream<T>,? extends R> streamFunction) { |
458 |
return stream(defaultBufferSize(), publisher, streamFunction); |
459 |
} |
460 |
} |