ScheduledThreadPoolExecutor
open class ScheduledThreadPoolExecutor : ThreadPoolExecutor, ScheduledExecutorService
A ThreadPoolExecutor that can additionally schedule commands to run after a given delay, or to execute periodically. This class is preferable to java.util.Timer when multiple worker threads are needed, or when the additional flexibility or capabilities of ThreadPoolExecutor (which this class extends) are required.
Delayed tasks execute no sooner than they are enabled, but without any real-time guarantees about when, after they are enabled, they will commence. Tasks scheduled for exactly the same execution time are enabled in first-in-first-out (FIFO) order of submission.
When a submitted task is cancelled before it is run, execution is suppressed. By default, such a cancelled task is not automatically removed from the work queue until its delay elapses. While this enables further inspection and monitoring, it may also cause unbounded retention of cancelled tasks.
Successive executions of a periodic task scheduled via scheduleAtFixedRate or scheduleWithFixedDelay do not overlap. While different executions may be performed by different threads, the effects of prior executions happen-before those of subsequent ones.
While this class inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect. Additionally, it is almost never a good idea to set corePoolSize to zero or use allowCoreThreadTimeOut because this may leave the pool without threads to handle tasks once they become eligible to run.
Extension notes: This class overrides the ThreadPoolExecutor#execute(Runnable) and AbstractExecutorService#submit(Runnable) methods to generate internal ScheduledFuture objects to control per-task delays and scheduling. To preserve functionality, any further overrides of these methods in subclasses must invoke superclass versions, which effectively disables additional task customization. However, this class provides alternative protected extension method decorateTask (one version each for Runnable and Callable) that can be used to customize the concrete task types used to execute commands entered via execute, submit, schedule, scheduleAtFixedRate, and scheduleWithFixedDelay. By default, a ScheduledThreadPoolExecutor uses a task type extending FutureTask. However, this may be modified or replaced using subclasses of the form:
<code>public class CustomScheduledExecutor extends ScheduledThreadPoolExecutor {
static class CustomTask<V> implements RunnableScheduledFuture<V> { ... }
protected <V> RunnableScheduledFuture<V> decorateTask(
Runnable r, RunnableScheduledFuture<V> task) {
return new CustomTask<V>(r, task);
}
protected <V> RunnableScheduledFuture<V> decorateTask(
Callable<V> c, RunnableScheduledFuture<V> task) {
return new CustomTask<V>(c, task);
}
// ... add constructors, etc.
}</code>
Summary
| Public constructors |
|
Creates a new ScheduledThreadPoolExecutor with the given core pool size.
|
|
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
|
|
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
|
|
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
|
| Public methods |
| open Unit |
Executes command with zero required delay.
|
| open Boolean |
Gets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown.
|
| open Boolean |
Gets the policy on whether to execute existing delayed tasks even when this executor has been shutdown.
|
| open BlockingQueue<Runnable!>! |
Returns the task queue used by this executor.
|
| open Boolean |
Gets the policy on whether cancelled tasks should be immediately removed from the work queue at time of cancellation.
|
| open ScheduledFuture<*>! |
|
| open ScheduledFuture<V>! |
|
| open ScheduledFuture<*>! |
|
| open ScheduledFuture<*>! |
|
| open Unit |
Sets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown.
|
| open Unit |
Sets the policy on whether to execute existing delayed tasks even when this executor has been shutdown.
|
| open Unit |
Sets the policy on whether cancelled tasks should be immediately removed from the work queue at time of cancellation.
|
| open Unit |
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
|
| open MutableList<Runnable!>! |
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.
|
| open Future<*>! |
|
| open Future<T>! |
|
| open Future<T>! |
|
| Inherited functions |
From class ThreadPoolExecutor
Unit |
afterExecute(r: Runnable!, t: Throwable!)
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.
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.
Note: When actions are enclosed in tasks (such as 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. If you would like to trap both kinds of failures in this method, you can further probe for such cases, as in this sample subclass that prints either the direct cause or the underlying exception if a task has been aborted:
<code>class ExtendedExecutor extends ThreadPoolExecutor {
// ...
protected void afterExecute(Runnable r, Throwable t) {
super.afterExecute(r, t);
if (t == null
&& r instanceof Future<?>
&& ((Future<?>)r).isDone()) {
try {
Object result = ((Future<?>) r).get();
} catch (CancellationException ce) {
t = ce;
} catch (ExecutionException ee) {
t = ee.getCause();
} catch (InterruptedException ie) {
// ignore/reset
Thread.currentThread().interrupt();
}
}
if (t != null)
System.out.println(t);
}
}</code>
|
Unit |
allowCoreThreadTimeOut(value: Boolean)
Sets the policy governing whether core threads may time out and terminate if no tasks arrive within the keep-alive time, being replaced if needed when new tasks arrive. When false, core threads are never terminated due to lack of incoming tasks. When true, the same keep-alive policy applying to non-core threads applies also to core threads. To avoid continual thread replacement, the keep-alive time must be greater than zero when setting true. This method should in general be called before the pool is actively used.
|
Boolean |
allowsCoreThreadTimeOut()
Returns true if this pool allows core threads to time out and terminate if no tasks arrive within the keepAlive time, being replaced if needed when new tasks arrive. When true, the same keep-alive policy applying to non-core threads applies also to core threads. When false (the default), core threads are never terminated due to lack of incoming tasks.
|
Boolean |
awaitTermination(timeout: Long, unit: TimeUnit!)
|
Unit |
beforeExecute(t: Thread!, r: Runnable!)
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.
|
Unit |
finalize()
Invokes shutdown when this executor is no longer referenced and it has no threads.
|
Int |
getActiveCount()
Returns the approximate number of threads that are actively executing tasks.
|
Long |
getCompletedTaskCount()
Returns the approximate total number of tasks that have completed execution. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation, but one that does not ever decrease across successive calls.
|
Int |
getCorePoolSize()
Returns the core number of threads.
|
Long |
getKeepAliveTime(unit: TimeUnit!)
Returns the thread keep-alive time, which is the amount of time that threads may remain idle before being terminated. Threads that wait this amount of time without processing a task will be terminated if there are more than the core number of threads currently in the pool, or if this pool allows core thread timeout.
|
Int |
getLargestPoolSize()
Returns the largest number of threads that have ever simultaneously been in the pool.
|
Int |
getMaximumPoolSize()
Returns the maximum allowed number of threads.
|
Int |
getPoolSize()
Returns the current number of threads in the pool.
|
RejectedExecutionHandler! |
getRejectedExecutionHandler()
Returns the current handler for unexecutable tasks.
|
Long |
getTaskCount()
Returns the approximate total number of tasks that have ever been scheduled for execution. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation.
|
ThreadFactory! |
getThreadFactory()
Returns the thread factory used to create new threads.
|
Boolean |
isShutdown()
|
Boolean |
isTerminated()
|
Boolean |
isTerminating()
Returns true if this executor is in the process of terminating after shutdown or shutdownNow but has not completely terminated. This method may be useful for debugging. A return of true reported a sufficient period after shutdown may indicate that submitted tasks have ignored or suppressed interruption, causing this executor not to properly terminate.
|
Int |
prestartAllCoreThreads()
Starts all core threads, causing them to idly wait for work. This overrides the default policy of starting core threads only when new tasks are executed.
|
Boolean |
prestartCoreThread()
Starts a core thread, causing it to idly wait for work. This overrides the default policy of starting core threads only when new tasks are executed. This method will return false if all core threads have already been started.
|
Unit |
purge()
Tries to remove from the work queue all Future tasks that have been cancelled. This method can be useful as a storage reclamation operation, that has no other impact on functionality. Cancelled tasks are never executed, but may accumulate in work queues until worker threads can actively remove them. Invoking this method instead tries to remove them now. However, this method may fail to remove tasks in the presence of interference by other threads.
|
Boolean |
remove(task: Runnable!)
Removes this task from the executor's internal queue if it is present, thus causing it not to be run if it has not already started.
This method may be useful as one part of a cancellation scheme. It may fail to remove tasks that have been converted into other forms before being placed on the internal queue. For example, a task entered using submit might be converted into a form that maintains Future status. However, in such cases, method purge may be used to remove those Futures that have been cancelled.
|
Unit |
setCorePoolSize(corePoolSize: Int)
Sets the core number of threads. This overrides any value set in the constructor. If the new value is smaller than the current value, excess existing threads will be terminated when they next become idle. If larger, new threads will, if needed, be started to execute any queued tasks.
|
Unit |
setKeepAliveTime(time: Long, unit: TimeUnit!)
Sets the thread keep-alive time, which is the amount of time that threads may remain idle before being terminated. Threads that wait this amount of time without processing a task will be terminated if there are more than the core number of threads currently in the pool, or if this pool allows core thread timeout. This overrides any value set in the constructor.
|
Unit |
setMaximumPoolSize(maximumPoolSize: Int)
Sets the maximum allowed number of threads. This overrides any value set in the constructor. If the new value is smaller than the current value, excess existing threads will be terminated when they next become idle.
|
Unit |
setRejectedExecutionHandler(handler: RejectedExecutionHandler!)
Sets a new handler for unexecutable tasks.
|
Unit |
setThreadFactory(threadFactory: ThreadFactory!)
Sets the thread factory used to create new threads.
|
Unit |
terminated()
Method invoked when the Executor has terminated. Default implementation does nothing. Note: To properly nest multiple overridings, subclasses should generally invoke super.terminated within this method.
|
String |
toString()
Returns a string identifying this pool, as well as its state, including indications of run state and estimated worker and task counts.
|
|
From class ExecutorService
Boolean |
awaitTermination(timeout: Long, unit: TimeUnit!)
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
|
Boolean |
isShutdown()
Returns true if this executor has been shut down.
|
Boolean |
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.
|
Unit |
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.
|
MutableList<Runnable!>! |
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.
|
|
From class Executor
Unit |
execute(command: Runnable!)
Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.
|
|
|
|
Public constructors
<init>
ScheduledThreadPoolExecutor(corePoolSize: Int)
Creates a new ScheduledThreadPoolExecutor with the given core pool size.
| Parameters |
corePoolSize |
Int: the number of threads to keep in the pool, even if they are idle, unless allowCoreThreadTimeOut is set |
| Exceptions |
java.lang.IllegalArgumentException |
if corePoolSize < 0 |
<init>
ScheduledThreadPoolExecutor(
corePoolSize: Int,
threadFactory: ThreadFactory!)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
| Parameters |
corePoolSize |
Int: the number of threads to keep in the pool, even if they are idle, unless allowCoreThreadTimeOut is set |
threadFactory |
ThreadFactory!: the factory to use when the executor creates a new thread |
| Exceptions |
java.lang.IllegalArgumentException |
if corePoolSize < 0 |
java.lang.NullPointerException |
if threadFactory is null |
<init>
ScheduledThreadPoolExecutor(
corePoolSize: Int,
handler: RejectedExecutionHandler!)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
| Parameters |
corePoolSize |
Int: the number of threads to keep in the pool, even if they are idle, unless allowCoreThreadTimeOut is set |
handler |
RejectedExecutionHandler!: the handler to use when execution is blocked because the thread bounds and queue capacities are reached |
| Exceptions |
java.lang.IllegalArgumentException |
if corePoolSize < 0 |
java.lang.NullPointerException |
if handler is null |
<init>
ScheduledThreadPoolExecutor(
corePoolSize: Int,
threadFactory: ThreadFactory!,
handler: RejectedExecutionHandler!)
Creates a new ScheduledThreadPoolExecutor with the given initial parameters.
| Parameters |
corePoolSize |
Int: the number of threads to keep in the pool, even if they are idle, unless allowCoreThreadTimeOut is set |
threadFactory |
ThreadFactory!: the factory to use when the executor creates a new thread |
handler |
RejectedExecutionHandler!: the handler to use when execution is blocked because the thread bounds and queue capacities are reached |
| Exceptions |
java.lang.IllegalArgumentException |
if corePoolSize < 0 |
java.lang.NullPointerException |
if threadFactory or handler is null |
Public methods
execute
open fun execute(command: Runnable!): Unit
Executes command with zero required delay. This has effect equivalent to schedule(command, 0, anyUnit). Note that inspections of the queue and of the list returned by shutdownNow will access the zero-delayed ScheduledFuture, not the command itself.
A consequence of the use of ScheduledFuture objects is that ThreadPoolExecutor#afterExecute is always called with a null second Throwable argument, even if the command terminated abruptly. Instead, the Throwable thrown by such a task can be obtained via Future#get.
| Parameters |
command |
Runnable!: the runnable task |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
at discretion of RejectedExecutionHandler, if the task cannot be accepted for execution because the executor has been shut down |
java.lang.NullPointerException |
if command is null |
getContinueExistingPeriodicTasksAfterShutdownPolicy
open fun getContinueExistingPeriodicTasksAfterShutdownPolicy(): Boolean
Gets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow or after setting the policy to false when already shutdown. This value is by default false.
| Return |
Boolean |
true if will continue after shutdown |
getExecuteExistingDelayedTasksAfterShutdownPolicy
open fun getExecuteExistingDelayedTasksAfterShutdownPolicy(): Boolean
Gets the policy on whether to execute existing delayed tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow, or after setting the policy to false when already shutdown. This value is by default true.
| Return |
Boolean |
true if will execute after shutdown |
getQueue
open fun getQueue(): BlockingQueue<Runnable!>!
Returns the task queue used by this executor. Access to the task queue is intended primarily for debugging and monitoring. This queue may be in active use. Retrieving the task queue does not prevent queued tasks from executing.
Each element of this queue is a ScheduledFuture. For tasks submitted via one of the schedule methods, the element will be identical to the returned ScheduledFuture. For tasks submitted using execute, the element will be a zero-delay ScheduledFuture.
Iteration over this queue is not guaranteed to traverse tasks in the order in which they will execute.
getRemoveOnCancelPolicy
open fun getRemoveOnCancelPolicy(): Boolean
Gets the policy on whether cancelled tasks should be immediately removed from the work queue at time of cancellation. This value is by default false.
| Return |
Boolean |
true if cancelled tasks are immediately removed from the queue |
schedule
open fun schedule(
command: Runnable!,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
| Parameters |
command |
Runnable!: the task to execute |
delay |
Long: the time from now to delay execution |
unit |
TimeUnit!: the time unit of the delay parameter |
| Return |
ScheduledFuture<*>! |
a ScheduledFuture representing pending completion of the task and whose get() method will return null upon completion |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if command is null |
schedule
open fun <V : Any!> schedule(
callable: Callable<V>!,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<V>!
| Parameters |
callable |
Callable<V>!: the function to execute |
delay |
Long: the time from now to delay execution |
unit |
TimeUnit!: the time unit of the delay parameter |
<V> |
the type of the callable's result |
| Return |
ScheduledFuture<V>! |
a ScheduledFuture that can be used to extract result or cancel |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if callable is null |
scheduleAtFixedRate
open fun scheduleAtFixedRate(
command: Runnable!,
initialDelay: Long,
period: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
| Parameters |
command |
Runnable!: the task to execute |
initialDelay |
Long: the time to delay first execution |
period |
Long: the period between successive executions |
unit |
TimeUnit!: the time unit of the initialDelay and period parameters |
| Return |
ScheduledFuture<*>! |
a ScheduledFuture representing pending completion of the series of repeated tasks. The future's Future#get() method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution. |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if command is null |
java.lang.IllegalArgumentException |
if period less than or equal to zero |
scheduleWithFixedDelay
open fun scheduleWithFixedDelay(
command: Runnable!,
initialDelay: Long,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
| Parameters |
command |
Runnable!: the task to execute |
initialDelay |
Long: the time to delay first execution |
delay |
Long: the delay between the termination of one execution and the commencement of the next |
unit |
TimeUnit!: the time unit of the initialDelay and delay parameters |
| Return |
ScheduledFuture<*>! |
a ScheduledFuture representing pending completion of the series of repeated tasks. The future's Future#get() method will never return normally, and will throw an exception upon task cancellation or abnormal termination of a task execution. |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if command is null |
java.lang.IllegalArgumentException |
if delay less than or equal to zero |
setContinueExistingPeriodicTasksAfterShutdownPolicy
open fun setContinueExistingPeriodicTasksAfterShutdownPolicy(value: Boolean): Unit
Sets the policy on whether to continue executing existing periodic tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow or after setting the policy to false when already shutdown. This value is by default false.
| Parameters |
value |
Boolean: if true, continue after shutdown, else don't |
setExecuteExistingDelayedTasksAfterShutdownPolicy
open fun setExecuteExistingDelayedTasksAfterShutdownPolicy(value: Boolean): Unit
Sets the policy on whether to execute existing delayed tasks even when this executor has been shutdown. In this case, these tasks will only terminate upon shutdownNow, or after setting the policy to false when already shutdown. This value is by default true.
| Parameters |
value |
Boolean: if true, execute after shutdown, else don't |
setRemoveOnCancelPolicy
open fun setRemoveOnCancelPolicy(value: Boolean): Unit
Sets the policy on whether cancelled tasks should be immediately removed from the work queue at time of cancellation. This value is by default false.
| Parameters |
value |
Boolean: if true, remove on cancellation, else don't |
shutdown
open fun shutdown(): Unit
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.
If the ExecuteExistingDelayedTasksAfterShutdownPolicy has been set false, existing delayed tasks whose delays have not yet elapsed are cancelled. And unless the ContinueExistingPeriodicTasksAfterShutdownPolicy has been set true, future executions of existing periodic tasks will be cancelled.
shutdownNow
open fun shutdownNow(): MutableList<Runnable!>!
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. These tasks are drained (removed) from the task queue upon return from this method.
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. This implementation interrupts tasks via Thread#interrupt; any task that fails to respond to interrupts may never terminate.
| Return |
MutableList<Runnable!>! |
list of tasks that never commenced execution. Each element of this list is a ScheduledFuture. For tasks submitted via one of the schedule methods, the element will be identical to the returned ScheduledFuture. For tasks submitted using execute, the element will be a zero-delay ScheduledFuture. |
submit
open fun submit(task: Runnable!): Future<*>!
| Parameters |
task |
Runnable!: the task to submit |
| Return |
Future<*>! |
a Future representing pending completion of the task |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if the task is null |
submit
open fun <T : Any!> submit(
task: Runnable!,
result: T
): Future<T>!
| Parameters |
task |
Runnable!: the task to submit |
result |
T: the result to return |
<T> |
the type of the result |
| Return |
Future<T>! |
a Future representing pending completion of the task |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if the task is null |
submit
open fun <T : Any!> submit(task: Callable<T>!): Future<T>!
| Parameters |
task |
Callable<T>!: the task to submit |
<T> |
the type of the task's result |
| Return |
Future<T>! |
a Future representing pending completion of the task |
| Exceptions |
java.util.concurrent.RejectedExecutionException |
if the task cannot be scheduled for execution |
java.lang.NullPointerException |
if the task is null |
Protected methods
decorateTask
protected open fun <V : Any!> decorateTask(
runnable: Runnable!,
task: RunnableScheduledFuture<V>!
): RunnableScheduledFuture<V>!
Modifies or replaces the task used to execute a runnable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
| Parameters |
runnable |
Runnable!: the submitted Runnable |
task |
RunnableScheduledFuture<V>!: the task created to execute the runnable |
<V> |
the type of the task's result |
decorateTask
protected open fun <V : Any!> decorateTask(
callable: Callable<V>!,
task: RunnableScheduledFuture<V>!
): RunnableScheduledFuture<V>!
Modifies or replaces the task used to execute a callable. This method can be used to override the concrete class used for managing internal tasks. The default implementation simply returns the given task.
| Parameters |
callable |
Callable<V>!: the submitted Callable |
task |
RunnableScheduledFuture<V>!: the task created to execute the callable |
<V> |
the type of the task's result |