net.grinder.synchronisation

Class AbstractBarrierGroups.BarrierGroupImplementation

java.lang.Object

net.grinder.synchronisation.AbstractBarrierGroups.BarrierGroupImplementation

All Implemented Interfaces:

BarrierGroup

Enclosing class:

AbstractBarrierGroups

protected class AbstractBarrierGroups.BarrierGroupImplementation
extends Object
implements BarrierGroup

Basic BarrierGroup implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface net.grinder.synchronisation.BarrierGroup

BarrierGroup.Listener

Constructor Summary

Constructors

Constructor and Description
AbstractBarrierGroups.BarrierGroupImplementation(String name) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBarrier() Increase the number of barriers in the group.
void	addListener(BarrierGroup.Listener listener) Add a listener.
void	addWaiter(BarrierIdentity barrierIdentity) Add a waiter.
void	cancelAll() Cancels all waiters and removes all barriers.
void	cancelWaiter(BarrierIdentity barrierIdentity) Cancel a waiter.
protected Set<BarrierIdentity>	checkCondition() Check whether the barrier condition is satisfied.
protected Set<BarrierIdentity>	clearWaiters(Set<BarrierIdentity> waiters) Clear waiters.
protected void	fireAwaken(Set<BarrierIdentity> oldWaiters) Call the BarrierGroup.Listener.awaken(java.util.Set<net.grinder.synchronisation.messages.BarrierIdentity>) method for all of the listeners.
String	getName() Return the name of the barrier group.
void	removeBarriers(long n) Decrease the number of barriers in the group.
void	removeListener(BarrierGroup.Listener listener) Remove a listener.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBarrierGroups.BarrierGroupImplementation

public AbstractBarrierGroups.BarrierGroupImplementation(String name)

Constructor.

Parameters:

name - Barrier group name.

Method Detail

getName

public String getName()

Return the name of the barrier group.

Specified by:

getName in interface BarrierGroup

Returns:

The barrier group name.

addListener

public void addListener(BarrierGroup.Listener listener)

Add a listener.

Specified by:

addListener in interface BarrierGroup

Parameters:

listener - The listener.

removeListener

public void removeListener(BarrierGroup.Listener listener)

Remove a listener.

Specified by:

removeListener in interface BarrierGroup

Parameters:

listener - The listener.

addBarrier

public void addBarrier()
                throws CommunicationException

Increase the number of barriers in the group.

Specified by:

addBarrier in interface BarrierGroup

Throws:

CommunicationException - If the operation could not be completed due to a network communication problem. The barrier group is left in an unknown state.

removeBarriers

public void removeBarriers(long n)
                    throws CommunicationException

Decrease the number of barriers in the group.

Specified by:

removeBarriers in interface BarrierGroup

Parameters:

n - The number of barriers to remove.

Throws:

CommunicationException - If the operation could not be completed due to a network communication problem. The barrier group is left in an unknown state.

addWaiter

public void addWaiter(BarrierIdentity barrierIdentity)
               throws CommunicationException

Add a waiter.

Specified by:

addWaiter in interface BarrierGroup

Parameters:

barrierIdentity - Identifies the barrier.

Throws:

CommunicationException - If the operation could not be completed due to a network communication problem. The barrier group is left in an unknown state.

cancelWaiter

public void cancelWaiter(BarrierIdentity barrierIdentity)
                  throws CommunicationException

Cancel a waiter.

Does nothing if the barrierIdentity refers to an unknown waiter. This copes with the following cases:

• Cancel received asynchronously after barrier has been triggered.
• Cancel received without a call to BarrierGroup.addWaiter(net.grinder.synchronisation.messages.BarrierIdentity).

Specified by:

cancelWaiter in interface BarrierGroup

Parameters:

barrierIdentity - Identifies the barrier.

Throws:

CommunicationException - If the operation could not be completed due to a network communication problem. The barrier group is left in an unknown state.

cancelAll

public void cancelAll()
               throws CommunicationException

Cancels all waiters and removes all barriers.

Specified by:

cancelAll in interface BarrierGroup

Throws:

CommunicationException - If the operation could not be completed due to a network communication problem. The barrier group is left in an unknown state.

fireAwaken

protected final void fireAwaken(Set<BarrierIdentity> oldWaiters)

Call the BarrierGroup.Listener.awaken(java.util.Set<net.grinder.synchronisation.messages.BarrierIdentity>) method for all of the listeners.

Parameters:

oldWaiters - The previous waiters.

clearWaiters

protected final Set<BarrierIdentity> clearWaiters(Set<BarrierIdentity> waiters)

Clear waiters.

Parameters:

waiters - Waiters to removed, if they exist.

Returns:

The waiters that were removed.

checkCondition

protected final Set<BarrierIdentity> checkCondition()

Check whether the barrier condition is satisfied. If so, clear our waiters.

The caller is responsible for taking whatever other action necessary such as notifying the listeners.

Returns:

The set of waiters to be woken. If the barrier condition was not satisfied, an empty set will be returned.

toString

public String toString()

Overrides:

toString in class Object