BlockingActivity (habanero-java-lib 0.1-SNAPSHOT API)

java.lang.Object
- edu.rice.hj.runtime.forkjoin.BlockingActivity

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

LingeringBlockingActivity, RunnableBlockingActivity
```
public abstract class BlockingActivity
extends Object
implements Runnable
```
The representation of an HJ asynchronous activity. The activity is run by some worker thread and is always attached to some finish scope. As an activity terminates it decrements the count on its finish scope. The finish scopes can also be stacked up as an activity launches multiple finish blocks, the finish scopes are then popped off as they terminate.

Author:

Vincent Cave (vincent.cave@rice.edu), Shams Imam (shams@rice.edu)

Field Summary

Fields
Modifier and Type	Field and Description
`protected RuntimeException`	`executionException` Exception that occurred while executing the activity
`protected BlockingFinishState`	`launchedFinishState` TODO The FinishState of this activity. !
`protected BlockingFinishState`	`rootFinishState` TODO The FinishState up in the invocation tree within which this activity is being executed.

Constructor Summary

Constructors
Modifier Constructor and Description

protected BlockingActivity(String activityName)
Constructor for BlockingActivity.

Constructors
Modifier	Constructor and Description
`protected`	`BlockingActivity(String activityName)` Constructor for BlockingActivity.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static BlockingActivity`	`adapt(String activityName, HjRunnable runnable)` adapt.
`BlockingFinishState`	`currentFinishState()` currentFinishState.
`abstract void`	`executeBody()` This method represents the body of the task.
`BlockingActivity`	`finalizeActivitySpawn(BlockingActivity childActivity)` finalizeActivitySpawn.
`void`	`finalizeTermination()` finalizeTermination.
`void`	`finalizeTermination(Throwable throwable)` finalizeTermination.
`protected void`	`finalizeTerminationCleanup()` finalizeTerminationCleanup.
`protected void`	`handleException(Throwable throwable)`
`void`	`join()` The method is marked as synchronized as it invokes the wait() method.
`protected BlockingFinishState`	`newFinishState()` A factory method for a finish state.
`protected void`	`notifyActivitySpawn(BlockingActivity childActivity)` notifyActivitySpawn.
`protected void`	`notifyResumption()` notifyResumption.
`protected void`	`notifySuspension()` notifySuspension.
`void`	`prepareToRunInFinish()` prepareToRunInFinish.
`void`	`pushException(Throwable throwable)` pushException.
`void`	`registerListener(ActivityListeners.ActivityListener activityListener)` registerListener.
`void`	`run()` This is the method (indirectly) executed when the task is run by the executor service.
`void`	`setRootActivityFinishState(BlockingFinishState root)` Used by a parent activity on its child activity to update the finish state
`BlockingFinishState`	`startFinish()` This method is invoked when a new finish scope is encountered.
`void`	`stopFinish()` This method is invoked when a finish scope is being exited.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rootFinishState
```
protected BlockingFinishState rootFinishState
```
    TODO The FinishState up in the invocation tree within which this activity is being executed.
  - launchedFinishState
```
protected BlockingFinishState launchedFinishState
```
    TODO The FinishState of this activity. != null if this activity has started a finish.
  - executionException
```
protected RuntimeException executionException
```
    Exception that occurred while executing the activity
- Constructor Detail
  - BlockingActivity
```
protected BlockingActivity(String activityName)
```
    Constructor for BlockingActivity.
    
    Parameters:
    
    activityName - The name of the activity
- Method Detail
  - adapt
```
public static BlockingActivity adapt(String activityName,
                                     HjRunnable runnable)
```
    adapt.
    
    Parameters:
    
    activityName - The name of the activity.
    
    runnable - the runnable action.
    
    Returns:
    
    a new BlockingActivity that performs the run method of the given Runnable as its action
  - currentFinishState
```
public final BlockingFinishState currentFinishState()
```
    currentFinishState.
    
    Returns:
    
    the current FinishState being run by the activity.
  - registerListener
```
public final void registerListener(ActivityListeners.ActivityListener activityListener)
```
    registerListener.
    
    Parameters:
    
    activityListener - The listener to register
  - executeBody
```
public abstract void executeBody()
```
    This method represents the body of the task. Child classes need to implement this method to allow snippets of code to run potentially in parallel.
  - run
```
public final void run()
```
    This is the method (indirectly) executed when the task is run by the executor service.
    
    Specified by:
    
    run in interface Runnable
    
    See Also:
    
    Runnable.run()
  - handleException
```
protected void handleException(Throwable throwable)
```
  - prepareToRunInFinish
```
public final void prepareToRunInFinish()
```
    prepareToRunInFinish.
  - finalizeActivitySpawn
```
public BlockingActivity finalizeActivitySpawn(BlockingActivity childActivity)
```
    finalizeActivitySpawn.
    
    Parameters:
    
    childActivity - The child activity being spawned
    
    Returns:
    
    a BlockingActivity object.
  - finalizeTermination
```
public void finalizeTermination()
```
    finalizeTermination.
  - finalizeTermination
```
public void finalizeTermination(Throwable throwable)
```
    finalizeTermination.
    
    Parameters:
    
    throwable - The exception thrown while executing the body of the activity.
  - finalizeTerminationCleanup
```
protected void finalizeTerminationCleanup()
```
    finalizeTerminationCleanup.
  - pushException
```
public final void pushException(Throwable throwable)
```
    pushException.
    
    Parameters:
    
    throwable - The exception that occurred while executing this activity
  - notifyActivitySpawn
```
protected void notifyActivitySpawn(BlockingActivity childActivity)
```
    notifyActivitySpawn.
    
    Parameters:
    
    childActivity - a BlockingActivity object.
  - notifySuspension
```
protected void notifySuspension()
```
    notifySuspension.
  - notifyResumption
```
protected void notifyResumption()
```
    notifyResumption.
  - newFinishState
```
protected final BlockingFinishState newFinishState()
```
    A factory method for a finish state.
    
    Returns:
    
    A new finish state.
  - setRootActivityFinishState
```
public final void setRootActivityFinishState(BlockingFinishState root)
```
    Used by a parent activity on its child activity to update the finish state
    
    Parameters:
    
    root - The root finish state of the activity
  - startFinish
```
public final BlockingFinishState startFinish()
```
    This method is invoked when a new finish scope is encountered.
    
    Returns:
    
    a BlockingFinishState object.
  - stopFinish
```
public final void stopFinish()
```
    This method is invoked when a finish scope is being exited.
  - join
```
public final void join()
                throws InterruptedException
```
    The method is marked as synchronized as it invokes the wait() method.
    
    Throws:
    
    InterruptedException - if any thread interrupted the current thread before or while the current thread was waiting for a notification.

Class BlockingActivity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rootFinishState

launchedFinishState

executionException

Constructor Detail

BlockingActivity

Method Detail

adapt

currentFinishState

registerListener

executeBody

run

handleException

prepareToRunInFinish

finalizeActivitySpawn

finalizeTermination

finalizeTermination

finalizeTerminationCleanup

pushException

notifyActivitySpawn

notifySuspension

notifyResumption

newFinishState

setRootActivityFinishState

startFinish

stopFinish

join