org.trianacode.taskgraph.service

Interface RunnableInstance

All Known Implementing Classes:

AbstractRunnableTask, AbstractServiceTask, NonRunnableTask, RunnableTask

public interface RunnableInstance

Communication interface between data monitors and runnable instances. The monitor sends a finished notification when it has finished outputting its data, allowing the runnable instance to continue with its execution (assuming sends are blocking). When data is received by the monitor the runnable instance is sent a wake-up call to allow it to start processing.

See Also:

LocalCable, Monitor

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecutionListener(ExecutionListener listener) Adds a execution state listener to this runnable instance
void	finished() Tell the data monitor that this thread monitor has completed outputting the data i.e.
ExecutionState	getExecutionState()
void	pause() Request a runnable instance to pause
void	removeExecutionListener(ExecutionListener listener) Removes a execution state listener from this runnable instance
void	reset() Order a runnable instance to stop and reset it to its pre-run state
void	resume() Request a runnable instance to resume (unpause)
void	wakeUp() Indicates to the runnable instance that a wake-up signal has been received from the scheduler.
void	wakeUp(Node node) Indicates to the runnable instance that a wake-up signal has been received from the specified node (e.g.

Method Detail

addExecutionListener

void addExecutionListener(ExecutionListener listener)

Adds a execution state listener to this runnable instance

removeExecutionListener

void removeExecutionListener(ExecutionListener listener)

Removes a execution state listener from this runnable instance

getExecutionState

ExecutionState getExecutionState()

Returns:

the current state of te runnable instance (e.g. runnable task)

wakeUp

void wakeUp()

Indicates to the runnable instance that a wake-up signal has been received from the scheduler. It is up to a task to respond to this wake-up, or to ignore it if wake-ups have not been received from all the nodes a task requires to execute.

wakeUp

void wakeUp(Node node)

Indicates to the runnable instance that a wake-up signal has been received from the specified node (e.g. data is available on that node). A runnable instance should only run when it has received wake-ups from all the nodes it requires to execute.

pause

void pause()

Request a runnable instance to pause

resume

void resume()

Request a runnable instance to resume (unpause)

reset

void reset()

Order a runnable instance to stop and reset it to its pre-run state

finished

void finished()

Tell the data monitor that this thread monitor has completed outputting the data i.e. the data has been received by the receiving process.