Spec-Zone.ru › OpenJDK 17

Интерфейс ScheduledExecutorService

Все суперинтерфейсы:
Executor, ExecutorService
Все известные реализующие классы:
ScheduledThreadPoolExecutor
public interface ScheduledExecutorService extends ExecutorService
Объект ExecutorService, который может планировать выполнение команд после заданной задержки или периодически.

Методы schedule создают задачи с различными задержками и возвращают объект задачи, который можно использовать для отмены или проверки выполнения. Методы scheduleAtFixedRate и scheduleWithFixedDelay создают и выполняют задачи, которые выполняются периодически до отмены.

Команды, отправленные с помощью методов Executor.execute(Runnable) и ExecutorService submit планируются с запрошенной задержкой ноль. Нулевые и отрицательные задержки (но не периоды) также разрешены в методах schedule, и они обрабатываются как запросы на немедленное выполнение.

Все методы schedule принимают относительные задержки и периоды в качестве аргументов, а не абсолютные моменты времени или даты. Преобразование абсолютного момента времени, представленного как Date, в необходимый вид — простая задача. Например, для планирования на определенный будущий date, можно использовать: schedule(task, date.getTime() - System.currentTimeMillis(), TimeUnit.MILLISECONDS). Однако следует учитывать, что истечение относительной задержки может не совпадать с текущим Date момента включения задачи из-за протоколов синхронизации сетевого времени, дрейфа часов или других факторов.

Класс Executors предоставляет удобные методы-фабрики для реализаций ScheduledExecutorService, предоставленных в этом пакете.

Пример использования

Вот класс с методом, который настраивает ScheduledExecutorService для издаваемого сигнала каждую десять секунд в течение часа:
 
 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);
   }
 }
С тех пор:
1.5

Краткое описание методов

Модификатор и тип Метод Описание
ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit)
Отправляет однократную задачу, которая становится активной после заданной задержки.
<V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit)
Отправляет возвращающую значение однократную задачу, которая становится активной после заданной задержки.
ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
Отправляет периодическое действие, которое становится активным сначала после заданной начальной задержки, а затем с заданным периодом; то есть, выполнение начнется после initialDelay, затем initialDelay + period, затем initialDelay + 2 * period, и так далее.
ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
Отправляет периодическое действие, которое становится активным сначала после заданной начальной задержки, а затем с заданной задержкой между завершением одного выполнения и началом следующего.

Методы, объявленные в интерфейсе java.util.concurrent.Executor

execute

Методы, объявленные в интерфейсе java.util.concurrent.ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Подробное описание методов

schedule

ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit)
Отправляет однократную задачу, которая становится активной после заданной задержки.
Параметры:
command - задача для выполнения
delay - время задержки выполнения
unit - единица измерения времени задержки
Возвращаемое значение:
ScheduledFuture, представляющий ожидаемое завершение задачи, и метод get() которого вернёт null при завершении
Исключения:
RejectedExecutionException - если задача не может быть запланирована для выполнения
NullPointerException - если команда или единица измерения равны null

schedule

<V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit)
Отправляет возвращающую значение однократную задачу, которая становится активной после заданной задержки.
Параметры типа:
V - тип результата вызываемого объекта
Параметры:
callable - функция для выполнения
delay - время задержки выполнения
unit - единица измерения времени задержки
Возвращаемое значение:
ScheduledFuture, который можно использовать для получения результата или отмены
Исключения:
RejectedExecutionException - если задача не может быть запланирована для выполнения
NullPointerException - если callable или единица измерения равны null

scheduleAtFixedRate

ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
Отправляет периодическое действие, которое становится активным сначала после заданной начальной задержки, а затем с заданным периодом; то есть, выполнение начнется после initialDelay, затем initialDelay + period, затем initialDelay + 2 * period, и так далее.

Последовательность выполнения задач продолжается неопределенно, пока не произойдёт одно из следующих исключительных завершений:

  • Задача явным образом отменяется через возвращённый future.
  • Исполнитель завершается, также приводя к отмене задачи.
  • При выполнении задачи возникает исключение. В этом случае вызов get на возвращённом future вызовет ExecutionException, содержащий исключение в качестве причины.
Последующие выполнения подавляются. Последующие вызовы isDone() на возвращённом future вернут true.

Если выполнение этой задачи занимает больше времени, чем её период, то последующие выполнения могут начаться с опозданием, но не будут выполняться одновременно.

Параметры:
command - задача для выполнения
initialDelay - время задержки первого выполнения
period - период между последующими выполнениями
unit - единица измерения времени initialDelay и period
Возвращаемое значение:
ScheduledFuture, представляющий ожидаемое завершение серии повторяющихся задач. Метод get() future никогда не вернёт нормально и вызовет исключение при отмене задачи или аномальном завершении выполнения задачи.
Исключения:
RejectedExecutionException - если задача не может быть запланирована для выполнения
NullPointerException - если команда или единица измерения равны null
IllegalArgumentException - если период меньше или равен нулю

scheduleWithFixedDelay

ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
Отправляет периодическое действие, которое становится активным сначала после заданной начальной задержки, а затем с заданной задержкой между завершением одного выполнения и началом следующего.

Последовательность выполнения задач продолжается неопределенно, пока не произойдёт одно из следующих исключительных завершений:

  • Задача явным образом отменяется через возвращённый future.
  • Исполнитель завершается, также приводя к отмене задачи.
  • При выполнении задачи возникает исключение. В этом случае вызов get на возвращённом future вызовет ExecutionException, содержащий исключение в качестве причины.
Последующие выполнения подавляются. Последующие вызовы isDone() на возвращённом future вернут true.
Параметры:
command - задача для выполнения
initialDelay - время задержки первого выполнения
delay - задержка между завершением одного выполнения и началом следующего
unit - единица измерения времени initialDelay и delay
Возвращаемое значение:
ScheduledFuture, представляющий ожидаемое завершение серии повторяющихся задач. Метод get() future никогда не вернёт нормально и вызовет исключение при отмене задачи или аномальном завершении выполнения задачи.
Исключения:
RejectedExecutionException - если задача не может быть запланирована для выполнения
NullPointerException - если команда или единица измерения равны null
IllegalArgumentException - если задержка меньше или равна нулю

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API