edu.rice.hj.runtime.phasers

Class PhaserImpl

java.lang.Object

edu.rice.hj.runtime.phasers.PhaserImpl

All Implemented Interfaces:

HjPhaser, InternalPhaser

public final class PhaserImpl
extends Object
implements InternalPhaser

PhaserImpl class.

Author:

Shams Imam (shams@rice.edu)

Constructor Summary

Constructors

Constructor and Description
PhaserImpl(HjPhaserMode phMode, PhaserManager phManager, int busyWaitLimit) Constructor for PhaserImpl.
PhaserImpl(String phName, HjPhaserMode phMode, PhaserManager phManager, int busyWaitLimit) Constructor for PhaserImpl.

Method Summary

Modifier and Type	Method and Description
int	busyWaitLimit() Returns the busyWaitLimit of the phaser.
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(boolean activityEndSignal) 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() Returns the signal phase number of this phaser in the currently executing task.
int	getWaitPhase() Returns the wait phase number of this phaser in the currently executing task.
long	id() Returns the id of the phaser.
HjPhaserPair	inMode(HjPhaserMode phaserMode) Return a HjPhaserPair with the phaser in the specified registration mode.
boolean	quiescent() quiescent.
void	register(HabaneroActivity 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

Methods inherited from interface edu.rice.hj.api.HjPhaser

drop

Constructor Detail

PhaserImpl

public PhaserImpl(HjPhaserMode phMode,
                  PhaserManager phManager,
                  int busyWaitLimit)

Constructor for PhaserImpl.

Parameters:

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

phManager - The phaser manager that governs the phaser operations.

PhaserImpl

public PhaserImpl(String phName,
                  HjPhaserMode phMode,
                  PhaserManager phManager,
                  int busyWaitLimit)

Constructor for PhaserImpl.

Parameters:

phName - The phaser name.

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

busyWaitLimit - The number of times to iterate in a busy wait loop before blocking

phManager - The phaser manager that governs the phaser operations.

Method Detail

id

public long id()

Returns the id of the phaser.

Returns:

the id of the phaser.

busyWaitLimit

public int busyWaitLimit()

Returns the busyWaitLimit of the phaser.

Specified by:

busyWaitLimit in interface InternalPhaser

Returns:

the busyWaitLimit of the phaser.

getSigPhase

public int getSigPhase()

Returns the signal phase number of this phaser in the currently executing task.

Specified by:

getSigPhase in interface HjPhaser

Returns:

the signal phase number of this phaser in the currently executing task

getWaitPhase

public int getWaitPhase()

Returns the wait phase number of this phaser in the currently executing task.

Specified by:

getWaitPhase in interface HjPhaser

Returns:

the wait phase number of this phaser in the currently executing task

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()
            throws SuspendableException

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

Throws:

SuspendableException

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()
            throws SuspendableException

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

Throws:

SuspendableException

doWaitSingle1

public boolean doWaitSingle1()
                      throws SuspendableException

doWaitSingle1.

Specified by:

doWaitSingle1 in interface InternalPhaser

Returns:

a boolean.

Throws:

SuspendableException

doWaitSingle1

public boolean doWaitSingle1(String loc)
                      throws SuspendableException

doWaitSingle1.

Specified by:

doWaitSingle1 in interface InternalPhaser

Parameters:

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

Returns:

a boolean.

Throws:

SuspendableException

doWaitSingle2

public void doWaitSingle2()
                   throws SuspendableException

doWaitSingle2.

Specified by:

doWaitSingle2 in interface InternalPhaser

Throws:

SuspendableException

drop

public void drop(boolean activityEndSignal)

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

Parameters:

activityEndSignal - true if drop() was called from deregister() in activityEnd event

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(HabaneroActivity activity,
                     HjPhaserMode mode)

register.

Specified by:

register in interface InternalPhaser

Parameters:

activity - a HabaneroActivity 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.