1 |
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> |
2 |
<html> <head> |
3 |
<title>Concurrency Utilities</title> |
4 |
</head> |
5 |
|
6 |
<body> |
7 |
|
8 |
<p> Utility classes commonly useful in concurrent programming. This |
9 |
package includes a few small standardized extensible frameworks, as |
10 |
well as some classes that provide useful functionality and are |
11 |
otherwise tedious or difficult to implement. Here are brief |
12 |
descriptions of the main components. See also the <tt>locks</tt> and |
13 |
<tt>atomic</tt> packages. |
14 |
|
15 |
<h2>Executors</h2> |
16 |
|
17 |
<b>Interfaces.</b> {@link java.util.concurrent.Executor} is a simple |
18 |
standardized interface for defining custom thread-like subsystems, |
19 |
including thread pools, asynchronous IO, and lightweight task |
20 |
frameworks. Depending on which concrete Executor class is being used, |
21 |
tasks may execute in a newly created thread, an existing |
22 |
task-execution thread, or the thread calling <tt>execute()</tt>, and |
23 |
may execute sequentially or concurrently. {@link |
24 |
java.util.concurrent.ExecutorService} provides a more complete |
25 |
asynchronous task execution framework. An ExecutorService manages |
26 |
queuing and scheduling of tasks, and allows controlled shutdown. The |
27 |
{@link java.util.concurrent.ScheduledExecutorService} subinterface |
28 |
adds support for delayed and periodic task execution. |
29 |
ExecutorServices provide methods arranging asynchronous execution of |
30 |
any function expressed as {@link java.util.concurrent.Callable}, the |
31 |
result-bearing analog of {@link java.lang.Runnable}. A {@link |
32 |
java.util.concurrent.Future} returns the results of a function, allows |
33 |
determination of whether execution has completed, and provides a means to |
34 |
cancel execution. |
35 |
|
36 |
<p> |
37 |
|
38 |
<b>Implementations.</b> Classes {@link |
39 |
java.util.concurrent.ThreadPoolExecutor} and {@link |
40 |
java.util.concurrent.ScheduledThreadPoolExecutor} provide tunable, |
41 |
flexible thread pools. The {@link java.util.concurrent.Executors} |
42 |
class provides factory methods for the most common kinds and |
43 |
configurations of Executors, as well as a few utility methods for |
44 |
using them. Other utilities based on Executors include the concrete |
45 |
class {@link java.util.concurrent.FutureTask} providing a common |
46 |
extensible implementation of Futures, and {@link |
47 |
java.util.concurrent.ExecutorCompletionService}, that assists in |
48 |
coordinating the processing of groups of asynchronous tasks. |
49 |
|
50 |
<h2>Queues</h2> |
51 |
|
52 |
The java.util.concurrent {@link |
53 |
java.util.concurrent.ConcurrentLinkedQueue} class supplies an |
54 |
efficient scalable thread-safe non-blocking FIFO queue. Five |
55 |
implementations in java.util.concurrent support the extended {@link |
56 |
java.util.concurrent.BlockingQueue} interface, that defines blocking |
57 |
versions of put and take: {@link |
58 |
java.util.concurrent.LinkedBlockingQueue}, {@link |
59 |
java.util.concurrent.ArrayBlockingQueue}, {@link |
60 |
java.util.concurrent.SynchronousQueue}, {@link |
61 |
java.util.concurrent.PriorityBlockingQueue}, and {@link |
62 |
java.util.concurrent.DelayQueue}. The different classes cover the most |
63 |
common usage contexts for producer-consumer, messaging, parallel |
64 |
tasking, and related concurrent designs. The {@link |
65 |
java.util.concurrent.BlockingDeque} interface extends |
66 |
<tt>BlockingQueue</tt> to support both FIFO and LIFO (stack-based) |
67 |
operations. Class {@link java.util.concurrent.LinkedBlockingDeque} |
68 |
provides an implementation. |
69 |
|
70 |
|
71 |
<h2>Timing</h2> |
72 |
|
73 |
The {@link java.util.concurrent.TimeUnit} class provides multiple |
74 |
granularities (including nanoseconds) for specifying and controlling |
75 |
time-out based operations. Most classes in the package contain |
76 |
operations based on time-outs in addition to indefinite waits. In all |
77 |
cases that time-outs are used, the time-out specifies the minimum time |
78 |
that the method should wait before indicating that it |
79 |
timed-out. Implementations make a "best effort" to detect |
80 |
time-outs as soon as possible after they occur. However, an indefinite |
81 |
amount of time may elapse between a time-out being detected and a |
82 |
thread actually executing again after that time-out. All methods |
83 |
that accept timeout parameters treat values less than or equal to |
84 |
zero to mean not to wait at all. To wait "forever", you can use |
85 |
a value of <tt>Long.MAX_VALUE</tt>. |
86 |
|
87 |
<h2>Synchronizers</h2> |
88 |
|
89 |
Four classes aid common special-purpose synchronization idioms. |
90 |
{@link java.util.concurrent.Semaphore} is a classic concurrency tool. |
91 |
{@link java.util.concurrent.CountDownLatch} is a very simple yet very |
92 |
common utility for blocking until a given number of signals, events, |
93 |
or conditions hold. A {@link java.util.concurrent.CyclicBarrier} is a |
94 |
resettable multiway synchronization point useful in some styles of |
95 |
parallel programming. An {@link java.util.concurrent.Exchanger} allows |
96 |
two threads to exchange objects at a rendezvous point, and is useful |
97 |
in several pipeline designs. |
98 |
|
99 |
<h2>Concurrent Collections</h2> |
100 |
|
101 |
Besides Queues, this package supplies Collection implementations |
102 |
designed for use in multithreaded contexts: |
103 |
{@link java.util.concurrent.ConcurrentHashMap}, |
104 |
{@link java.util.concurrent.ConcurrentSkipListMap}, |
105 |
{@link java.util.concurrent.ConcurrentSkipListSet}, |
106 |
{@link java.util.concurrent.CopyOnWriteArrayList}, and |
107 |
{@link java.util.concurrent.CopyOnWriteArraySet}. |
108 |
When many threads are expected to access a given collection, |
109 |
a <tt>ConcurrentHashMap</tt> is normally preferable to |
110 |
a synchronized <tt>HashMap</tt>, and a |
111 |
<tt>ConcurrentSkipListMap</tt> is normally preferable |
112 |
to a synchronized <tt>TreeMap</tt>. A |
113 |
<tt>CopyOnWriteArrayList</tt> is preferable to |
114 |
a synchronized <tt>ArrayList</tt> when the expected number of reads |
115 |
and traversals greatly outnumber the number of updates to a list. |
116 |
|
117 |
<p>The "Concurrent" prefix used with some classes in this package is a |
118 |
shorthand indicating several differences from similar "synchronized" |
119 |
classes. For example <tt>java.util.Hashtable</tt> and |
120 |
<tt>Collections.synchronizedMap(new HashMap())</tt> are |
121 |
synchronized. But {@link java.util.concurrent.ConcurrentHashMap} is |
122 |
"concurrent". A concurrent collection is thread-safe, but not |
123 |
governed by a single exclusion lock. In the particular case of |
124 |
ConcurrentHashMap, it safely permits any number of concurrent reads as |
125 |
well as a tunable number of concurrent writes. "Synchronized" classes |
126 |
can be useful when you need to prevent all access to a collection via |
127 |
a single lock, at the expense of poorer scalability. In other cases in |
128 |
which multiple threads are expected to access a common collection, |
129 |
"concurrent" versions are normally preferable. And unsynchronized |
130 |
collections are preferable when either collections are unshared, or |
131 |
are accessible only when holding other locks. |
132 |
|
133 |
<p> Most concurrent Collection implementations (including most Queues) |
134 |
also differ from the usual java.util conventions in that their Iterators |
135 |
provide <em>weakly consistent</em> rather than fast-fail traversal. A |
136 |
weakly consistent iterator is thread-safe, but does not necessarily |
137 |
freeze the collection while iterating, so it may (or may not) reflect |
138 |
any updates since the iterator was created. |
139 |
|
140 |
@since 1.5 |
141 |
|
142 |
</body> </html> |