Package net.officefloor.web.executive

Class WebThreadAffinityExecutive

java.lang.Object

net.officefloor.web.executive.WebThreadAffinityExecutive

All Implemented Interfaces:

BackgroundScheduler, ExecutionStrategy, Executive, TeamOversight

public class WebThreadAffinityExecutive
extends Object
implements Executive, BackgroundScheduler, ExecutionStrategy, TeamOversight

Web Thread affinity Executive.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
WebThreadAffinityExecutive(CpuCore[] cpuCores, ExecutiveSourceContext context)	Instantiate.

Method Summary

Modifier and Type	Method	Description
Executor	createExecutor(ProcessIdentifier processIdentifier)	Creates an Executor that MUST execute the Runnable in a different Thread to the caller.
ProcessIdentifier	createProcessIdentifier(ExecutiveOfficeContext officeContext)	Creates a new ProcessIdentifier.
Team	createTeam(ExecutiveContext context)	Creates the Team.
ExecutionStrategy[]	getExcutionStrategies()	Obtains the ExecutionStrategy strategies.
String	getExecutionStrategyName()	Obtains the name of the ExecutionStrategy.
TeamOversight	getTeamOversight()	Obtains the TeamOversight.
ThreadFactory[]	getThreadFactories()	Obtains the ThreadFactory instances for the various Thread instances of this ExecutionStrategy.
<T extends Throwable> ProcessManager	manageExecution(Execution<T> execution)	Manages the Execution.
void	schedule(long delay, Runnable runnable)	Schedules the Runnable to be executed after the delay.
void	schedule(ProcessIdentifier processIdentifier, long delay, Runnable runnable)	Schedules the Runnable to execute so many milliseconds in the future.
void	startManaging(ExecutiveStartContext context)	Starts managing the OfficeFloor.
void	stopManaging()	Stops managing the OfficeFloor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.executive.Executive

createThread, getOfficeManager, processComplete

Constructor Details

WebThreadAffinityExecutive

public WebThreadAffinityExecutive(CpuCore[] cpuCores,
 ExecutiveSourceContext context)

Instantiate.

Parameters:

cpuCores - CpuCore instances.

context - ExecutiveSourceContext.

Method Details

getExcutionStrategies

public ExecutionStrategy[] getExcutionStrategies()

Description copied from interface: Executive

Obtains the ExecutionStrategy strategies.

Specified by:

getExcutionStrategies in interface Executive

Returns:

ExecutionStrategy instances.

getTeamOversight

public TeamOversight getTeamOversight()

Description copied from interface: Executive

Obtains the TeamOversight.

Specified by:

getTeamOversight in interface Executive

Returns:

TeamOversight.

startManaging

public void startManaging(ExecutiveStartContext context)
                   throws Exception

Description copied from interface: Executive

Starts managing the OfficeFloor.

Specified by:

startManaging in interface Executive

Parameters:

context - ExecutiveStartContext.

Throws:

Exception - If fails to start managing.

manageExecution

public <T extends Throwable> ProcessManager manageExecution(Execution<T> execution)
                                                     throws T

Description copied from interface: Executive

Manages the Execution.

The Thread.currentThread() will provide the inbound Thread.

Specified by:

manageExecution in interface Executive

Type Parameters:

T - Type of Throwable thrown.

Parameters:

execution - Execution to be undertaken.

Returns:

ProcessManager for the ProcessState.

Throws:

T - Propagation of failure from Execution.

createProcessIdentifier

public ProcessIdentifier createProcessIdentifier(ExecutiveOfficeContext officeContext)

Description copied from interface: Executive

Creates a new ProcessIdentifier.

Specified by:

createProcessIdentifier in interface Executive

Parameters:

officeContext - ExecutiveOfficeContext.

Returns:

New ProcessIdentifier.

createExecutor

public Executor createExecutor(ProcessIdentifier processIdentifier)

Description copied from interface: Executive

Creates an Executor that MUST execute the Runnable in a different Thread to the caller.

This is used in various places within OfficeFloor:

• By ManagedFunction in executing Runnable in another Thread
• To avoid stack over flow issues, the stack call chain is broken by invoking further FunctionState delegation in another Thread. This allows further depth to a thread stack than offered by a single Thread.

Specified by:

createExecutor in interface Executive

Parameters:

processIdentifier - ProcessIdentifier of ProcessState requiring the Executor.

Returns:

Executor that will execute Runnable instances in a different Thread to caller.

schedule

public void schedule(ProcessIdentifier processIdentifier,
 long delay,
 Runnable runnable)

Description copied from interface: Executive

Schedules the Runnable to execute so many milliseconds in the future.

Note that the Executive may determine the ProcessState complete and not execute the Runnable.

Specified by:

schedule in interface Executive

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState requiring the scheduled execution.

delay - Delay in milliseconds to execute the Runnable.

runnable - Runnable to execute.

stopManaging

public void stopManaging()
                  throws Exception

Description copied from interface: Executive

Stops managing the OfficeFloor.

Specified by:

stopManaging in interface Executive

Throws:

Exception - If fails to stop managing.

schedule

public void schedule(long delay,
 Runnable runnable)

Description copied from interface: BackgroundScheduler

Schedules the Runnable to be executed after the delay.

Specified by:

schedule in interface BackgroundScheduler

Parameters:

delay - Delay in milliseconds.

runnable - Runnable.

getExecutionStrategyName

public String getExecutionStrategyName()

Description copied from interface: ExecutionStrategy

Obtains the name of the ExecutionStrategy.

Specified by:

getExecutionStrategyName in interface ExecutionStrategy

Returns:

Name of the ExecutionStrategy.

getThreadFactories

public ThreadFactory[] getThreadFactories()

Description copied from interface: ExecutionStrategy

Obtains the ThreadFactory instances for the various Thread instances of this ExecutionStrategy.

Specified by:

getThreadFactories in interface ExecutionStrategy

Returns:

ThreadFactory instances.

createTeam

public Team createTeam(ExecutiveContext context)
                throws Exception

Description copied from interface: TeamOversight

Creates the Team.

This is expected to delegate to the TeamSource to create the Team. However, the Executive may decide to wrap the Team or provide multiple Team instances with assigning algorithm (such as taking advantage of Thread affinity). The choice is, however, ultimately left to the Executive to manage the Team instances.

Specified by:

createTeam in interface TeamOversight

Parameters:

context - ExecutiveContext.

Returns:

Team.

Throws:

Exception - If fails to configure the TeamSource.