edu.rice.hj.runtime.phasers

Interface PhaserManager

All Superinterfaces:

ActivityListeners.ActivityListener

All Known Implementing Classes:

PhaserManagerImpl

public interface PhaserManager
extends ActivityListeners.ActivityListener

Defines the interface between an Activity and its Phasers.

Author:

Shams Imam (shams@rice.edu), vcave

Method Summary

Modifier and Type	Method and Description
void	checkPhaserUse(InternalPhaser ph, HjPhaserMode prm) Validates the use of a phaser in the current context.
void	doNext(HabaneroActivity activity) Performs a next operation with the given activity.
void	doSignal(HabaneroActivity activity, boolean earlySignal) Performs a phaser signal operation with the given activity.
void	doSignal(HabaneroActivity activity, InternalPhaser phaser, boolean earlySignal, boolean fromDrop) Performs a signal operation with the given activity.
void	doWait(HabaneroActivity activity) Performs a phaser wait operation with the given activity.
void	doWait(HabaneroActivity activity, InternalPhaser phaser) Performs a wait operation with the given activity.
boolean	doWaitForNextSinglePhase1(HabaneroActivity activity, InternalPhaser phaser, String loc) Performs the first stage wait operation with the given activity in next-with-signal mode.
void	doWaitForNextSinglePhase2(HabaneroActivity activity, InternalPhaser phaser) Performs the second stage wait operation with the given activity in next-with-signal mode.
boolean	dropPhaser(HabaneroActivity activity, InternalPhaser phaser, boolean activityEndSignal) Drops the phaser registered with an activity.
int	getSigPhase(HabaneroActivity activity, InternalPhaser phaser) getSigPhase.
int	getWaitPhase(HabaneroActivity activity, InternalPhaser phaser) getWaitPhase.
void	inheritPhasers(HabaneroActivity parentActivity, HabaneroActivity childActivity) Registers a phaser to the specified activity.
HjPhaserMode	phaserMode(HabaneroActivity activity, InternalPhaser phaser) phaserMode.
void	register(HabaneroActivity parentActivity, HabaneroActivity childActivity, InternalPhaser phaser, HjPhaserMode phaserMode) register.
boolean	registered(HabaneroActivity activity, InternalPhaser phaser) registered.
void	registerPhaserToIEF(HabaneroActivity activity, InternalPhaser phaser) Registers a phaser to the immediately enclosing finish defined by the activity.
boolean	resumed(HabaneroActivity activity, InternalPhaser phaser) resumed.

Methods inherited from interface edu.rice.hj.runtime.baseruntime.ActivityListeners.ActivityListener

onActivityDependenciesReady, onActivityEnd, onActivityResume, onActivitySpawn, onActivityStart, onActivitySuspend, onFinishScopeStart, onPhaserReady, onPostFinishScopeEnd, onPreFinishScopeEnd, updateActivityFromCompanion, updateCompanionFromActivity

Method Detail

checkPhaserUse

void checkPhaserUse(InternalPhaser ph,
                    HjPhaserMode prm)

Validates the use of a phaser in the current context.

Parameters:

ph - The phaser

prm - The phaser mode

inheritPhasers

void inheritPhasers(HabaneroActivity parentActivity,
                    HabaneroActivity childActivity)

Registers a phaser to the specified activity.

Parameters:

parentActivity - The activity to inherit phasers from.

childActivity - The new child activity.

register

void register(HabaneroActivity parentActivity,
              HabaneroActivity childActivity,
              InternalPhaser phaser,
              HjPhaserMode phaserMode)

register.

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 - The phaser registration mode

registerPhaserToIEF

void registerPhaserToIEF(HabaneroActivity activity,
                         InternalPhaser phaser)

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

Parameters:

activity - The activity which determines the IEF.

phaser - The phaser to register to the IEF.

dropPhaser

boolean dropPhaser(HabaneroActivity activity,
                   InternalPhaser phaser,
                   boolean activityEndSignal)

Drops the phaser registered with an activity.

Parameters:

activity - The activity from which to drop the phaser.

phaser - The phaser to drop.

activityEndSignal - Whether the phaser is dropped in an activity end event

Returns:

a boolean.

registered

boolean registered(HabaneroActivity activity,
                   InternalPhaser phaser)

registered.

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser is registered with the activity.

resumed

boolean resumed(HabaneroActivity activity,
                InternalPhaser phaser)

resumed.

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

whether the phaser has been resumed.

phaserMode

HjPhaserMode phaserMode(HabaneroActivity activity,
                        InternalPhaser phaser)

phaserMode.

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

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

getSigPhase

int getSigPhase(HabaneroActivity activity,
                InternalPhaser phaser)

getSigPhase.

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The signal phase of the phaser in the specified activity.

getWaitPhase

int getWaitPhase(HabaneroActivity activity,
                 InternalPhaser phaser)

getWaitPhase.

Parameters:

activity - The activity.

phaser - The phaser.

Returns:

The wait phase of the phaser in the specified activity.

doNext

void doNext(HabaneroActivity activity)
     throws SuspendableException

Performs a next operation with the given activity.

Parameters:

activity - The activity.

Throws:

SuspendableException

doSignal

void doSignal(HabaneroActivity activity,
              boolean earlySignal)

Performs a phaser signal operation with the given activity.

Parameters:

activity - The activity.

earlySignal - Flag determining whether this is an eager signal

doSignal

void doSignal(HabaneroActivity activity,
              InternalPhaser phaser,
              boolean earlySignal,
              boolean fromDrop)

Performs a signal operation with the given activity.

Parameters:

activity - The activity.

phaser - The phaser.

earlySignal - Flag determining whether this is an eager signal

fromDrop - Flag determining whether this signal came from a drop call (to prevent double signal logging)

doWait

void doWait(HabaneroActivity activity)
     throws SuspendableException

Performs a phaser wait operation with the given activity.

Parameters:

activity - The activity.

Throws:

SuspendableException

doWait

void doWait(HabaneroActivity activity,
            InternalPhaser phaser)
     throws SuspendableException

Performs a wait operation with the given activity.

Parameters:

activity - The activity.

phaser - The phaser.

Throws:

SuspendableException

doWaitForNextSinglePhase1

boolean doWaitForNextSinglePhase1(HabaneroActivity activity,
                                  InternalPhaser phaser,
                                  String loc)
                           throws SuspendableException

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

Parameters:

activity - The activity.

phaser - The phaser.

loc - The location of the next operation

Returns:

a boolean.

Throws:

SuspendableException

doWaitForNextSinglePhase2

void doWaitForNextSinglePhase2(HabaneroActivity activity,
                               InternalPhaser phaser)
                        throws SuspendableException

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

Parameters:

activity - The activity.

phaser - The phaser.

Throws:

SuspendableException