io.engineblock.core

Class ActivityExecutor

java.lang.Object

io.engineblock.core.ActivityExecutor

All Implemented Interfaces:

ProgressMeter, ParameterMap.Listener

public class ActivityExecutor
extends Object
implements ParameterMap.Listener, ProgressMeter

An ActivityExecutor is a named instance of an execution harness for a single activity instance. It is responsible for managing threads and activity settings which may be changed while the activity is running.

An ActivityExecutor may be represent an activity that is defined and active in the running scenario, but which is inactive. This can occur when an activity is paused by controlling logic, or when the threads are set to zero.

Invariants:

• Motors may not receive parameter updates before their owning activities are initialized.

Constructor Summary

Constructors

Constructor and Description
ActivityExecutor(Activity activity)

Method Summary

Modifier and Type	Method and Description
boolean	awaitCompletion(int waitTime)
boolean	awaitFinish(int timeout)
void	forceStopExecutor(int initialMillisToWait) Shutdown the activity executor, with a grace period for the motor threads.
Activity	getActivity()
ActivityDef	getActivityDef()
double	getProgress()
String	getProgressName()
RunState	getProgressState()
void	handleParameterMapUpdate(ParameterMap parameterMap) Listens for changes to parameter maps, maps them to the activity instance, and notifies all eligible listeners of changes.
boolean	isRunning()
void	notifyException(Thread t, Throwable e)
boolean	requestStopExecutor(int secondsToWait)
void	startActivity() True-up the number of motor instances known to the executor.
void	stopActivity() Simply stop the motors
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityExecutor

public ActivityExecutor(Activity activity)

Method Detail

startActivity

public void startActivity()

True-up the number of motor instances known to the executor. Start all non-running motors. The protocol between the motors and the executor should be safe as long as each state change is owned by either the motor logic or the activity executor but not both, and strictly serialized as well. This is enforced by forcing start(...) to be serialized as well as using CAS on the motor states.

The startActivity method may be called to true-up the number of active motors in an activity executor after changes to threads.

stopActivity

public void stopActivity()

Simply stop the motors

forceStopExecutor

public void forceStopExecutor(int initialMillisToWait)

Shutdown the activity executor, with a grace period for the motor threads.

Parameters:

initialMillisToWait - milliseconds to wait after graceful shutdownActivity request, before forcing everything to stop

requestStopExecutor

public boolean requestStopExecutor(int secondsToWait)

handleParameterMapUpdate

public void handleParameterMapUpdate(ParameterMap parameterMap)

Listens for changes to parameter maps, maps them to the activity instance, and notifies all eligible listeners of changes.

Specified by:

handleParameterMapUpdate in interface ParameterMap.Listener

getActivityDef

public ActivityDef getActivityDef()

awaitCompletion

public boolean awaitCompletion(int waitTime)

awaitFinish

public boolean awaitFinish(int timeout)

toString

public String toString()

Overrides:

toString in class Object

isRunning

public boolean isRunning()

getActivity

public Activity getActivity()

getProgress

public double getProgress()

Specified by:

getProgress in interface ProgressMeter

getProgressName

public String getProgressName()

Specified by:

getProgressName in interface ProgressMeter

getProgressState

public RunState getProgressState()

Specified by:

getProgressState in interface ProgressMeter

notifyException

public void notifyException(Thread t,
                            Throwable e)