| java.lang.Object EDU.oswego.cs.dl.util.concurrent.CyclicBarrier
CyclicBarrier | public class CyclicBarrier implements Barrier(Code) | | A cyclic barrier is a reasonable choice for a barrier in contexts
involving a fixed sized group of threads that
must occasionally wait for each other.
(A Rendezvous better handles applications in which
any number of threads meet, n-at-a-time.)
CyclicBarriers use an all-or-none breakage model
for failed synchronization attempts: If threads
leave a barrier point prematurely because of timeout
or interruption, others will also leave abnormally
(via BrokenBarrierException), until
the barrier is restart ed. This is usually
the simplest and best strategy for sharing knowledge
about failures among cooperating threads in the most
common usages contexts of Barriers.
This implementation has the property that interruptions
among newly arriving threads can cause as-yet-unresumed
threads from a previous barrier cycle to return out
as broken. This transmits breakage
as early as possible, but with the possible byproduct that
only some threads returning out of a barrier will realize
that it is newly broken. (Others will not realize this until a
future cycle.) (The Rendezvous class has a more uniform, but
sometimes less desirable policy.)
Barriers support an optional Runnable command
that is run once per barrier point.
Sample usage Here is a code sketch of
a barrier in a parallel decomposition design.
class Solver {
final int N;
final float[][] data;
final CyclicBarrier barrier;
class Worker implements Runnable {
int myRow;
Worker(int row) { myRow = row; }
public void run() {
while (!done()) {
processRow(myRow);
try {
barrier.barrier();
}
catch (InterruptedException ex) { return; }
catch (BrokenBarrierException ex) { return; }
}
}
}
public Solver(float[][] matrix) {
data = matrix;
N = matrix.length;
barrier = new CyclicBarrier(N);
barrier.setBarrierCommand(new Runnable() {
public void run() { mergeRows(...); }
});
for (int i = 0; i < N; ++i) {
new Thread(new Worker(i)).start();
waitUntilDone();
}
}
[ Introduction to this package. ]
|
Constructor Summary | |
public | CyclicBarrier(int parties) Create a CyclicBarrier for the indicated number of parties,
and no command to run at each barrier. | public | CyclicBarrier(int parties, Runnable command) Create a CyclicBarrier for the indicated number of parties. |
Method Summary | |
public int | attemptBarrier(long msecs) Enter barrier and wait at most msecs for the other parties()-1 threads.
if not timed out, the arrival index: the number of other parties that were still waitingupon entry. | public int | barrier() Enter barrier and wait for the other parties()-1 threads.
the arrival index: the number of other parties that were still waitingupon entry. | public synchronized boolean | broken() | protected synchronized int | doBarrier(boolean timed, long msecs) | public int | parties() | public synchronized void | restart() Reset to initial state. | public synchronized Runnable | setBarrierCommand(Runnable command) Set the command to run at the point at which all threads reach the
barrier. |
broken_ | protected boolean broken_(Code) | | |
count_ | protected int count_(Code) | | |
parties_ | final protected int parties_(Code) | | |
resets_ | protected int resets_(Code) | | |
CyclicBarrier | public CyclicBarrier(int parties)(Code) | | Create a CyclicBarrier for the indicated number of parties,
and no command to run at each barrier.
exception: IllegalArgumentException - if parties less than or equal to zero. |
CyclicBarrier | public CyclicBarrier(int parties, Runnable command)(Code) | | Create a CyclicBarrier for the indicated number of parties.
and the given command to run at each barrier point.
exception: IllegalArgumentException - if parties less than or equal to zero. |
attemptBarrier | public int attemptBarrier(long msecs) throws InterruptedException, TimeoutException, BrokenBarrierException(Code) | | Enter barrier and wait at most msecs for the other parties()-1 threads.
if not timed out, the arrival index: the number of other parties that were still waitingupon entry. This is a unique value from zero to parties()-1.If it is zero, then the currentthread was the last party to hit barrier pointand so was responsible for releasing the others. exception: BrokenBarrierException - if any other threadin any previous or current barrier since either creation or the last restart operation left the barrierprematurely due to interruption or time-out. (If so,the broken status is also set.) Threads that are noticed to have beeninterrupted after being released are not consideredto have broken the barrier.In all cases, the interruptionstatus of the current thread is preserved, so can be testedby checking Thread.interrupted . exception: InterruptedException - if this thread was interruptedduring the barrier. If so, broken status is also set. exception: TimeoutException - if this thread timed out waiting forthe barrier. If the timeout occured while already in thebarrier, broken status is also set. |
barrier | public int barrier() throws InterruptedException, BrokenBarrierException(Code) | | Enter barrier and wait for the other parties()-1 threads.
the arrival index: the number of other parties that were still waitingupon entry. This is a unique value from zero to parties()-1.If it is zero, then the currentthread was the last party to hit barrier pointand so was responsible for releasing the others. exception: BrokenBarrierException - if any other threadin any previous or current barrier since either creation or the last restart operation left the barrierprematurely due to interruption or time-out. (If so,the broken status is also set.)Threads that are noticied to have beeninterrupted after being released are not consideredto have broken the barrier.In all cases, the interruptionstatus of the current thread is preserved, so can be testedby checking Thread.interrupted . exception: InterruptedException - if this thread was interruptedduring the barrier, and was the one causing breakage. If so, broken status is also set. |
broken | public synchronized boolean broken()(Code) | | |
parties | public int parties()(Code) | | |
restart | public synchronized void restart()(Code) | | Reset to initial state. Clears both the broken status
and any record of waiting threads, and releases all
currently waiting threads with indeterminate return status.
This method is intended only for use in recovery actions
in which it is somehow known
that no thread could possibly be relying on the
the synchronization properties of this barrier.
|
setBarrierCommand | public synchronized Runnable setBarrierCommand(Runnable command)(Code) | | Set the command to run at the point at which all threads reach the
barrier. This command is run exactly once, by the thread
that trips the barrier. The command is not run if the barrier is
broken.
Parameters: command - the command to run. If null, no command is run. the previous command |
|
|