Package org.eclipse.jetty.util.thread.strategy

Class EatWhatYouKill

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.util.thread.strategy.EatWhatYouKill

All Implemented Interfaces:

java.lang.Runnable, Container, Destroyable, Dumpable, LifeCycle, ExecutionStrategy

@ManagedObject("eat what you kill execution strategy")
public class EatWhatYouKill
extends ContainerLifeCycle
implements ExecutionStrategy, java.lang.Runnable

A strategy where the thread that produces will run the resulting task if it is possible to do so without thread starvation.

This strategy preemptively dispatches a thread as a pending producer, so that when a thread produces a task it can immediately run the task and let the pending producer thread take over production. When operating in this way, the sub-strategy is called Execute Produce Consume (EPC).

However, if the task produced uses the Invocable API to indicate that it will not block, then the strategy will run it directly, regardless of the presence of a pending producer thread and then resume production after the task has completed. When operating in this pattern, the sub-strategy is called ProduceConsume (PC).

If there is no pending producer thread available and if the task has not indicated it is non-blocking, then this strategy will dispatch the execution of the task and immediately continue production. When operating in this pattern, the sub-strategy is called ProduceExecuteConsume (PEC).

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.ExecutionStrategy

ExecutionStrategy.Producer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
EatWhatYouKill(ExecutionStrategy.Producer producer, java.util.concurrent.Executor executor)

Method Summary

Modifier and Type	Method	Description
void	dispatch()	Initiates (or resumes) the task production and consumption.
long	getEPCTasksConsumed()
long	getPCTasksConsumed()
long	getPECTasksExecuted()
long	getPICTasksExecuted()
boolean	isIdle()
void	produce()	Initiates (or resumes) the task production and consumption.
void	reset()
void	run()
java.lang.String	toString()
java.lang.String	toStringLocked()

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

EatWhatYouKill

public EatWhatYouKill(ExecutionStrategy.Producer producer,
                      java.util.concurrent.Executor executor)

Method Detail

dispatch

public void dispatch()

Description copied from interface: ExecutionStrategy

Initiates (or resumes) the task production and consumption.

This method guarantees that the task is never run by the thread that called this method.

TODO review the need for this (only used by HTTP2 push)

Specified by:

dispatch in interface ExecutionStrategy

See Also:

ExecutionStrategy.produce()

run

public void run()

Specified by:

run in interface java.lang.Runnable

produce

public void produce()

Description copied from interface: ExecutionStrategy

Initiates (or resumes) the task production and consumption.

The produced task may be run by the same thread that called this method.

Specified by:

produce in interface ExecutionStrategy

See Also:

ExecutionStrategy.dispatch()

getPCTasksConsumed

@ManagedAttribute(value="number of tasks consumed with PC mode",
                  readonly=true)
public long getPCTasksConsumed()

getPICTasksExecuted

@ManagedAttribute(value="number of tasks executed with PIC mode",
                  readonly=true)
public long getPICTasksExecuted()

getPECTasksExecuted

@ManagedAttribute(value="number of tasks executed with PEC mode",
                  readonly=true)
public long getPECTasksExecuted()

getEPCTasksConsumed

@ManagedAttribute(value="number of tasks consumed with EPC mode",
                  readonly=true)
public long getEPCTasksConsumed()

isIdle

@ManagedAttribute(value="whether this execution strategy is idle",
                  readonly=true)
public boolean isIdle()

reset

@ManagedOperation(value="resets the task counts",
                  impact="ACTION")
public void reset()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringLocked

public java.lang.String toStringLocked()