ScheduledExecutorService
interface ScheduledExecutorService : ExecutorService
java.util.concurrent.ScheduledExecutorService |
An ExecutorService
that can schedule commands to run after a given delay, or to execute periodically.
The schedule
methods create tasks with various delays and return a task object that can be used to cancel or check execution. The scheduleAtFixedRate
and scheduleWithFixedDelay
methods create and execute tasks that run periodically until cancelled.
Commands submitted using the Executor#execute(Runnable)
and ExecutorService
submit
methods are scheduled with a requested delay of zero. Zero and negative delays (but not periods) are also allowed in schedule
methods, and are treated as requests for immediate execution.
All schedule
methods accept relative delays and periods as arguments, not absolute times or dates. It is a simple matter to transform an absolute time represented as a to the required form. For example, to schedule at a certain future date
, you can use: schedule(task, date.getTime() - System.currentTimeMillis(), TimeUnit.MILLISECONDS)
. Beware however that expiration of a relative delay need not coincide with the current Date
at which the task is enabled due to network time synchronization protocols, clock drift, or other factors.
The Executors
class provides convenient factory methods for the ScheduledExecutorService implementations provided in this package.
Usage Example
Here is a class with a method that sets up a ScheduledExecutorService to beep every ten seconds for an hour:<code>import static java.util.concurrent.TimeUnit.*; class BeeperControl { private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1); public void beepForAnHour() { Runnable beeper = () -> System.out.println("beep"); ScheduledFuture<?> beeperHandle = scheduler.scheduleAtFixedRate(beeper, 10, 10, SECONDS); Runnable canceller = () -> beeperHandle.cancel(false); scheduler.schedule(canceller, 1, HOURS); } }</code>
Summary
Public methods | |
---|---|
abstract ScheduledFuture<*>! |
Submits a one-shot task that becomes enabled after the given delay. |
abstract ScheduledFuture<V>! |
Submits a value-returning one-shot task that becomes enabled after the given delay. |
abstract ScheduledFuture<*>! |
scheduleAtFixedRate(command: Runnable!, initialDelay: Long, period: Long, unit: TimeUnit!) Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after |
abstract ScheduledFuture<*>! |
scheduleWithFixedDelay(command: Runnable!, initialDelay: Long, delay: Long, unit: TimeUnit!) Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. |
Inherited functions | |
---|---|
Public methods
schedule
abstract fun schedule(
command: Runnable!,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
Submits a one-shot task that becomes enabled after the given delay.
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 or unit is null |
schedule
abstract fun <V : Any!> schedule(
callable: Callable<V>!,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<V>!
Submits a value-returning one-shot task that becomes enabled after the given delay.
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 or unit is null |
scheduleAtFixedRate
abstract fun scheduleAtFixedRate(
command: Runnable!,
initialDelay: Long,
period: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is, executions will commence after initialDelay
, then initialDelay + period
, then initialDelay + 2 * period
, and so on.
The sequence of task executions continues indefinitely until one of the following exceptional completions occur:
- The task is explicitly cancelled via the returned future.
- The executor terminates, also resulting in task cancellation.
- An execution of the task throws an exception. In this case calling
get
on the returned future will throwExecutionException
, holding the exception as its cause.
isDone()
on the returned future will return true
.
If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.
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 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 or unit is null |
java.lang.IllegalArgumentException |
if period less than or equal to zero |
scheduleWithFixedDelay
abstract fun scheduleWithFixedDelay(
command: Runnable!,
initialDelay: Long,
delay: Long,
unit: TimeUnit!
): ScheduledFuture<*>!
Submits a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.
The sequence of task executions continues indefinitely until one of the following exceptional completions occur:
- The task is explicitly cancelled via the returned future.
- The executor terminates, also resulting in task cancellation.
- An execution of the task throws an exception. In this case calling
get
on the returned future will throwExecutionException
, holding the exception as its cause.
isDone()
on the returned future will return true
.
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 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 or unit is null |
java.lang.IllegalArgumentException |
if delay less than or equal to zero |