reactor.core.scheduler

Interface Scheduler.Worker

All Superinterfaces:

Cancellation, Disposable

All Known Subinterfaces:

TimedScheduler.TimedWorker

Enclosing interface:

Scheduler

public static interface Scheduler.Worker
extends Disposable

A worker representing an asynchronous boundary that executes tasks in a FIFO order, guaranteed non-concurrently with respect to each other.

Author:

Stephane Maldini, Simon Baslé

Method Summary

Modifier and Type	Method and Description
default void	dispose() Instructs this worker to cancel all pending tasks, all running tasks in a best-effort manner, reject new tasks and release any resources associated with it.
Cancellation	schedule(Runnable task) Schedules the task on this worker.
default Cancellation	schedule(Runnable task, long delay, TimeUnit unit) Schedules the execution of the given task with the given delay amount.
default Cancellation	schedulePeriodically(Runnable task, long initialDelay, long period, TimeUnit unit) Schedules a periodic execution of the given task with the given initial delay and period.
void	shutdown() Deprecated. move the implementation to dispose() and call dispose from shutdown. Will be removed in 3.1.0

Methods inherited from interface reactor.core.Disposable

isDisposed

Method Detail

schedule

Cancellation schedule(Runnable task)

Schedules the task on this worker.

Parameters:

task - the task to schedule

Returns:

the Cancellation instance that let's one cancel this particular task. If the Scheduler has been shut down, the Scheduler.REJECTED Cancellation instance is returned.

schedule

default Cancellation schedule(Runnable task,
                              long delay,
                              TimeUnit unit)

Schedules the execution of the given task with the given delay amount.

This method is safe to be called from multiple threads and tasks are executed in some total order. Two tasks scheduled at a same time with the same delay will be ordered in FIFO order if the schedule() was called from the same thread or in arbitrary order if the schedule() was called from different threads.

Parameters:

task - the task to schedule

delay - the delay amount, non-positive values indicate non-delayed scheduling

unit - the unit of measure of the delay amount

Returns:

the Cancellation that let's one cancel this particular delayed task, or Scheduler.REJECTED if the Worker is not capable of scheduling with delay.

schedulePeriodically

default Cancellation schedulePeriodically(Runnable task,
                                          long initialDelay,
                                          long period,
                                          TimeUnit unit)

Schedules a periodic execution of the given task with the given initial delay and period.

This method is safe to be called from multiple threads.

The periodic execution is at a fixed rate, that is, the first execution will be after the initial delay, the second after initialDelay + period, the third after initialDelay + 2 * period, and so on.

Parameters:

task - the task to schedule

initialDelay - the initial delay amount, non-positive values indicate non-delayed scheduling

period - the period at which the task should be re-executed

unit - the unit of measure of the delay amount

Returns:

the Cancellation that let's one cancel this particular delayed task, or Scheduler.REJECTED if the Worker is not capable of scheduling periodically.

shutdown

@Deprecated
void shutdown()

Deprecated. move the implementation to dispose() and call dispose from shutdown. Will be removed in 3.1.0

Instructs this worker to cancel all pending tasks, all running tasks in a best-effort manner, reject new tasks and release any resources associated with it.

dispose

default void dispose()

Instructs this worker to cancel all pending tasks, all running tasks in a best-effort manner, reject new tasks and release any resources associated with it.

Specified by:

dispose in interface Cancellation

Specified by:

dispose in interface Disposable