org.jboss.threads

Class OrderedExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

org.jboss.threads.OrderedExecutor

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService, BlockingExecutor, BlockingExecutorService

public final class OrderedExecutor
extends java.util.concurrent.AbstractExecutorService
implements BlockingExecutorService

An executor that always runs all tasks in queue order, using a delegate executor to run the tasks.

More specifically, if a FIFO queue type is used, any call B to the execute(Runnable) method that happens-after another call A to the same method, will result in B's task running after A's.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OrderedExecutor.Runner

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	blocking
private java.util.concurrent.Executor	handoffExecutor
private java.util.concurrent.locks.Lock	lock
private java.util.concurrent.Executor	parent
private java.util.Queue<java.lang.Runnable>	queue
private java.util.concurrent.locks.Condition	removeCondition
private java.lang.Runnable	runner
private boolean	running

Constructor Summary

Constructors

Constructor and Description
OrderedExecutor(java.util.concurrent.Executor parent) Construct a new instance using an unbounded FIFO queue.
OrderedExecutor(java.util.concurrent.Executor parent, int queueLength) Construct a new instance using a bounded FIFO queue of the given size and a blocking reject policy.
OrderedExecutor(java.util.concurrent.Executor parent, int queueLength, boolean blocking, java.util.concurrent.Executor handoffExecutor) Construct a new instance using a bounded FIFO queue of the given size and a handoff reject policy.
OrderedExecutor(java.util.concurrent.Executor parent, int queueLength, java.util.concurrent.Executor handoffExecutor) Construct a new instance using a bounded FIFO queue of the given size and a handoff reject policy.
OrderedExecutor(java.util.concurrent.Executor parent, java.util.Queue<java.lang.Runnable> queue) Construct a new instance using the given queue and a blocking reject policy.
OrderedExecutor(java.util.concurrent.Executor parent, java.util.Queue<java.lang.Runnable> queue, boolean blocking, java.util.concurrent.Executor handoffExecutor) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
void	execute(java.lang.Runnable task) Run a task.
void	executeBlocking(java.lang.Runnable task) Execute a task, blocking until it can be accepted, or until the calling thread is interrupted.
void	executeBlocking(java.lang.Runnable task, long timeout, java.util.concurrent.TimeUnit unit) Execute a task, blocking until it can be accepted, a timeout elapses, or the calling thread is interrupted.
void	executeNonBlocking(java.lang.Runnable task) Execute a task, without blocking.
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit

Field Detail

parent

private final java.util.concurrent.Executor parent

runner

private final java.lang.Runnable runner

lock

private final java.util.concurrent.locks.Lock lock

removeCondition

private final java.util.concurrent.locks.Condition removeCondition

queue

private final java.util.Queue<java.lang.Runnable> queue

running

private boolean running

blocking

private boolean blocking

handoffExecutor

private java.util.concurrent.Executor handoffExecutor

Constructor Detail

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent)

Construct a new instance using an unbounded FIFO queue. Since the queue is unbounded, tasks are never rejected.

Parameters:

parent - the parent to delegate tasks to

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent,
                       java.util.Queue<java.lang.Runnable> queue)

Construct a new instance using the given queue and a blocking reject policy.

Parameters:

parent - the parent to delegate tasks to

queue - the queue to use to hold tasks

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent,
                       int queueLength)

Construct a new instance using a bounded FIFO queue of the given size and a blocking reject policy.

Parameters:

parent - the parent to delegate tasks to

queueLength - the fixed length of the queue to use to hold tasks

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent,
                       int queueLength,
                       java.util.concurrent.Executor handoffExecutor)

Construct a new instance using a bounded FIFO queue of the given size and a handoff reject policy.

Parameters:

parent - the parent executor

queueLength - the fixed length of the queue to use to hold tasks

handoffExecutor - the executor to hand tasks to if the queue is full

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent,
                       java.util.Queue<java.lang.Runnable> queue,
                       boolean blocking,
                       java.util.concurrent.Executor handoffExecutor)

Construct a new instance.

Parameters:

parent - the parent executor

queue - the task queue to use

blocking - true if rejected tasks should block, false if rejected tasks should be handed off

handoffExecutor - the executor to hand tasks to if the queue is full

OrderedExecutor

public OrderedExecutor(java.util.concurrent.Executor parent,
                       int queueLength,
                       boolean blocking,
                       java.util.concurrent.Executor handoffExecutor)

Construct a new instance using a bounded FIFO queue of the given size and a handoff reject policy.

Parameters:

parent - the parent executor

queueLength - the fixed length of the queue to use to hold tasks

blocking - true if rejected tasks should block, false if rejected tasks should be handed off

handoffExecutor - the executor to hand tasks to if the queue is full

Method Detail

execute

public void execute(java.lang.Runnable task)

Run a task.

Specified by:

execute in interface java.util.concurrent.Executor

Specified by:

execute in interface BlockingExecutor

Parameters:

task - the task to run.

executeBlocking

public void executeBlocking(java.lang.Runnable task)
                     throws java.util.concurrent.RejectedExecutionException,
                            java.lang.InterruptedException

Description copied from interface: BlockingExecutor

Execute a task, blocking until it can be accepted, or until the calling thread is interrupted.

Specified by:

executeBlocking in interface BlockingExecutor

Parameters:

task - the task to submit

Throws:

StoppedExecutorException - if the executor was shut down before the task was accepted

ThreadCreationException - if a thread could not be created for some reason

java.util.concurrent.RejectedExecutionException - if execution is rejected for some other reason

java.lang.InterruptedException - if the current thread was interrupted before the task could be accepted

executeBlocking

public void executeBlocking(java.lang.Runnable task,
                            long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.util.concurrent.RejectedExecutionException,
                            java.lang.InterruptedException

Description copied from interface: BlockingExecutor

Execute a task, blocking until it can be accepted, a timeout elapses, or the calling thread is interrupted.

Specified by:

executeBlocking in interface BlockingExecutor

Parameters:

task - the task to submit

timeout - the amount of time to wait

unit - the unit of time

Throws:

ExecutionTimedOutException - if the timeout elapsed before a task could be accepted

StoppedExecutorException - if the executor was shut down before the task was accepted

ThreadCreationException - if a thread could not be created for some reason

java.util.concurrent.RejectedExecutionException - if execution is rejected for some other reason

java.lang.InterruptedException - if the current thread was interrupted before the task could be accepted

executeNonBlocking

public void executeNonBlocking(java.lang.Runnable task)
                        throws java.util.concurrent.RejectedExecutionException

Description copied from interface: BlockingExecutor

Execute a task, without blocking.

Specified by:

executeNonBlocking in interface BlockingExecutor

Parameters:

task - the task to submit

Throws:

StoppedExecutorException - if the executor was shut down before the task was accepted

ThreadCreationException - if a thread could not be created for some reason

java.util.concurrent.RejectedExecutionException - if execution is rejected for some other reason

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface java.util.concurrent.ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface java.util.concurrent.ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException

Specified by:

awaitTermination in interface java.util.concurrent.ExecutorService

Throws:

java.lang.InterruptedException

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService