Package org.kquiet.concurrent

Class PausableThreadPoolExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

org.kquiet.concurrent.PausableThreadPoolExecutor

All Implemented Interfaces:

Executor, ExecutorService

Direct Known Subclasses:

PausablePriorityThreadPoolExecutor

public class PausableThreadPoolExecutor
extends ThreadPoolExecutor

Pausable ThreadPoolExecutor. This class is for internal use.

Author:

Kimberly

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Constructor Summary

Constructors

Constructor	Description
PausableThreadPoolExecutor()	Create a PausableThreadPoolExecutor with core/maximum pool size set to one.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize)	Create a PausableThreadPoolExecutor with specified parameters.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize, int queueSize)	Create a PausableThreadPoolExecutor with specified parameters.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize, int queueSize, long keepAliveTime, TimeUnit unit, Consumer<Runnable> afterExecuteFunc)	Create a PausableThreadPoolExecutor with specified parameters.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize, int queueSize, Consumer<Runnable> afterExecuteFunc)	Create a PausableThreadPoolExecutor with specified parameters.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory, Consumer<Runnable> afterExecuteFunc)	Create a PausableThreadPoolExecutor with specified parameters.
PausableThreadPoolExecutor(String poolPrefix, int corePoolSize, int maximumPoolSize, Consumer<Runnable> afterExecuteFunc)	Create a PausableThreadPoolExecutor with specified parameters.

Method Summary

Modifier and Type	Method	Description
protected void	afterExecute(Runnable r, Throwable t)
protected void	beforeExecute(Thread t, Runnable r)
boolean	isPaused()	Check if this PausableThreadPoolExecutor is paused.
void	pause()	Pause the execution of this PausableThreadPoolExecutor.
void	resume()	Resume the execution of this PausableThreadPoolExecutor.

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, execute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow, terminated, toString

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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PausableThreadPoolExecutor

public PausableThreadPoolExecutor()

Create a PausableThreadPoolExecutor with core/maximum pool size set to one.

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize,
 int queueSize)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

queueSize - the maximum queue size used for holding tasks before they are executed

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize,
 Consumer<Runnable> afterExecuteFunc)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

afterExecuteFunc - the function to execute after any task is executed

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize,
 int queueSize,
 Consumer<Runnable> afterExecuteFunc)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

queueSize - the maximum queue size used for holding tasks before they are executed

afterExecuteFunc - the function to execute after any task is executed

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize,
 int queueSize,
 long keepAliveTime,
 TimeUnit unit,
 Consumer<Runnable> afterExecuteFunc)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

queueSize - the maximum queue size used for holding tasks before they are executed

keepAliveTime - when the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.

unit - the time unit for the keepAliveTime argument

afterExecuteFunc - the function to execute after any task is executed

PausableThreadPoolExecutor

public PausableThreadPoolExecutor(String poolPrefix,
 int corePoolSize,
 int maximumPoolSize,
 long keepAliveTime,
 TimeUnit unit,
 BlockingQueue<Runnable> workQueue,
 ThreadFactory threadFactory,
 Consumer<Runnable> afterExecuteFunc)

Create a PausableThreadPoolExecutor with specified parameters.

Parameters:

poolPrefix - prefix name of thread pool

corePoolSize - core pool size

maximumPoolSize - maximum pool size

keepAliveTime - when the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating.

unit - the time unit for the keepAliveTime argument

workQueue - the queue used for holding tasks before they are executed

threadFactory - the factory to use when the executor creates a new thread

afterExecuteFunc - the function to execute after any task is executed

Method Details

beforeExecute

protected void beforeExecute(Thread t,
 Runnable r)

Overrides:

beforeExecute in class ThreadPoolExecutor

afterExecute

protected void afterExecute(Runnable r,
 Throwable t)

Overrides:

afterExecute in class ThreadPoolExecutor

pause

public void pause()

Pause the execution of this PausableThreadPoolExecutor. Any executing task is not affected.

resume

public void resume()

Resume the execution of this PausableThreadPoolExecutor.

isPaused

public boolean isPaused()

Check if this PausableThreadPoolExecutor is paused.

Returns:

whether this PausableThreadPoolExecutor is paused.