Package org.apache.curator.framework.recipes.barriers

Class DistributedBarrier

java.lang.Object

org.apache.curator.framework.recipes.barriers.DistributedBarrier

public class DistributedBarrier
extends Object

A barrier as described in the ZK recipes. Quoting the recipe:

Distributed systems use barriers to block processing of a set of nodes until a condition is met at which time all the nodes are allowed to proceed

Constructor Summary

Constructors

Constructor	Description
DistributedBarrier(CuratorFramework client, String barrierPath)

Method Summary

Modifier and Type	Method	Description
void	removeBarrier()	Utility to remove the barrier node
void	setBarrier()	Utility to set the barrier node
void	waitOnBarrier()	Blocks until the barrier node comes into existence
boolean	waitOnBarrier(long maxWait, TimeUnit unit)	Blocks until the barrier no longer exists or the timeout elapses

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DistributedBarrier

public DistributedBarrier(CuratorFramework client,
 String barrierPath)

Parameters:

client - client

barrierPath - path to use as the barrier

Method Details

setBarrier

public void setBarrier()
                throws Exception

Utility to set the barrier node

Throws:

Exception - errors

removeBarrier

public void removeBarrier()
                   throws Exception

Utility to remove the barrier node

Throws:

Exception - errors

waitOnBarrier

public void waitOnBarrier()
                   throws Exception

Blocks until the barrier node comes into existence

Throws:

Exception - errors

waitOnBarrier

public boolean waitOnBarrier(long maxWait,
 TimeUnit unit)
                      throws Exception

Blocks until the barrier no longer exists or the timeout elapses

Parameters:

maxWait - max time to block

unit - time unit

Returns:

true if the wait was successful, false if the timeout elapsed first

Throws:

Exception - errors