edu.rice.hj.runtime.phasers

Class BlockingPhaserManager

java.lang.Object

edu.rice.hj.runtime.phasers.BlockingPhaserManager

All Implemented Interfaces:

ActivityListeners.ActivityListener, PhaserManager

public final class BlockingPhaserManager
extends Object
implements PhaserManager

BlockingPhaserManager class.

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockingPhaserManager.PhaserEventType

Constructor Summary

Constructors

Constructor and Description
BlockingPhaserManager(PropertyChangeListener changeListener) No-args constructor.

Method Summary

Modifier and Type	Method and Description
void	checkPhaserUse(InternalPhaser ph, HjPhaserMode prm) Validates the use of a phaser in the current context.
protected void	deregisterPhasers(BlockingActivity activity) deregisterPhasers.
void	doNext(BlockingActivity activity) Performs a next operation with the given activity.
protected int	doNextSinglePhase1(BlockingActivity activity, String loc) doNextSinglePhase1.
protected void	doNextSinglePhase2(BlockingActivity activity) doNextSinglePhase2.
void	doSignal(BlockingActivity activity) Performs a phaser signal operation with the given activity.
void	doSignal(BlockingActivity activity, InternalPhaser phaser) Performs a signal operation with the given activity.
void	doWait(BlockingActivity activity) Performs a phaser wait operation with the given activity.
void	doWait(BlockingActivity activity, InternalPhaser phaser) Performs a wait operation with the given activity.
boolean	doWaitForNextSinglePhase1(BlockingActivity activity, InternalPhaser phaser, String loc) Performs the first stage wait operation with the given activity in next-with-signal mode.
void	doWaitForNextSinglePhase2(BlockingActivity activity, InternalPhaser phaser) Performs the second stage wait operation with the given activity in next-with-signal mode.
boolean	dropPhaser(BlockingActivity activity, InternalPhaser phaser) Drops the phaser registered with an activity.
int	getSigPhase(BlockingActivity activity, InternalPhaser phaser) getSigPhase.
int	getWaitPhase(BlockingActivity activity, InternalPhaser phaser) getWaitPhase.
void	inheritPhasers(BlockingActivity parentActivity, BlockingActivity childActivity) Registers a phaser to the specified activity.
void	onActivityEnd(BlockingActivity activity, BlockingFinishState finishState) Call back for when the event ends execution.
void	onActivityResume(BlockingActivity activity) Call back for when the event execution is resumed.
void	onActivitySpawn(BlockingActivity parentActivity, BlockingActivity childActivity) Call back for when the event ends execution.
void	onActivityStart(BlockingActivity activity) Call back for when the event starts execution.
void	onActivitySuspend(BlockingActivity activity) Call back for when the event execution is suspended.
void	onFinishScopeStart(BlockingActivity activity, BlockingFinishState finishState)
void	onPostFinishScopeEnd(BlockingActivity activity, BlockingFinishState finishState)
void	onPreFinishScopeEnd(BlockingActivity activity, BlockingFinishState finishState)
HjPhaserMode	phaserMode(BlockingActivity activity, InternalPhaser phaser) phaserMode.
void	register(BlockingActivity parentActivity, BlockingActivity childActivity, InternalPhaser phaser, HjPhaserMode phaserMode) register.
boolean	registered(BlockingActivity activity, InternalPhaser phaser) registered.
void	registerPhaserToIEF(BlockingActivity activity, InternalPhaser phaser) Registers a phaser to the immediately enclosing finish defined by the activity.
protected void	resume(BlockingActivity activity, InternalPhaser phaser, boolean newValue) resume.
boolean	resumed(BlockingActivity activity, InternalPhaser phaser) resumed.
protected static void	throwPhaserException(String message) throws PhaserException with the specified message
String	toString()
void	updateActivityFromCompanion(BlockingActivity activity, CompanionMetrics companionMetrics)
void	updateCompanionFromActivity(BlockingActivity activity, CompanionMetrics companionMetrics)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingPhaserManager

public BlockingPhaserManager(PropertyChangeListener changeListener)

No-args constructor.

Parameters:

changeListener - a PropertyChangeListener object.

Method Detail

throwPhaserException

protected static void throwPhaserException(String message)

throws PhaserException with the specified message

Parameters:

message - The Exception message

Throws:

PhaserException - with the specified message

checkPhaserUse

public void checkPhaserUse(InternalPhaser ph,
                           HjPhaserMode prm)

Description copied from interface: PhaserManager

Validates the use of a phaser in the current context.

Specified by:

checkPhaserUse in interface PhaserManager

Parameters:

ph - The phaser

prm - The phaser mode

onActivityStart

public void onActivityStart(BlockingActivity activity)

Call back for when the event starts execution.

Specified by:

onActivityStart in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being started.

onActivitySuspend

public void onActivitySuspend(BlockingActivity activity)

Call back for when the event execution is suspended.

Specified by:

onActivitySuspend in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being suspended.

onActivityResume

public void onActivityResume(BlockingActivity activity)

Call back for when the event execution is resumed.

Specified by:

onActivityResume in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity being resumed.

onActivityEnd

public void onActivityEnd(BlockingActivity activity,
                          BlockingFinishState finishState)

Call back for when the event ends execution.

Specified by:

onActivityEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that is ending.

finishState - The root finish state associated with the activity

onActivitySpawn

public void onActivitySpawn(BlockingActivity parentActivity,
                            BlockingActivity childActivity)

Call back for when the event ends execution.

Specified by:

onActivitySpawn in interface ActivityListeners.ActivityListener

Parameters:

parentActivity - The parent activity.

childActivity - The child activity that was spawned.

onFinishScopeStart

public void onFinishScopeStart(BlockingActivity activity,
                               BlockingFinishState finishState)

Specified by:

onFinishScopeStart in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity running the finish scope

finishState - The finish state associated with the activity

onPreFinishScopeEnd

public void onPreFinishScopeEnd(BlockingActivity activity,
                                BlockingFinishState finishState)

Specified by:

onPreFinishScopeEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that ran the finish scope

finishState - The finish state associated with the activity

onPostFinishScopeEnd

public void onPostFinishScopeEnd(BlockingActivity activity,
                                 BlockingFinishState finishState)

Specified by:

onPostFinishScopeEnd in interface ActivityListeners.ActivityListener

Parameters:

activity - The activity that ran the finish scope

finishState - The finish state associated with the activity

updateCompanionFromActivity

public void updateCompanionFromActivity(BlockingActivity activity,
                                        CompanionMetrics companionMetrics)

Specified by:

updateCompanionFromActivity in interface ActivityListeners.ActivityListener

updateActivityFromCompanion

public void updateActivityFromCompanion(BlockingActivity activity,
                                        CompanionMetrics companionMetrics)

Specified by:

updateActivityFromCompanion in interface ActivityListeners.ActivityListener

dropPhaser

public boolean dropPhaser(BlockingActivity activity,
                          InternalPhaser phaser)

Drops the phaser registered with an activity.

Specified by:

dropPhaser in interface PhaserManager

Parameters:

activity - The activity from which to drop the phaser.

phaser - The phaser to drop.

Returns:

a boolean.

deregisterPhasers

protected void deregisterPhasers(BlockingActivity activity)

deregisterPhasers.

Parameters:

activity - a BlockingActivity object.

registered

public boolean registered(BlockingActivity activity,
                          InternalPhaser phaser)

registered.

Specified by:

registered in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser is registered with the activity.

registerPhaserToIEF

public void registerPhaserToIEF(BlockingActivity activity,
                                InternalPhaser phaser)

Registers a phaser to the immediately enclosing finish defined by the activity.

Specified by:

registerPhaserToIEF in interface PhaserManager

Parameters:

activity - The activity which determines the IEF.

phaser - The phaser to register to the IEF.

inheritPhasers

public void inheritPhasers(BlockingActivity parentActivity,
                           BlockingActivity childActivity)

Registers a phaser to the specified activity.

Specified by:

inheritPhasers in interface PhaserManager

Parameters:

parentActivity - The activity to inherit phasers from.

childActivity - The new child activity.

register

public void register(BlockingActivity parentActivity,
                     BlockingActivity childActivity,
                     InternalPhaser phaser,
                     HjPhaserMode phaserMode)

register.

Specified by:

register in interface PhaserManager

Parameters:

parentActivity - The activity to inherit phasers from.

childActivity - The new child activity.

phaser - The new phaser to inherit

phaserMode - The phaser registration mode

phaserMode

public HjPhaserMode phaserMode(BlockingActivity activity,
                               InternalPhaser phaser)

phaserMode.

Specified by:

phaserMode in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

the mode in which the phaser was registered with this activity.

resume

protected void resume(BlockingActivity activity,
                      InternalPhaser phaser,
                      boolean newValue)

resume.

Parameters:

activity - a BlockingActivity object.

phaser - a InternalPhaser object.

newValue - a boolean.

resumed

public boolean resumed(BlockingActivity activity,
                       InternalPhaser phaser)

resumed.

Specified by:

resumed in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser has been resumed.

getSigPhase

public int getSigPhase(BlockingActivity activity,
                       InternalPhaser phaser)

getSigPhase.

Specified by:

getSigPhase in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The signal phase of the phaser in the specified activity.

getWaitPhase

public int getWaitPhase(BlockingActivity activity,
                        InternalPhaser phaser)

getWaitPhase.

Specified by:

getWaitPhase in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The wait phase of the phaser in the specified activity.

doNext

public void doNext(BlockingActivity activity)

Performs a next operation with the given activity.

Specified by:

doNext in interface PhaserManager

Parameters:

activity - The activity.

doNextSinglePhase1

protected int doNextSinglePhase1(BlockingActivity activity,
                                 String loc)

doNextSinglePhase1.

Parameters:

activity - a BlockingActivity object.

loc - a String object.

Returns:

a int.

doNextSinglePhase2

protected void doNextSinglePhase2(BlockingActivity activity)

doNextSinglePhase2.

Parameters:

activity - a BlockingActivity object.

doSignal

public void doSignal(BlockingActivity activity)

Performs a phaser signal operation with the given activity.

Specified by:

doSignal in interface PhaserManager

Parameters:

activity - The activity.

doSignal

public void doSignal(BlockingActivity activity,
                     InternalPhaser phaser)

Performs a signal operation with the given activity.

Specified by:

doSignal in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

doWait

public void doWait(BlockingActivity activity)

Performs a phaser wait operation with the given activity.

Specified by:

doWait in interface PhaserManager

Parameters:

activity - The activity.

doWait

public void doWait(BlockingActivity activity,
                   InternalPhaser phaser)

Performs a wait operation with the given activity.

Specified by:

doWait in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

doWaitForNextSinglePhase1

public boolean doWaitForNextSinglePhase1(BlockingActivity activity,
                                         InternalPhaser phaser,
                                         String loc)

Performs the first stage wait operation with the given activity in next-with-signal mode.

Specified by:

doWaitForNextSinglePhase1 in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

loc - The location of the next operation

Returns:

a boolean.

doWaitForNextSinglePhase2

public void doWaitForNextSinglePhase2(BlockingActivity activity,
                                      InternalPhaser phaser)

Performs the second stage wait operation with the given activity in next-with-signal mode.

Specified by:

doWaitForNextSinglePhase2 in interface PhaserManager

Parameters:

activity - The activity.

phaser - The phaser.

toString

public String toString()

Overrides:

toString in class Object