jalse.actions

Class ForkJoinActionEngine

java.lang.Object

jalse.actions.AbstractActionEngine

jalse.actions.ForkJoinActionEngine

All Implemented Interfaces:

ActionEngine

public class ForkJoinActionEngine
extends AbstractActionEngine

An implementation of ActionEngine based on ForkJoinPool. Scheduling is achieved using ForkJoinPool.managedBlock(ManagedBlocker) so many threads may be used but not all executing Action.

ForkJoinActionEngine offers an instance backed on ForkJoinPool.commonPool() that cannot be stopped or paused (commonPoolEngine()).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ForkJoinActionEngine.ForkJoinContext<T> Fork join context.

Field Summary

Fields inherited from class jalse.actions.AbstractActionEngine

executorService, TERMINATION_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ForkJoinActionEngine() Creates a new ForkJoinActionEngine instance with the default parallelism.
ForkJoinActionEngine(int parallelism) Creates a new ForkJoinActionEngine with the supplied parallelism.

Method Summary

Modifier and Type	Method and Description
protected boolean	addWork(ForkJoinActionEngine.ForkJoinContext<?> context) Adds work to the engine.
protected void	addWorkerIfNeeded() Starts a worker if needed (waiting work and no free workers).
static ForkJoinActionEngine	commonPoolEngine() Gets the common ForkJoinActionEngine instance backed by ForkJoinPool.commonPool() (this cannot be paused or stopped).
protected ManualWorkQueue<ForkJoinActionEngine.ForkJoinContext<?>>	getWorkQueue() Gets the engine's work queue.
<T> ForkJoinActionEngine.ForkJoinContext<T>	newContext(Action<T> action) Creates an action context to define how the action will be scheduled for execution.
protected boolean	removeWork(ForkJoinActionEngine.ForkJoinContext<?> context) Removes work from the engine.
void	stop() Permanently stops the engine.

Methods inherited from class jalse.actions.AbstractActionEngine

awaitResumed, getBindings, isPaused, isStopped, pause, resume

Methods inherited from class java.lang.Object

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

Methods inherited from interface jalse.actions.ActionEngine

putInBindings, removeFromBindings, schedule, schedule

Constructor Detail

ForkJoinActionEngine

public ForkJoinActionEngine()

Creates a new ForkJoinActionEngine instance with the default parallelism.

See Also:

Runtime.availableProcessors()

ForkJoinActionEngine

public ForkJoinActionEngine(int parallelism)

Creates a new ForkJoinActionEngine with the supplied parallelism.

Parameters:

parallelism - The parallelism level.

Method Detail

commonPoolEngine

public static ForkJoinActionEngine commonPoolEngine()

Gets the common ForkJoinActionEngine instance backed by ForkJoinPool.commonPool() (this cannot be paused or stopped).

Returns:

Common engine instance.

addWork

protected boolean addWork(ForkJoinActionEngine.ForkJoinContext<?> context)

Adds work to the engine.

Parameters:

context - Work to add.

Returns:

Whether the work was not already in the queue.

See Also:

Actions.requireNotStopped(ActionEngine)

addWorkerIfNeeded

protected void addWorkerIfNeeded()

Starts a worker if needed (waiting work and no free workers).

getWorkQueue

protected ManualWorkQueue<ForkJoinActionEngine.ForkJoinContext<?>> getWorkQueue()

Gets the engine's work queue.

Returns:

Manual work queue.

newContext

public <T> ForkJoinActionEngine.ForkJoinContext<T> newContext(Action<T> action)

Description copied from interface: ActionEngine

Creates an action context to define how the action will be scheduled for execution.

Parameters:

action - Action to create context for.

Returns:

Context associated to the action.

removeWork

protected boolean removeWork(ForkJoinActionEngine.ForkJoinContext<?> context)

Removes work from the engine.

Parameters:

context - Work to remove.

Returns:

Whether the work was added before.

stop

public void stop()

Description copied from interface: ActionEngine

Permanently stops the engine. All work that has not yet been executed will be cancelled and all work currently executing will may be interrupted.

Specified by:

stop in interface ActionEngine

Overrides:

stop in class AbstractActionEngine