edu.rice.hj.runtime.baseruntime

Class BaseRuntime

java.lang.Object

edu.rice.hj.runtime.baseruntime.BaseRuntime

All Implemented Interfaces:

HjRuntime

Direct Known Subclasses:

ForkJoinRuntime, SimtRuntime

public abstract class BaseRuntime
extends Object
implements HjRuntime

BaseRuntime class.

Author:

Shams Imam (shams@rice.edu) (final shams@rice.edu)

Field Summary

Fields

Modifier and Type	Field and Description
protected DeadlockTracker	deadlockTracker Deals with deadlock tracking
EventLogger	eventLogger The event logger
protected IsolationManager	isolationManager The IsolationManager used to run the isolated construct
AbstractMetricsManager	metricsManager The abstract metrics manager
protected PhaserManager	phaserManager Deals with phaser related operations

Constructor Summary

Constructors

Constructor and Description
BaseRuntime() No-args constructor.

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts the currently executing task.
HjMetrics	abstractMetrics() abstractMetrics.
protected abstract BaseThreadPool[]	allocateExecutors(int numPlaces, int numWorkers, boolean asyncMode)
<T> void	asyncAwait(List<HjFuture<T>> dependencies, HjRunnable runnable) Will execute the body of the runnable only after the dependences have been satisfied.
void	asyncPhased(List<HjPhaserPair> phaserList, HjSuspendable suspendable) asyncPhased.
void	asyncSeqAt(boolean sequentialize, HjPlace place, HjRunnable runnable) Runs the body of code (possibly) asynchronously at the specified place.
void	asyncSuspAt(HjPlace place, HjSuspendable suspendable) Runs the body of code (possibly) asynchronously at the specified place.
<T> void	asyncSuspAwait(List<HjFuture<T>> dependencies, HjSuspendable suspendable) Will execute the body of the runnable only after the dependences have been satisfied.
void	asyncWhen(HjExpression.HjAwaitExpression expression, HjRunnable hjRunnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
<T> void	checkEureka(T eurekaValue)
void	cleanup() Cleans up the runtime in anticipation for shutdown.
HabaneroActivity	currentActivity() Returns The currently executing activity.
static HabaneroActivity	currentHabaneroActivity() currentBlockingActivity.
HjPlace	currentPlace()
static BaseThread	currentThread() currentThread.
void	doWait() Perform the wait operation on all registered phasers in an activity.
void	doWork(long workUnits) Registers n units of work against the currently running activity.
void	dumpEventLog(PrintStream printStream) Dumps the events tracked by the runtime.
void	emergencyShutdown(Throwable cause) Shutdown the runtime, this means also shutting down all places associated with this runtime and all currently executing activities.
void	finish(HjEureka<?,?,?> hjEureka, HjSuspendable suspendable) Registers a HjEureka with the finish scope and continues to execute the body of the finish scope.
void	finish(HjSuspendable suspendable) Runs the body of code in a finish block.
void	finish(List<HjFinishAccumulator> accumulators, HjSuspendable suspendable) finish.
<T,V> HjFuture<V>	futureAwait(List<HjFuture<T>> dependencies, HjCallable<V> callable) Equivalent of HjRuntime.asyncAwait(java.util.List, HjRunnable) which returns a futureNb.
<V> HjFuture<V>	futureSeq(boolean sequentialize, HjCallable<V> callable) Creates an asynchronous task and returns the futureNb object representing the value of the computation.
<V> HjFuture<V>	futureSusp(HjSuspendingCallable<V> callable) Creates an asynchronous task and returns the futureNb object representing the value of the computation.
<T,V> HjFuture<V>	futureSuspAwait(List<HjFuture<T>> dependencies, HjSuspendingCallable<V> callable) Equivalent of HjRuntime.asyncAwait(java.util.List, HjRunnable) which returns a future.
<V> HjFuture<V>	futureWhen(HjExpression.HjAwaitExpression expression, HjCallable<V> hjCallable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
protected static String	generateActivityName(String inName) generateActivityName.
void	initialize() Initializes the runtime.
void	isolated(HjRunnable runnable) isolated.
void	isolated(Object[] participants, HjRunnable runnable) Isolated statement identifies a critical section.
void	isolated(Object participant, HjRunnable runnable) Isolated statement identifies a critical section.
<V> V	isolatedWithReturn(HjCallable<V> callable) isolatedWithReturn.
<V> V	isolatedWithReturn(Object[] participants, HjCallable<V> callable) isolatedWithReturn.
<V> V	isolatedWithReturn(Object participant, HjCallable<V> callable) isolatedWithReturn.
static boolean	isWorkerThread() isWorkerThread.
<L,R> HjBinaryEureka<L,R>	newBinaryEureka(HjLogicalOperator operator, HjEureka<L,Object,L> leftEureka, HjEureka<R,Object,R> rightEureka) Factory method to create a new HjBinaryEureka instance.
<T> HjConvergenceEureka<T>	newConvergenceEureka(T initialValue, java.util.function.BiPredicate<T,T> checker, HjProcedure<T> convergenceCallback) Factory method to create a new HjConvergenceEureka instance.
<T> HjCountEureka<T>	newCountEureka(long maxCount, int spaceForResult) Factory method to create a new HjCountEureka instance.
<V> HjDataDrivenFuture<V>	newDataDrivenFuture(boolean allowDuplicatePuts) Factory method for a DataDrivenFuture.
<T> HjEngineEureka<T>	newEngineEureka(int maxUnits) Factory method to create a new HjEngineEureka instance.
HjEventCount	newEventCount(int initialCount) Returns a new instance of an HjEventCount.
<T> HjExtremaEureka<T>	newExtremaEureka(T initialValue, Comparator<T> comparator, boolean shouldAbortOnOffer) Factory method to create a new HjExtremaEureka instance.
HjFastBarrierEureka	newFastBarrierEureka(int numPhases) Factory method to create a new HjFastBarrierEureka instance.
HjFinishAccumulator	newFinishAccumulator(HjOperator ope, Class type) newFinishAccumulator.
HjPhaser	newPhaser(HjPhaserMode phaserMode, int busyWaitLimit) Create a new phaser in the specified registration mode..
<T> HjSearchEureka<T>	newSearchEureka(T initialValue) Factory method to create a new HjSearchEureka instance.
<T> HjTimerEureka<T>	newTimerEureka(int timeUnitsInMillis) Factory method to create a new HjTimerEureka instance.
<T> HjVersionEureka<T>	newVersionEureka(int n) Factory method to create a new HjVersionEureka instance.
void	next() Perform the next operation on all registered phasers in an activity.
int	numWorkerThreads() Returns the number of worker threads employed by the runtime for the current place.
<T> void	offerEureka(T eurekaValue)
<T> T	readEureka() Return the current value stored on the registered eureka.
Object	readMode(Object wrappee) readMode.
void	registerListenerForMetrics(HabaneroActivity habaneroActivity) registerListenerForMetrics.
<T> HjEureka<T,T,T>	retrieveEureka() Return the eureka to be registered in the finish scope.
HjEventLogger	retrieveEventLogger() Retrieves the HjEventLogger used by the runtime.
protected void	runActivity(HabaneroActivity activity) Submit an activity to place's thread pool This method is initialize some activity properties such as FinishState and current Place.
void	runKernel(HjSuspendable suspendable) Entry of the user's program body into the Habanero runtime.
void	scheduleActivity(HjPlace hjPlace, Runnable runnable) Schedules an activity whose body is represented by the Runnable instance.
void	scheduleActivity(Runnable runnable) Schedules an activity whose body is represented by the Runnable instance.
void	signal() Perform the signal operation on all registered phasers in an activity.
Object	writeMode(Object wrappee) writeMode.

Methods inherited from class java.lang.Object

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

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

asyncSimt

Field Detail

metricsManager

public final AbstractMetricsManager metricsManager

The abstract metrics manager

eventLogger

public final EventLogger eventLogger

The event logger

isolationManager

protected final IsolationManager isolationManager

The IsolationManager used to run the isolated construct

phaserManager

protected final PhaserManager phaserManager

Deals with phaser related operations

deadlockTracker

protected final DeadlockTracker deadlockTracker

Deals with deadlock tracking

Constructor Detail

BaseRuntime

public BaseRuntime()

No-args constructor.

Method Detail

allocateExecutors

protected abstract BaseThreadPool[] allocateExecutors(int numPlaces,
                                                      int numWorkers,
                                                      boolean asyncMode)

isWorkerThread

public static boolean isWorkerThread()

isWorkerThread.

Returns:

a reference to the currently executing ForkjoinThread

currentThread

public static BaseThread currentThread()

currentThread.

Returns:

a reference to the currently executing BaseThread

initialize

public void initialize()

Initializes the runtime.

Specified by:

initialize in interface HjRuntime

runKernel

public void runKernel(HjSuspendable suspendable)

Entry of the user's program body into the Habanero runtime.

Specified by:

runKernel in interface HjRuntime

Parameters:

suspendable - The body of the kernel

cleanup

public void cleanup()

Cleans up the runtime in anticipation for shutdown.

Specified by:

cleanup in interface HjRuntime

currentActivity

public HabaneroActivity currentActivity()

Returns The currently executing activity.

Specified by:

currentActivity in interface HjRuntime

Returns:

The currently executing activity.

scheduleActivity

public void scheduleActivity(Runnable runnable)

Schedules an activity whose body is represented by the Runnable instance.

Specified by:

scheduleActivity in interface HjRuntime

Parameters:

runnable - The runnable activity to schedule.

scheduleActivity

public void scheduleActivity(HjPlace hjPlace,
                             Runnable runnable)

Schedules an activity whose body is represented by the Runnable instance.

Specified by:

scheduleActivity in interface HjRuntime

Parameters:

hjPlace - The place at which to schedule this activity.

runnable - The runnable activity to schedule.

numWorkerThreads

public int numWorkerThreads()

Returns the number of worker threads employed by the runtime for the current place.

Specified by:

numWorkerThreads in interface HjRuntime

Returns:

the number of worker threads employed by the runtime for the current place.

currentPlace

public HjPlace currentPlace()

Specified by:

currentPlace in interface HjRuntime

Returns:

the current place of execution

finish

public void finish(HjSuspendable suspendable)
            throws SuspendableException

Runs the body of code in a finish block.

Specified by:

finish in interface HjRuntime

Parameters:

suspendable - The body of the code to run wrapped in a finish block.

Throws:

SuspendableException

generateActivityName

protected static String generateActivityName(String inName)

generateActivityName.

Parameters:

inName - The undecorated activity name

Returns:

The activity name prefixed with location info if the LOCATION_IN_NAME_FLAG is set

asyncSeqAt

public void asyncSeqAt(boolean sequentialize,
                       HjPlace place,
                       HjRunnable runnable)

Runs the body of code (possibly) asynchronously at the specified place.

Specified by:

asyncSeqAt in interface HjRuntime

Parameters:

sequentialize - The flag that determines whether the runtime should consider running the body asynchronously.

place - The place where the async task should run. This parameter may be ignored if the task is to be run sequentially.

runnable - The body of the code to run, possibly asynchronously.

asyncSuspAt

public final void asyncSuspAt(HjPlace place,
                              HjSuspendable suspendable)

Runs the body of code (possibly) asynchronously at the specified place.

Specified by:

asyncSuspAt in interface HjRuntime

Parameters:

place - The place where the async task should run. This parameter may be ignored if the task is to be run sequentially.

suspendable - The body of the code to run, possibly asynchronously. The body of the code possibly contains a suspendable condition.

futureSeq

public <V> HjFuture<V> futureSeq(boolean sequentialize,
                                 HjCallable<V> callable)

Creates an asynchronous task and returns the futureNb object representing the value of the computation. Run the body of code (a)synchronously based on boolean parameter.

Specified by:

futureSeq in interface HjRuntime

Type Parameters:

V - The return type of the body.

Parameters:

sequentialize - The flag that determines whether the runtime should consider running the body asynchronously.

callable - The body of the callable to run, possibly asynchronously.

Returns:

The futureNb object representing the value of the computation.

futureSusp

public <V> HjFuture<V> futureSusp(HjSuspendingCallable<V> callable)

Creates an asynchronous task and returns the futureNb object representing the value of the computation. Run the body of code (a)synchronously based on boolean parameter.

Specified by:

futureSusp in interface HjRuntime

Type Parameters:

V - The return type of the body.

Parameters:

callable - The body of the callable to run, possibly asynchronously.

Returns:

The futureNb object representing the value of the computation.

futureAwait

public <T,V> HjFuture<V> futureAwait(List<HjFuture<T>> dependencies,
                                     HjCallable<V> callable)

Equivalent of HjRuntime.asyncAwait(java.util.List, HjRunnable) which returns a futureNb.

Specified by:

futureAwait in interface HjRuntime

V - The return type of the body.

Parameters:

dependencies - The data dependencies of the asynchronous task

callable - The body of the callable to run, possibly asynchronously.

Returns:

The futureNb object representing the value of the computation.

futureSuspAwait

public <T,V> HjFuture<V> futureSuspAwait(List<HjFuture<T>> dependencies,
                                         HjSuspendingCallable<V> callable)

Equivalent of HjRuntime.asyncAwait(java.util.List, HjRunnable) which returns a future.

Specified by:

futureSuspAwait in interface HjRuntime

V - The return type of the body.

Parameters:

dependencies - The data dependencies of the asynchronous task

callable - The body of the callable to run, possibly asynchronously.

Returns:

The futureNb object representing the value of the computation.

newDataDrivenFuture

public <V> HjDataDrivenFuture<V> newDataDrivenFuture(boolean allowDuplicatePuts)

Factory method for a DataDrivenFuture.

Specified by:

newDataDrivenFuture in interface HjRuntime

Type Parameters:

V - The type of the data wrapped in the DDF.

Returns:

a new instance of a HjDataDrivenFuture

asyncAwait

public <T> void asyncAwait(List<HjFuture<T>> dependencies,
                           HjRunnable runnable)

Will execute the body of the runnable only after the dependences have been satisfied.

Specified by:

asyncAwait in interface HjRuntime

Parameters:

dependencies - The data dependencies of the asynchronous task

runnable - The body of the code to run, possibly asynchronously.

asyncSuspAwait

public <T> void asyncSuspAwait(List<HjFuture<T>> dependencies,
                               HjSuspendable suspendable)

Will execute the body of the runnable only after the dependences have been satisfied.

Specified by:

asyncSuspAwait in interface HjRuntime

Parameters:

dependencies - The data dependencies of the asynchronous task

suspendable - The body of the code to run, possibly asynchronously.

isolated

public void isolated(HjRunnable runnable)

isolated.

Specified by:

isolated in interface HjRuntime

Parameters:

runnable - The body of the code to run using weak isolation.

isolated

public void isolated(Object participant,
                     HjRunnable runnable)

Isolated statement identifies a critical section. Two tasks executing isolated statements must perform them in mutual exclusion.

Specified by:

isolated in interface HjRuntime

Parameters:

participant - The object involved in the atomic block.

runnable - The body of the code to run using weak isolation.

isolated

public void isolated(Object[] participants,
                     HjRunnable runnable)

Isolated statement identifies a critical section. Two tasks executing isolated statements must perform them in mutual exclusion.

Specified by:

isolated in interface HjRuntime

Parameters:

participants - The objects involved in the atomic block.

runnable - The body of the code to run using weak isolation.

isolatedWithReturn

public <V> V isolatedWithReturn(HjCallable<V> callable)

isolatedWithReturn.

Specified by:

isolatedWithReturn in interface HjRuntime

Type Parameters:

V - a V object.

Parameters:

callable - The body of the code to run using weak isolation.

Returns:

a V object.

isolatedWithReturn

public <V> V isolatedWithReturn(Object participant,
                                HjCallable<V> callable)

isolatedWithReturn.

Specified by:

isolatedWithReturn in interface HjRuntime

Type Parameters:

V - a V object.

Parameters:

participant - The object involved in the atomic block.

callable - The body of the code to run using weak isolation.

Returns:

a V object.

isolatedWithReturn

public <V> V isolatedWithReturn(Object[] participants,
                                HjCallable<V> callable)

isolatedWithReturn.

Specified by:

isolatedWithReturn in interface HjRuntime

Type Parameters:

V - a V object.

Parameters:

participants - The objects involved in the atomic block.

callable - The body of the code to run using weak isolation.

Returns:

a V object.

readMode

public Object readMode(Object wrappee)

readMode.

Specified by:

readMode in interface HjRuntime

Parameters:

wrappee - The Object whose mode to control

Returns:

a wrapper to represent read mode for isolated statement.

writeMode

public Object writeMode(Object wrappee)

writeMode.

Specified by:

writeMode in interface HjRuntime

Parameters:

wrappee - The Object whose mode to control

Returns:

a wrapper to represent write mode for isolated statement.

newFinishAccumulator

public HjFinishAccumulator newFinishAccumulator(HjOperator ope,
                                                Class type)

newFinishAccumulator.

Specified by:

newFinishAccumulator in interface HjRuntime

Parameters:

ope - The type of the HjOperator

type - The result type

Returns:

a new FinishAccumulator instance

finish

public void finish(List<HjFinishAccumulator> accumulators,
                   HjSuspendable suspendable)
            throws SuspendableException

finish.

Specified by:

finish in interface HjRuntime

Parameters:

accumulators - The accumulators registered on the finish.

suspendable - The body of the code to run wrapped in a finish block.

Throws:

SuspendableException

newPhaser

public HjPhaser newPhaser(HjPhaserMode phaserMode,
                          int busyWaitLimit)

Create a new phaser in the specified registration mode..

Specified by:

newPhaser in interface HjRuntime

Parameters:

phaserMode - The phaser registration mode.

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

Returns:

a newly allocated phaser.

currentHabaneroActivity

public static HabaneroActivity currentHabaneroActivity()

currentBlockingActivity.

Returns:

a HabaneroActivity object.

asyncPhased

public void asyncPhased(List<HjPhaserPair> phaserList,
                        HjSuspendable suspendable)

asyncPhased.

Specified by:

asyncPhased in interface HjRuntime

Parameters:

phaserList - The list of phasers the async is registered on.

suspendable - The body of the code to run, possibly asynchronously.

next

public void next()
          throws SuspendableException

Perform the next operation on all registered phasers in an activity.

Specified by:

next in interface HjRuntime

Throws:

SuspendableException

signal

public void signal()

Perform the signal operation on all registered phasers in an activity.

Specified by:

signal in interface HjRuntime

doWait

public void doWait()
            throws SuspendableException

Perform the wait operation on all registered phasers in an activity.

Specified by:

doWait in interface HjRuntime

Throws:

SuspendableException

emergencyShutdown

public void emergencyShutdown(Throwable cause)

Shutdown the runtime, this means also shutting down all places associated with this runtime and all currently executing activities.

Specified by:

emergencyShutdown in interface HjRuntime

Parameters:

cause - The exception causing the shutdown.

doWork

public void doWork(long workUnits)

Registers n units of work against the currently running activity.

Specified by:

doWork in interface HjRuntime

Parameters:

workUnits - units of work done

abstractMetrics

public HjMetrics abstractMetrics()

abstractMetrics.

Specified by:

abstractMetrics in interface HjRuntime

Returns:

The abstract metrics associated with the current HJ instance

retrieveEventLogger

public HjEventLogger retrieveEventLogger()

Description copied from interface: HjRuntime

Retrieves the HjEventLogger used by the runtime.

Specified by:

retrieveEventLogger in interface HjRuntime

Returns:

the HjEventLogger used by the runtime.

dumpEventLog

public void dumpEventLog(PrintStream printStream)

Description copied from interface: HjRuntime

Dumps the events tracked by the runtime.

Specified by:

dumpEventLog in interface HjRuntime

Parameters:

printStream - The stream to use while dumping the events.

asyncWhen

public void asyncWhen(HjExpression.HjAwaitExpression expression,
                      HjRunnable hjRunnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

The body of this async is only executed when the expression evaluates to true, the expression can only be safely evaluated after all the futures involved in the expression have been resolved when in strict mode (expression contains a NOT). There is also a short-circuit mode (expression contains only AND and OR) where the expression is evaluated early and the asynchronous computation triggered even when some of the other dependent tasks may not yet have completed execution.

The semantics of

   asyncWhen(awaitExpr, () -> S1)
 

are as follows:

   async(() -> {
     boolean exprVal = expr.evaluate();
     if (exprVal) {
       S1;
     }
   });
 

Specified by:

asyncWhen in interface HjRuntime

Parameters:

expression - The expression that controls when the async is ready for execution.

hjRunnable - The body of the async.

futureWhen

public <V> HjFuture<V> futureWhen(HjExpression.HjAwaitExpression expression,
                                  HjCallable<V> hjCallable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles. Also returns the futureNb object representing the value of the computation.

The body of this async is only executed when the expression evaluates to true, the expression can only be safely evaluated after all the futures involved in the expression have been resolved when in strict mode (expression contains a NOT). There is also a short-circuit mode (expression contains only AND and OR) where the expression is evaluated early and the asynchronous computation triggered even when some of the other dependent tasks may not yet have completed execution.

The semantics of

   futureWhen(awaitExpr, () -> S1)
 

are as follows:

   futureNb(() -> {
     boolean exprVal = expr.evaluate();
     if (exprVal) {
       S1;
     } else {
       throw new RuntimeException("clause failed!");
     }
   });
 

Specified by:

futureWhen in interface HjRuntime

Parameters:

expression - The expression that controls when the async is ready for execution.

hjCallable - The body of the async.

Returns:

The futureNb object representing the value of the computation.

finish

public void finish(HjEureka<?,?,?> hjEureka,
                   HjSuspendable suspendable)
            throws SuspendableException

Registers a HjEureka with the finish scope and continues to execute the body of the finish scope.

Specified by:

finish in interface HjRuntime

Parameters:

hjEureka - the eureka to be registered

suspendable - the body of the finish scope

Throws:

SuspendableException

newSearchEureka

public <T> HjSearchEureka<T> newSearchEureka(T initialValue)

Factory method to create a new HjSearchEureka instance.

Specified by:

newSearchEureka in interface HjRuntime

Parameters:

initialValue - The initial value of the search eureka object

Returns:

A new HjSearchEureka instance

newExtremaEureka

public <T> HjExtremaEureka<T> newExtremaEureka(T initialValue,
                                               Comparator<T> comparator,
                                               boolean shouldAbortOnOffer)

Factory method to create a new HjExtremaEureka instance.

Specified by:

newExtremaEureka in interface HjRuntime

Parameters:

initialValue - The initial value of the extrema, it should be smaller than expected result.

comparator - The comparator used to maximize the extrema value. The first argument of the comparator is the existing value in the eureka, and the second argument is the new argument passed inside the call to offer and check.

shouldAbortOnOffer - Whether a successful offer should abort the current task

Returns:

a new HjExtremaEureka instance.

newConvergenceEureka

public <T> HjConvergenceEureka<T> newConvergenceEureka(T initialValue,
                                                       java.util.function.BiPredicate<T,T> checker,
                                                       HjProcedure<T> convergenceCallback)

Factory method to create a new HjConvergenceEureka instance.

Specified by:

newConvergenceEureka in interface HjRuntime

Parameters:

initialValue - The initial value of the eureka.

checker - The predicate used to check for convergence.

convergenceCallback - A callback invoked once the eureka has converged.

Returns:

a new HjConvergenceEureka instance.

newFastBarrierEureka

public HjFastBarrierEureka newFastBarrierEureka(int numPhases)

Factory method to create a new HjFastBarrierEureka instance.

Specified by:

newFastBarrierEureka in interface HjRuntime

Parameters:

numPhases - The number of phases in the fast barrier.

Returns:

a new HjFastBarrierEureka instance.

newCountEureka

public <T> HjCountEureka<T> newCountEureka(long maxCount,
                                           int spaceForResult)

Factory method to create a new HjCountEureka instance.

Specified by:

newCountEureka in interface HjRuntime

Parameters:

maxCount - The maximum number of eureka events before the eureka is resolved.

spaceForResult - The maximum number of results to store in the eureka.

Returns:

a new HjCountEureka instance.

newVersionEureka

public <T> HjVersionEureka<T> newVersionEureka(int n)

Factory method to create a new HjVersionEureka instance.

Specified by:

newVersionEureka in interface HjRuntime

Parameters:

n - The number of items that need to match before the eureka is resolved.

Returns:

a new HjVersionEureka instance.

See Also:

HjRuntime.newVersionEureka(int)

newEngineEureka

public <T> HjEngineEureka<T> newEngineEureka(int maxUnits)

Factory method to create a new HjEngineEureka instance.

Specified by:

newEngineEureka in interface HjRuntime

Parameters:

maxUnits - The maximum number of time units in the eureka.

Returns:

a new HjEngineEureka instance.

newTimerEureka

public <T> HjTimerEureka<T> newTimerEureka(int timeUnitsInMillis)

Factory method to create a new HjTimerEureka instance.

Specified by:

newTimerEureka in interface HjRuntime

Parameters:

timeUnitsInMillis - The maximum number of milliseconds before the eureka is considered resolved.

Returns:

a new HjTimerEureka instance.

newBinaryEureka

public <L,R> HjBinaryEureka<L,R> newBinaryEureka(HjLogicalOperator operator,
                                                 HjEureka<L,Object,L> leftEureka,
                                                 HjEureka<R,Object,R> rightEureka)

Factory method to create a new HjBinaryEureka instance.

Specified by:

newBinaryEureka in interface HjRuntime

Parameters:

operator - The maximum number of milliseconds before the eureka is considered resolved.

leftEureka - The left eureka instance.

rightEureka - The right eureka instance.

Returns:

a new HjTimerEureka instance.

retrieveEureka

public <T> HjEureka<T,T,T> retrieveEureka()

Return the eureka to be registered in the finish scope.

Specified by:

retrieveEureka in interface HjRuntime

Type Parameters:

T - The type of value stored in the Eureka

Returns:

the eureka to be registered in the finish scope.

offerEureka

public <T> void offerEureka(T eurekaValue)
                     throws SuspendableException

Specified by:

offerEureka in interface HjRuntime

Type Parameters:

T - The type of value stored in the Eureka

Parameters:

eurekaValue - The value to be associated with the eureka

Throws:

SuspendableException

checkEureka

public <T> void checkEureka(T eurekaValue)
                     throws SuspendableException

Specified by:

checkEureka in interface HjRuntime

Type Parameters:

T - The type of value stored in the Eureka

Parameters:

eurekaValue - The value to be associated with the eureka

Throws:

SuspendableException

readEureka

public <T> T readEureka()

Return the current value stored on the registered eureka.

Specified by:

readEureka in interface HjRuntime

Type Parameters:

T - The type of value stored in the Eureka

Returns:

the current value stored on the registered eureka.

abort

public void abort()
           throws SuspendableException

Aborts the currently executing task.

Specified by:

abort in interface HjRuntime

Throws:

SuspendableException

newEventCount

public HjEventCount newEventCount(int initialCount)

Returns a new instance of an HjEventCount.

Specified by:

newEventCount in interface HjRuntime

Returns:

a new instance of an HjEventCount

runActivity

protected void runActivity(HabaneroActivity activity)

Submit an activity to place's thread pool This method is initialize some activity properties such as FinishState and current Place.

Parameters:

activity - The activity to spawn.

registerListenerForMetrics

public void registerListenerForMetrics(HabaneroActivity habaneroActivity)

registerListenerForMetrics.

Parameters:

habaneroActivity - a HabaneroActivity object.