org.apache.flink.util.concurrent

Interface ScheduledExecutor

All Superinterfaces:

Executor

All Known Subinterfaces:

ComponentMainThreadExecutor

All Known Implementing Classes:

ActorSystemScheduledExecutorAdapter, ComponentMainThreadExecutor.DummyComponentMainThreadExecutor, RpcEndpoint.MainThreadExecutor, ScheduledExecutorServiceAdapter

public interface ScheduledExecutor
extends Executor

Extension for the Executor interface which is enriched by method for scheduling tasks in the future.

Method Summary

Modifier and Type	Method and Description
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit) Executes the given callable after the given delay.
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit) Executes the given command after the given delay.
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) Executes the given command periodically.
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) Executed the given command repeatedly with the given delay between the end of an execution and the start of the next execution.

Methods inherited from interface java.util.concurrent.Executor

execute

Method Detail

schedule

ScheduledFuture<?> schedule(Runnable command,
                            long delay,
                            TimeUnit unit)

Executes the given command after the given delay.

Parameters:

command - the task to execute in the future

delay - the time from now to delay the execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture representing the completion of the scheduled task

schedule

<V> ScheduledFuture<V> schedule(Callable<V> callable,
                                long delay,
                                TimeUnit unit)

Executes the given callable after the given delay. The result of the callable is returned as a ScheduledFuture.

Type Parameters:

V - result type of the callable

Parameters:

callable - the callable to execute

delay - the time from now to delay the execution

unit - the time unit of the delay parameter

Returns:

a ScheduledFuture which holds the future value of the given callable

scheduleAtFixedRate

ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                       long initialDelay,
                                       long period,
                                       TimeUnit unit)

Executes the given command periodically. The first execution is started after the initialDelay, the second execution is started after initialDelay + period, the third after initialDelay + 2*period and so on. The task is executed until either an execution fails, or the returned ScheduledFuture is cancelled.

Parameters:

command - the task to be executed periodically

initialDelay - the time from now until the first execution is triggered

period - the time after which the next execution is triggered

unit - the time unit of the delay and period parameter

Returns:

a ScheduledFuture representing the periodic task. This future never completes unless an execution of the given task fails or if the future is cancelled

scheduleWithFixedDelay

ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                          long initialDelay,
                                          long delay,
                                          TimeUnit unit)

Executed the given command repeatedly with the given delay between the end of an execution and the start of the next execution. The task is executed repeatedly until either an exception occurs or if the returned ScheduledFuture is cancelled.

Parameters:

command - the task to execute repeatedly

initialDelay - the time from now until the first execution is triggered

delay - the time between the end of the current and the start of the next execution

unit - the time unit of the initial delay and the delay parameter

Returns:

a ScheduledFuture representing the repeatedly executed task. This future never completes unless the execution of the given task fails or if the future is cancelled