Grizzly NIO 5.0.2 · org.glassfish.grizzly.threadpool.AbstractThreadPool

Modifier and Type	Class and Description
public abstract class	AbstractThreadPool.Worker

Modifier and Type	Field and Description
protected final ThreadPoolConfig	config
public static final int	DEFAULT_IDLE_THREAD_KEEPALIVE_TIMEOUT
public static final int	DEFAULT_MAX_TASKS_QUEUED
public static final int	DEFAULT_MAX_THREAD_COUNT
public static final int	DEFAULT_MIN_THREAD_COUNT
protected final DelayedExecutor.DelayQueue<AbstractThreadPool.Worker>	delayedQueue
private static final Logger	logger
protected final DefaultMonitoringConfig<ThreadPoolProbe>	monitoringConfig ThreadPool probes
private static final Long	NEVER_TIMEOUT
protected static final Runnable	poison
protected volatile boolean	running
protected final Object	stateLock
private static final DelayedExecutor.Resolver<AbstractThreadPool.Worker>	transactionResolver
protected final long	transactionTimeoutMillis
protected final Map<AbstractThreadPool.Worker, Long>	workers

Access	Constructor and Description
public	AbstractThreadPool(ThreadPoolConfig config)

Method Summary

Modifier and Type	Method and Description
protected void	afterExecute(final AbstractThreadPool.Worker the `Worker`, running the the thread t worker, final Thread thread, final Runnable the runnable that has completed. r, final Throwable the exception that caused termination, or null if execution completed normally. t) Method invoked upon completion of execution of the given Runnable.
public boolean	awaitTermination(final long timeout, final TimeUnit unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
protected void	beforeExecute(final AbstractThreadPool.Worker the `Worker`, running the the thread t worker, final Thread the thread that will run task r. t, final Runnable the task that will be executed. r) Method invoked prior to executing the given Runnable in the given thread.
pack-priv Object	createJmxManagementObject()
protected static void	drain(Queue<Runnable> from, Collection<Runnable> to)
public ThreadPoolConfig	getConfig() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getConfig. Returns: the thread pool configuration
protected final ThreadFactory	getDefaultThreadFactory()
public DefaultMonitoringConfig<ThreadPoolProbe>	getMonitoringConfig() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getMonitoringConfig, org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Return the object associated `MonitoringConfig`.
public Queue<Runnable>	getQueue() Returns: the task `Queue`
public int	getQueueSize() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getQueueSize.
public final int	getSize() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getSize. Returns: the number of allocated threads in the thread pool
public boolean	isShutdown() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.isShutdown, java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
protected void	onMaxNumberOfThreadsReached() Method is called by `AbstractThreadPool`, when maximum number of worker threads is reached and task will need to wait in task queue, until one of the threads will be able to process it.
protected void	onTaskCancelled(Runnable task) Method is called by a thread pool each time a dequeued task has been canceled instead of being processed.
protected void	onTaskCompletedEvent(Runnable the unit of work that has completed processing task) This method will be invoked when a the specified `Runnable` has completed execution.
protected void	onTaskDequeued(Runnable task) Method is called by a thread pool each time a task has been dequeued from a task queue.
protected void	onTaskQueued(Runnable task) Method is called by a thread pool each time new task has been queued to a task queue.
protected void	onTaskQueueOverflow() Method is called by a thread pool, when new task could not be added to a task queue, because task queue is full.
protected void	onWorkerExit(AbstractThreadPool.Worker worker) Method is called by `Worker`, when it's completing `Worker#run()` method execution, which in most cases means, that ThreadPool's thread will be released.
protected void	onWorkerStarted(final AbstractThreadPool.Worker worker) Method is called by `Worker`, when it's starting `Worker#run()` method execution, which means, that ThreadPool's thread is getting active and ready to process tasks.
protected void	poisonAll()
public void	shutdown() Implements java.util.concurrent.ExecutorService.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public List<Runnable>	shutdownNow() Implements java.util.concurrent.ExecutorService.shutdownNow. Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.
protected void	startWorker(final AbstractThreadPool.Worker worker) must hold statelock while calling this method.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	uncaughtException(Thread thread, Throwable throwable) Implements java.lang.Thread.UncaughtExceptionHandler.uncaughtException. Method invoked when the given thread terminates due to the given uncaught exception.
protected void	validateNewPoolSize(int corePoolsize, int maxPoolSize)

Inherited from java.util.concurrent.AbstractExecutorService:: invokeAll invokeAll invokeAny invokeAny newTaskFor newTaskFor submit submit submit

config	back to summary
protected final ThreadPoolConfig config

DEFAULT_IDLE_THREAD_KEEPALIVE_TIMEOUT	back to summary
public static final int DEFAULT_IDLE_THREAD_KEEPALIVE_TIMEOUT

DEFAULT_MAX_TASKS_QUEUED	back to summary
public static final int DEFAULT_MAX_TASKS_QUEUED

DEFAULT_MAX_THREAD_COUNT	back to summary
public static final int DEFAULT_MAX_THREAD_COUNT

DEFAULT_MIN_THREAD_COUNT	back to summary
public static final int DEFAULT_MIN_THREAD_COUNT

delayedQueue	back to summary
protected final DelayedExecutor.DelayQueue<AbstractThreadPool.Worker> delayedQueue

logger	back to summary
private static final Logger logger

monitoringConfig	back to summary
protected final DefaultMonitoringConfig<ThreadPoolProbe> monitoringConfig ThreadPool probes

NEVER_TIMEOUT	back to summary
private static final Long NEVER_TIMEOUT

poison	back to summary
protected static final Runnable poison

running	back to summary
protected volatile boolean running

stateLock	back to summary
protected final Object stateLock

transactionResolver	back to summary
private static final DelayedExecutor.Resolver<AbstractThreadPool.Worker> transactionResolver

transactionTimeoutMillis	back to summary
protected final long transactionTimeoutMillis

workers	back to summary
protected final Map<AbstractThreadPool.Worker, Long> workers

AbstractThreadPool	back to summary
public AbstractThreadPool(ThreadPoolConfig config)

Method Detail

afterExecute back to summary

afterExecute	back to summary
protected void afterExecute(final AbstractThreadPool.Worker worker, final Thread thread, final Runnable r, final Throwable t) Method invoked upon completion of execution of the given Runnable. This method is invoked by the thread that executed the task. If non-null, the Throwable is the uncaught `RuntimeException` or `Error` that caused execution to terminate abruptly. Note When actions are enclosed in tasks (such as `java.util.concurrent.FutureTask`) either explicitly or via methods such as `submit`, these task objects catch and maintain computational exceptions, and so they do not cause abrupt termination, and the internal exceptions are not passed to this method. This implementation does nothing, but may be customized in subclasses. Note To properly nest multiple overridings, subclasses should generally invoke `super.afterExecute` at the beginning of this method. Parameters worker:AbstractThreadPool.Worker the `Worker`, running the the thread t r:Runnable the runnable that has completed. t:Throwable the exception that caused termination, or null if execution completed normally.

protected void afterExecute(final AbstractThreadPool.Worker worker, final Thread thread, final Runnable r, final Throwable t)

Method invoked upon completion of execution of the given Runnable. This method is invoked by the thread that executed the task. If non-null, the Throwable is the uncaught RuntimeException or Error that caused execution to terminate abruptly.

Note

When actions are enclosed in tasks (such as java.util.concurrent.FutureTask) either explicitly or via methods such as submit, these task objects catch and maintain computational exceptions, and so they do not cause abrupt termination, and the internal exceptions are not passed to this method.

This implementation does nothing, but may be customized in subclasses.

Note

To properly nest multiple overridings, subclasses should generally invoke super.afterExecute at the beginning of this method.

Parameters

worker:AbstractThreadPool.Worker: the Worker, running the the thread t
r:Runnable: the runnable that has completed.
t:Throwable: the exception that caused termination, or null if execution completed normally.

awaitTermination	back to summary
public boolean awaitTermination(final long timeout, final TimeUnit unit) throws InterruptedException Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Annotations @Override Exceptions InterruptedException: if interrupted while waiting

awaitTermination

back to summary

public boolean awaitTermination(final long timeout, final TimeUnit unit) throws InterruptedException

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Annotations

@Override

Exceptions

InterruptedException:: if interrupted while waiting

beforeExecute back to summary

beforeExecute	back to summary
protected void beforeExecute(final AbstractThreadPool.Worker worker, final Thread t, final Runnable r) Method invoked prior to executing the given Runnable in the given thread. This method is invoked by thread `t` that will execute task `r`, and may be used to re-initialize ThreadLocals, or to perform logging. This implementation does nothing, but may be customized in subclasses. Note To properly nest multiple overridings, subclasses should generally invoke `super.beforeExecute` at the end of this method. Parameters worker:AbstractThreadPool.Worker the `Worker`, running the the thread t t:Thread the thread that will run task r. r:Runnable the task that will be executed.

protected void beforeExecute(final AbstractThreadPool.Worker worker, final Thread t, final Runnable r)

Method invoked prior to executing the given Runnable in the given thread. This method is invoked by thread t that will execute task r, and may be used to re-initialize ThreadLocals, or to perform logging.

This implementation does nothing, but may be customized in subclasses.

Note

To properly nest multiple overridings, subclasses should generally invoke super.beforeExecute at the end of this method.

Parameters

worker:AbstractThreadPool.Worker: the Worker, running the the thread t
t:Thread: the thread that will run task r.
r:Runnable: the task that will be executed.

createJmxManagementObject	back to summary
pack-priv Object createJmxManagementObject()

drain	back to summary
protected static void drain(Queue<Runnable> from, Collection<Runnable> to)

getConfig	back to summary
public ThreadPoolConfig getConfig() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getConfig. Returns:ThreadPoolConfig the thread pool configuration

getConfig

back to summary

public ThreadPoolConfig getConfig()

Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getConfig.

Returns:ThreadPoolConfig: the thread pool configuration

getDefaultThreadFactory	back to summary
protected final ThreadFactory getDefaultThreadFactory()

getMonitoringConfig back to summary

getMonitoringConfig	back to summary
public DefaultMonitoringConfig<ThreadPoolProbe> getMonitoringConfig() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getMonitoringConfig, org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Doc from org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig. Return the object associated `MonitoringConfig`. Annotations @Override

public DefaultMonitoringConfig<ThreadPoolProbe> getMonitoringConfig()

Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getMonitoringConfig, org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig.

Doc from org.glassfish.grizzly.monitoring.MonitoringAware.getMonitoringConfig.

Return the object associated MonitoringConfig.

Annotations

@Override

getQueue	back to summary
public Queue<Runnable> getQueue() Returns:Queue<Runnable> the task `Queue`

getQueueSize	back to summary
public int getQueueSize() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getQueueSize. Annotations @Override

getQueueSize

back to summary

public int getQueueSize()

Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getQueueSize.

Annotations

@Override

getSize	back to summary
public final int getSize() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getSize. Returns:int the number of allocated threads in the thread pool

getSize

back to summary

public final int getSize()

Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.getSize.

Returns:int: the number of allocated threads in the thread pool

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.isShutdown, java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Annotations @Override

public boolean isShutdown()

Implements org.glassfish.grizzly.threadpool.ThreadPoolInfo.isShutdown, java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Annotations

@Override

onMaxNumberOfThreadsReached	back to summary
protected void onMaxNumberOfThreadsReached() Method is called by `AbstractThreadPool`, when maximum number of worker threads is reached and task will need to wait in task queue, until one of the threads will be able to process it.

onTaskCancelled	back to summary
protected void onTaskCancelled(Runnable task) Method is called by a thread pool each time a dequeued task has been canceled instead of being processed.

onTaskCompletedEvent back to summary

onTaskCompletedEvent	back to summary
protected void onTaskCompletedEvent(Runnable task) This method will be invoked when a the specified `Runnable` has completed execution. Parameters task:Runnable the unit of work that has completed processing

protected void onTaskCompletedEvent(Runnable task)

This method will be invoked when a the specified Runnable has completed execution.

Parameters

task:Runnable: the unit of work that has completed processing

onTaskDequeued	back to summary
protected void onTaskDequeued(Runnable task) Method is called by a thread pool each time a task has been dequeued from a task queue.

onTaskQueued	back to summary
protected void onTaskQueued(Runnable task) Method is called by a thread pool each time new task has been queued to a task queue.

onTaskQueueOverflow	back to summary
protected void onTaskQueueOverflow() Method is called by a thread pool, when new task could not be added to a task queue, because task queue is full. throws `RejectedExecutionException`

onWorkerExit	back to summary
protected void onWorkerExit(AbstractThreadPool.Worker worker) Method is called by `Worker`, when it's completing `Worker#run()` method execution, which in most cases means, that ThreadPool's thread will be released. This method is called from `Worker`'s thread.

onWorkerStarted	back to summary
protected void onWorkerStarted(final AbstractThreadPool.Worker worker) Method is called by `Worker`, when it's starting `Worker#run()` method execution, which means, that ThreadPool's thread is getting active and ready to process tasks. This method is called from `Worker`'s thread.

poisonAll	back to summary
protected void poisonAll()

shutdown back to summary

shutdown	back to summary
public void shutdown() Implements java.util.concurrent.ExecutorService.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that. Annotations @Override

public void shutdown()

Implements java.util.concurrent.ExecutorService.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Annotations

@Override

shutdownNow back to summary

shutdownNow	back to summary
public List<Runnable> shutdownNow() Implements java.util.concurrent.ExecutorService.shutdownNow. Doc from java.util.concurrent.ExecutorService.shutdownNow. Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. This method does not wait for actively executing tasks to terminate. Use `awaitTermination` to do that. There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via `Thread#interrupt`, so any task that fails to respond to interrupts may never terminate. Annotations @Override

public List<Runnable> shutdownNow()

Implements java.util.concurrent.ExecutorService.shutdownNow.

Doc from java.util.concurrent.ExecutorService.shutdownNow.

Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

This method does not wait for actively executing tasks to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via Thread#interrupt, so any task that fails to respond to interrupts may never terminate.

Annotations

@Override

startWorker	back to summary
protected void startWorker(final AbstractThreadPool.Worker worker) must hold statelock while calling this method.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uncaughtException	back to summary
public void uncaughtException(Thread thread, Throwable throwable) Implements java.lang.Thread.UncaughtExceptionHandler.uncaughtException. Doc from java.lang.Thread.UncaughtExceptionHandler.uncaughtException. Method invoked when the given thread terminates due to the given uncaught exception. Any exception thrown by this method will be ignored by the Java Virtual Machine. Annotations @Override

uncaughtException

back to summary

public void uncaughtException(Thread thread, Throwable throwable)

Implements java.lang.Thread.UncaughtExceptionHandler.uncaughtException.

Doc from java.lang.Thread.UncaughtExceptionHandler.uncaughtException.

Method invoked when the given thread terminates due to the given uncaught exception.

Any exception thrown by this method will be ignored by the Java Virtual Machine.

Annotations

@Override

validateNewPoolSize	back to summary
protected void validateNewPoolSize(int corePoolsize, int maxPoolSize)

Modifier and Type	Field and Description
protected Thread	t
protected volatile long	transactionExpirationTime

public abstract Class AbstractThreadPool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class AbstractThreadPool.Worker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
protected void	doWork()
protected abstract Runnable	getTask()
public void	run() Implements java.lang.Runnable.run. Runs this operation.