io.atomix.core.barrier

Interface AsyncDistributedCyclicBarrier

All Superinterfaces:

AsyncPrimitive, DistributedPrimitive

public interface AsyncDistributedCyclicBarrier
extends AsyncPrimitive

Distributed cyclic barrier.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Integer>	await() Waits until all parties have invoked await on this barrier.
CompletableFuture<Integer>	await(Duration timeout) Waits until all parties have invoked await on this barrier.
CompletableFuture<Integer>	getNumberWaiting() Returns the number of parties currently waiting at the barrier.
CompletableFuture<Integer>	getParties() Returns the number of parties required to trip this barrier.
CompletableFuture<Boolean>	isBroken() Returns whether this barrier is in a broken state.
CompletableFuture<Void>	reset() Resets the barrier to its initial state.
default DistributedCyclicBarrier	sync() Returns a synchronous wrapper around the asynchronous primitive.
DistributedCyclicBarrier	sync(Duration operationTimeout) Returns a synchronous wrapper around the asynchronous primitive.

Methods inherited from interface io.atomix.primitive.AsyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

await

CompletableFuture<Integer> await()

Waits until all parties have invoked await on this barrier.

Returns:

the arrival index of the current thread, where index getParties() - 1 indicates the first to arrive and zero indicates the last to arrive

await

CompletableFuture<Integer> await(Duration timeout)

Waits until all parties have invoked await on this barrier.

Parameters:

timeout - the time to wait for the barrier

Returns:

the arrival index of the current thread, where index getParties() - 1 indicates the first to arrive and zero indicates the last to arrive

getNumberWaiting

CompletableFuture<Integer> getNumberWaiting()

Returns the number of parties currently waiting at the barrier.

Returns:

the number of parties currently waiting at the barrier

getParties

CompletableFuture<Integer> getParties()

Returns the number of parties required to trip this barrier.

Returns:

the number of parties required to trip this barrier

isBroken

CompletableFuture<Boolean> isBroken()

Returns whether this barrier is in a broken state.

Returns:

whether this barrier is in a broken state

reset

CompletableFuture<Void> reset()

Resets the barrier to its initial state.

sync

default DistributedCyclicBarrier sync()

Description copied from interface: AsyncPrimitive

Returns a synchronous wrapper around the asynchronous primitive.

Specified by:

sync in interface AsyncPrimitive

Returns:

the synchronous primitive

sync

DistributedCyclicBarrier sync(Duration operationTimeout)

Description copied from interface: AsyncPrimitive

Returns a synchronous wrapper around the asynchronous primitive.

Specified by:

sync in interface AsyncPrimitive

Parameters:

operationTimeout - the synchronous operation timeout

Returns:

the synchronous primitive