Package org.vrspace.server.core

Class PausableThreadPoolExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

org.vrspace.server.core.PausableThreadPoolExecutor

All Implemented Interfaces:

Executor, ExecutorService

public class PausableThreadPoolExecutor
extends ThreadPoolExecutor

A light wrapper around the ThreadPoolExecutor. It allows for you to pause execution and resume execution when ready. It is very handy for games that need to pause.

Author:

Matthew A. Johnston (warmwaffles)

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(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue)

Method Summary

Modifier and Type	Method	Description
protected void	beforeExecute(Thread thread, Runnable runnable)
boolean	isPaused()
boolean	isRunning()
static PausableThreadPoolExecutor	newSingleThreadExecutor()
void	pause()	Pause the execution
void	resume()	Resume pool execution

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

afterExecute, 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(int corePoolSize,
 int maximumPoolSize,
 long keepAliveTime,
 TimeUnit unit,
 BlockingQueue<Runnable> workQueue)

Parameters:

corePoolSize - The size of the pool

maximumPoolSize - The maximum size of the pool

keepAliveTime - The amount of time you wish to keep a single task alive

unit - The unit of time that the keep alive time represents

workQueue - The queue that holds your tasks

Method Details

newSingleThreadExecutor

public static PausableThreadPoolExecutor newSingleThreadExecutor()

beforeExecute

protected void beforeExecute(Thread thread,
 Runnable runnable)

Overrides:

beforeExecute in class ThreadPoolExecutor

Parameters:

thread - The thread being executed

runnable - The runnable task

isRunning

public boolean isRunning()

isPaused

public boolean isPaused()

pause

public void pause()

Pause the execution

resume

public void resume()

Resume pool execution