com.amazon.carbonado.util

Class TaskQueueThread

java.lang.Object

java.lang.Thread

com.amazon.carbonado.util.TaskQueueThread

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Executor

public class TaskQueueThread
extends java.lang.Thread
implements java.util.concurrent.Executor

Simple generic queue for running tasks from a single thread. Be sure to call shutdown or interrupt when done using the thread, or else it will never exit.

Author:

Brian S O'Neill

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TaskQueueThread(java.lang.String name, int queueSize)
TaskQueueThread(java.lang.String name, int queueSize, long timeoutMillis)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(java.lang.Runnable task) Enqueue a task to run.
void	execute(java.lang.Runnable task, long timeoutMillis) Enqueue a task to run.
void	run()
void	shutdown() Indicate that this task queue thread should finish running its enqueued tasks and then exit.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskQueueThread

public TaskQueueThread(java.lang.String name,
               int queueSize)

Parameters:

name - name to give this thread

queueSize - fixed size of queue

TaskQueueThread

public TaskQueueThread(java.lang.String name,
               int queueSize,
               long timeoutMillis)

Parameters:

name - name to give this thread

queueSize - fixed size of queue

timeoutMillis - default maximum time to wait for queue to have an available slot

Method Detail

execute

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

Enqueue a task to run.

Specified by:

execute in interface java.util.concurrent.Executor

Parameters:

task - task to enqueue

Throws:

java.util.concurrent.RejectedExecutionException - if wait interrupted, timeout expires, or shutdown has been called

execute

public void execute(java.lang.Runnable task,
           long timeoutMillis)
             throws java.util.concurrent.RejectedExecutionException

Enqueue a task to run.

Parameters:

task - task to enqueue

timeoutMillis - maximum time to wait for queue to have an available slot

Throws:

java.util.concurrent.RejectedExecutionException - if wait interrupted, timeout expires, or shutdown has been called

shutdown

public void shutdown()

Indicate that this task queue thread should finish running its enqueued tasks and then exit. Enqueueing new tasks will result in a RejectedExecutionException being thrown. Join on this thread to wait for it to exit.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread