pt.ua.concurrent

Class TriggeredBarrier

java.lang.Object

pt.ua.concurrent.CObject

pt.ua.concurrent.Barrier

pt.ua.concurrent.ExternalBarrier

pt.ua.concurrent.TriggeredBarrier

All Implemented Interfaces:

InterruptibleAwaitingThreads, SyncCV

public class TriggeredBarrier
extends ExternalBarrier

An externally triggered thread barrier class.
In this type of barrier, the barrier is released by an externally usable (public) method (release).

This class follows DbC(tm) methodology (Wikipedia). Where possible, contracts are implement with native's Java assert.

Version:

0.5, December 2015

Author:

Miguel Oliveira e Silva (mos@ua.pt)

Constructor Summary

Constructors

Constructor and Description
TriggeredBarrier() Constructs a new triggered barrier registering waiting threads.
TriggeredBarrier(boolean registerAwaitingThreads) Constructs a new triggered size barrier.

Method Summary

Modifier and Type	Method and Description
void	await() Caller will wait until the thread barrier is released, situation in which all waiting threads are awakened.
long	awaitCount() Caller will wait until the thread barrier is released, situation in which all waiting threads are awakened.
int	numberWaitingThreads() Number of threads currently waiting on the barrier.
void	release() Release barrier (regardless of the number of waiting threads).

Methods inherited from class pt.ua.concurrent.Barrier

count

Methods inherited from class pt.ua.concurrent.CObject

await, await, broadcast, interruptWaitingThreads, lockIsMine, registerAwaitingThreads, signal, syncronizedLockIsMine

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggeredBarrier

public TriggeredBarrier()

Constructs a new triggered barrier registering waiting threads.

TriggeredBarrier

public TriggeredBarrier(boolean registerAwaitingThreads)

Constructs a new triggered size barrier.

Parameters:

registerAwaitingThreads - if true, threads are registered when waiting

Method Detail

numberWaitingThreads

public int numberWaitingThreads()

Description copied from class: Barrier

Number of threads currently waiting on the barrier.

Specified by:

numberWaitingThreads in class Barrier

Returns:

number of threads

await

public void await()
           throws ThreadInterruptedException

Description copied from class: Barrier

Caller will wait until the thread barrier is released, situation in which all waiting threads are awakened.

Postcondition:

count() == old(count())+ 1

Specified by:

await in interface SyncCV

Specified by:

await in class Barrier

Throws:

ThreadInterruptedException

awaitCount

public long awaitCount()
                throws ThreadInterruptedException

Description copied from class: Barrier

Caller will wait until the thread barrier is released, situation in which all waiting threads are awakened.

Postcondition:

count() == old(count())+ 1

Specified by:

awaitCount in class Barrier

Returns:

the current barrier count

Throws:

ThreadInterruptedException

release

public void release()

Description copied from class: ExternalBarrier

Release barrier (regardless of the number of waiting threads).

Postcondition:

count() == old(count())+ 1

Specified by:

release in class ExternalBarrier