In this example, we shall be demonstrating the java.util.concurrent.Phaser Class. The Phaser Class was introduced in Java 7.
Phaser is like a collection of advantages of CountDownLatch and CyclicBarrier Classes.
CountDownLatch vs CyclicBarrier vs Phaser
The CountDownLatch is :
- Created with a fixed number of threads
- Cannot be reset
- Allows threads to wait(
CountDownLatch#await()) or continue with its execution(CountDownLatch#countDown()).
On the other hand, the CyclicBarrier :
- Can be reset.
- Does not a provide a method for the threads to advance. The threads have to wait till all the threads arrive.
- Created with fixed number of threads.
Now, the Phaser has following properties :
- Number of threads need not be known at Phaser creation time. They can be added dynamically.
- Can be reset and hence is, reusable.
- Allows threads to wait(
Phaser#arriveAndAwaitAdvance()) or continue with its execution(Phaser#arrive()). - Supports multiple Phases(, hence the name phaser).
We will try to understand how the Phaser Class can be used with an example. In this example, we are creating a three threads, which will wait for the arrival all the threads being created. Once all the threads have arrived(marked by arriveAndAwaitAdvance() method) the Phaser allows them through the barrier.
PhaserExample.java:
package com.javacodegeeks.examples;
import java.util.concurrent.Phaser;
public class PhaserExample
{
public static void main(String[] args) throws InterruptedException
{
Phaser phaser = new Phaser();
phaser.register();//register self... phaser waiting for 1 party (thread)
int phasecount = phaser.getPhase();
System.out.println("Phasecount is "+phasecount);
new PhaserExample().testPhaser(phaser,2000);//phaser waiting for 2 parties
new PhaserExample().testPhaser(phaser,4000);//phaser waiting for 3 parties
new PhaserExample().testPhaser(phaser,6000);//phaser waiting for 4 parties
//now that all threads are initiated, we will de-register main thread
//so that the barrier condition of 3 thread arrival is meet.
phaser.arriveAndDeregister();
Thread.sleep(10000);
phasecount = phaser.getPhase();
System.out.println("Phasecount is "+phasecount);
}
private void testPhaser(final Phaser phaser,final int sleepTime)
{
phaser.register();
new Thread(){
@Override
public void run()
{
try
{
System.out.println(Thread.currentThread().getName()+" arrived");
phaser.arriveAndAwaitAdvance();//threads register arrival to the phaser.
Thread.sleep(sleepTime);
}
catch (InterruptedException e)
{
e.printStackTrace();
}
System.out.println(Thread.currentThread().getName()+" after passing barrier");
}
}.start();
}
}
OUTPUT :
Phasecount is 0 Thread-0 arrived Thread-2 arrived Thread-1 arrived Thread-0 after passing barrier Thread-1 after passing barrier Thread-2 after passing barrier Phasecount is 1
The Phaser can be used again to hold the threads before starting of a new Phase in the line of execution. The getPhase() method can be used to get the current phase of execution of the Phaser. Any threads that wishes to de-register itself may call arriveAndDeregister() method.
If you wish to run the
Phaser only for a specified number of phases, you may override the protected boolean onAdvance() method. The onAdvance() method should return true when the specified number of phases have been executed.Conclusion
Here we tried to understand, the shortcomings of CountDownLatch and CyclicBarrier Classes introduced in Java 5 and how the Phaser Class helps overcome those shortcomings, flexibly and effectively.
You can download the source code of this example here: PhaserExample.zip
