edu.rice.hj.runtime.phasers

Class BlockingPhaser

java.lang.Object

edu.rice.hj.runtime.phasers.BlockingPhaser

All Implemented Interfaces:

HjPhaser, InternalPhaser

public final class BlockingPhaser
extends Object
implements InternalPhaser

BlockingPhaser class.

Author:

Shams Imam (shams@rice.edu)

Constructor Summary

Constructors

Constructor and Description
BlockingPhaser(HjPhaserMode phMode, int busyWaitCount, PhaserManager phManager) Constructor for BlockingPhaser.
BlockingPhaser(HjPhaserMode phMode, PhaserManager phManager) Constructor for BlockingPhaser.
BlockingPhaser(PhaserManager phManager) Constructor.
BlockingPhaser(String phName, HjPhaserMode phMode, int busyWaitCount, PhaserManager phManager) Constructor for BlockingPhaser.

Method Summary

Modifier and Type	Method and Description
void	doNext() The next operation has the effect of advancing each phaser on which the task is registered to its next phase, thereby synchronizing all activities registered on the same phase.
void	doWait() Blocks until all phasers that this activity is registered with have called continue (or next since next implies continue on all registered phasers).
boolean	doWaitSingle1() doWaitSingle1.
boolean	doWaitSingle1(String loc) doWaitSingle1.
void	doWaitSingle2() doWaitSingle2.
void	drop() An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser.
boolean	dropped() dropped.
HjPhaserMode	getPhaserMode() Returns the registration mode of the phaser was created with.
edu.rice.hj.runtime.phasers.PhaserSigWaitState	getPhaseState(int phase) getPhaseState.
int	getSigPhase() getSigPhase.
int	getWaitPhase() getWaitPhase.
int	id() id.
HjPhaserPair	inMode(HjPhaserMode phaserMode) Return a HjPhaserPair with the phaser in the specified registration mode.
boolean	quiescent() quiescent.
void	register(BlockingActivity activity, HjPhaserMode mode) register.
boolean	registered() An activity may call this method to determine whether it is registered with this phaser or not.
void	signal() An activity calls this method to tell the phaser that is done with whatever it intended to do during this phase of the phaser.
String	toDetailedString() toDetailedString.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingPhaser

public BlockingPhaser(PhaserManager phManager)

Constructor.

Parameters:

phManager - The phaser manager that governs the phaser operations.

BlockingPhaser

public BlockingPhaser(HjPhaserMode phMode,
                      PhaserManager phManager)

Constructor for BlockingPhaser.

Parameters:

phMode - The phaser registration mode. Should not be null.

phManager - The phaser manager that governs the phaser operations.

BlockingPhaser

public BlockingPhaser(HjPhaserMode phMode,
                      int busyWaitCount,
                      PhaserManager phManager)

Constructor for BlockingPhaser.

Parameters:

phMode - The phaser registration mode. Should not be null.

busyWaitCount - The limit to use in busy wait loop.

phManager - The phaser manager that governs the phaser operations.

BlockingPhaser

public BlockingPhaser(String phName,
                      HjPhaserMode phMode,
                      int busyWaitCount,
                      PhaserManager phManager)

Constructor for BlockingPhaser.

Parameters:

phName - The phaser name.

phMode - The phaser registration mode. Should not be null.

busyWaitCount - The limit to use in busy wait loop.

phManager - The phaser manager that governs the phaser operations.

Method Detail

id

public int id()

id.

Returns:

a int.

getSigPhase

public int getSigPhase()

getSigPhase.

Specified by:

getSigPhase in interface InternalPhaser

Returns:

a int.

getWaitPhase

public int getWaitPhase()

getWaitPhase.

Specified by:

getWaitPhase in interface InternalPhaser

Returns:

a int.

inMode

public HjPhaserPair inMode(HjPhaserMode phaserMode)

Return a HjPhaserPair with the phaser in the specified registration mode.

Specified by:

inMode in interface HjPhaser

Parameters:

phaserMode - The phaser registration mode.

Returns:

a HjPhaserPair in a specified mode

getPhaserMode

public HjPhaserMode getPhaserMode()

Returns the registration mode of the phaser was created with.

Specified by:

getPhaserMode in interface HjPhaser

Returns:

the registration mode of the phaser was created with.

doNext

public void doNext()

The next operation has the effect of advancing each phaser on which the task is registered to its next phase, thereby synchronizing all activities registered on the same phase.

next is equivalent to a signal followed by wait.

Specified by:

doNext in interface HjPhaser

signal

public void signal()

An activity calls this method to tell the phaser that is done with whatever it intended to do during this phase of the phaser. The activity will not post any other statement for execution in this phase of the phaser.

Specified by:

signal in interface HjPhaser

getPhaseState

public edu.rice.hj.runtime.phasers.PhaserSigWaitState getPhaseState(int phase)

getPhaseState.

Specified by:

getPhaseState in interface InternalPhaser

Parameters:

phase - a int.

Returns:

a PhaserSigWaitState object.

doWait

public void doWait()

Blocks until all phasers that this activity is registered with have called continue (or next since next implies continue on all registered phasers).

This method is used internally by the Runtime and should not be visible for clients. Clients should use Runtime.doNext().

Specified by:

doWait in interface HjPhaser

doWaitSingle1

public boolean doWaitSingle1()

doWaitSingle1.

Specified by:

doWaitSingle1 in interface InternalPhaser

Returns:

a boolean.

doWaitSingle1

public boolean doWaitSingle1(String loc)

doWaitSingle1.

Specified by:

doWaitSingle1 in interface InternalPhaser

Parameters:

loc - The location of the next-with-single call

Returns:

a boolean.

doWaitSingle2

public void doWaitSingle2()

doWaitSingle2.

Specified by:

doWaitSingle2 in interface InternalPhaser

drop

public void drop()

An activity calls this method to tell the phaser that it is no longer interested in interacting with the phaser. It will no longer call now or resume on this phaser. The activity is considered de-registered from the phaser after this method returns.

Specified by:

drop in interface HjPhaser

dropped

public boolean dropped()

dropped.

Specified by:

dropped in interface InternalPhaser

Returns:

true if the phaser has been dropped from the current activity

registered

public boolean registered()

An activity may call this method to determine whether it is registered with this phaser or not.

Specified by:

registered in interface InternalPhaser

Returns:

a boolean.

register

public void register(BlockingActivity activity,
                     HjPhaserMode mode)

register.

Specified by:

register in interface InternalPhaser

Parameters:

activity - a BlockingActivity object.

mode - a HjPhaserMode object.

quiescent

public boolean quiescent()

quiescent.

Specified by:

quiescent in interface InternalPhaser

Returns:

true if the phaser is quiescent

toString

public String toString()

Overrides:

toString in class Object

toDetailedString

public String toDetailedString()

toDetailedString.

Returns:

a String object.