com.github.wuic.util

Class WuicScheduledThreadPool

java.lang.Object

java.lang.Thread

com.github.wuic.util.WuicScheduledThreadPool

All Implemented Interfaces:

Runnable

public final class WuicScheduledThreadPool
extends Thread

This class is used internally by WUIC to control the number of created threads for different tasks. When a peace of code needs to create asynchronous task in WUIC, it always uses this singleton which wraps a thread pool. The class is tread safe and don't need to be called with a mutex.

The singleton adds a hook with Runtime.addShutdownHook(Thread) to shutdown the pool when executed.

Since:

0.4.0

Version:

1.2

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WuicScheduledThreadPool.CallExceptionLogger<T> Logs any exception which occurs when running a delegated Callable.

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	POOL_SIZE We just create 1 thread per processor.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Method Summary

Methods

Modifier and Type	Method and Description
<T> Future<T>	executeAsap(Callable<T> job) Executes as soon as possible the given job and returns the related Future.
Future<?>	executeAsap(Runnable job) Executes as soon as possible the given job and returns the related Future.
ScheduledFuture<?>	executeEveryTimeInSeconds(Runnable job, int delay) Schedules an execution in a specified delay of a given job.
static WuicScheduledThreadPool	getInstance() Gets the unique instance.
void	run()
void	shutdown() Stops the pool.

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

Field Detail

POOL_SIZE

public static final int POOL_SIZE

We just create 1 thread per processor.

Method Detail

getInstance

public static WuicScheduledThreadPool getInstance()

Gets the unique instance.

Returns:

the unique instance

executeEveryTimeInSeconds

public ScheduledFuture<?> executeEveryTimeInSeconds(Runnable job,
                                           int delay)

Schedules an execution in a specified delay of a given job. Once the job is executed, its execution will be repeated in the initial delay, and so on.

Parameters:

job - the job to execute

delay - the delay between executions

Returns:

an object which gives control over scheduled executions

executeAsap

public <T> Future<T> executeAsap(Callable<T> job)

Executes as soon as possible the given job and returns the related Future.

Parameters:

job - the job to execute

Returns:

the future result

executeAsap

public Future<?> executeAsap(Runnable job)

Executes as soon as possible the given job and returns the related Future.

Parameters:

job - the job to execute

Returns:

the future result

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

shutdown

public void shutdown()

Stops the pool.