io.atomix.core.barrier

Interface DistributedCyclicBarrier

All Superinterfaces:

DistributedPrimitive, SyncPrimitive

public interface DistributedCyclicBarrier
extends SyncPrimitive

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
AsyncDistributedCyclicBarrier	async() Returns the underlying asynchronous primitive.
int	await() Waits until all parties have invoked await on this barrier.
int	await(Duration timeout) Waits until all parties have invoked await on this barrier.
int	getNumberWaiting() Returns the number of parties currently waiting at the barrier.
int	getParties() Returns the number of parties required to trip this barrier.
boolean	isBroken() Returns whether this barrier is in a broken state.
void	reset() Resets the barrier to its initial state.

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

await

int 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

int 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

int getNumberWaiting()

Returns the number of parties currently waiting at the barrier.

Returns:

the number of parties currently waiting at the barrier

getParties

int getParties()

Returns the number of parties required to trip this barrier.

Returns:

the number of parties required to trip this barrier

isBroken

boolean isBroken()

Returns whether this barrier is in a broken state.

Returns:

whether this barrier is in a broken state

reset

void reset()

Resets the barrier to its initial state.

async

AsyncDistributedCyclicBarrier async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive