Package org.apache.flink.runtime.rpc

Class RpcEndpoint.MainThreadExecutor

java.lang.Object

org.apache.flink.runtime.rpc.RpcEndpoint.MainThreadExecutor

All Implemented Interfaces:

Closeable, AutoCloseable, Executor, ComponentMainThreadExecutor, ScheduledExecutor

Enclosing class:

RpcEndpoint

protected static class RpcEndpoint.MainThreadExecutor
extends Object
implements ComponentMainThreadExecutor, Closeable

Executor which executes runnables in the main thread context.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.concurrent.ComponentMainThreadExecutor

ComponentMainThreadExecutor.DummyComponentMainThreadExecutor

Method Summary

Modifier and Type	Method	Description
void	assertRunningInMainThread()	Returns true if the method was called in the thread of this executor.
void	close()	Shutdown the ScheduledThreadPoolExecutor and remove all the pending tasks.
void	execute(Runnable command)
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)	The mainScheduledExecutor manages the task and sends it to the gateway after the given delay.
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)	The mainScheduledExecutor manages the given callable and sends it to the gateway 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

execute

public void execute(@Nonnull
                    Runnable command)

Specified by:

execute in interface Executor

schedule

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

The mainScheduledExecutor manages the task and sends it to the gateway after the given delay.

Specified by:

schedule in interface ScheduledExecutor

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

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

The mainScheduledExecutor manages the given callable and sends it to the gateway after the given delay.

Specified by:

schedule in interface ScheduledExecutor

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

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

Description copied from interface: ScheduledExecutor

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.

Specified by:

scheduleAtFixedRate in interface ScheduledExecutor

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

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

Description copied from interface: ScheduledExecutor

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.

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutor

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

assertRunningInMainThread

public void assertRunningInMainThread()

Description copied from interface: ComponentMainThreadExecutor

Returns true if the method was called in the thread of this executor.

Specified by:

assertRunningInMainThread in interface ComponentMainThreadExecutor

close

public void close()

Shutdown the ScheduledThreadPoolExecutor and remove all the pending tasks.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable