org.apache.flink.runtime.rpc

Class FencedRpcEndpoint<F extends Serializable>

java.lang.Object

org.apache.flink.runtime.rpc.RpcEndpoint

org.apache.flink.runtime.rpc.FencedRpcEndpoint<F>

Type Parameters:

F - type of the fencing token

All Implemented Interfaces:

AutoCloseable, RpcGateway, AutoCloseableAsync

Direct Known Subclasses:

JobMaster, PermanentlyFencedRpcEndpoint, ResourceManager

public abstract class FencedRpcEndpoint<F extends Serializable>
extends RpcEndpoint

Base class for fenced RpcEndpoint. A fenced rpc endpoint expects all rpc messages being enriched with fencing tokens. Furthermore, the rpc endpoint has its own fencing token assigned. The rpc is then only executed if the attached fencing token equals the endpoint's own token.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

RpcEndpoint.MainThreadExecutor

Field Summary

Fields inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

log, rpcServer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FencedRpcEndpoint(RpcService rpcService, F fencingToken)
protected	FencedRpcEndpoint(RpcService rpcService, String endpointId, F fencingToken)

Method Summary

Modifier and Type	Method and Description
protected <V> CompletableFuture<V>	callAsyncWithoutFencing(Callable<V> callable, Time timeout) Run the given callable in the main thread of the RpcEndpoint without checking the fencing token.
F	getFencingToken()
protected RpcEndpoint.MainThreadExecutor	getMainThreadExecutor() Returns a main thread executor which is bound to the currently valid fencing token.
protected Executor	getUnfencedMainThreadExecutor() Returns a main thread executor which is not bound to the fencing token.
protected void	runAsyncWithoutFencing(Runnable runnable) Run the given runnable in the main thread of the RpcEndpoint without checking the fencing token.
protected void	setFencingToken(F newFencingToken)

Methods inherited from class org.apache.flink.runtime.rpc.RpcEndpoint

callAsync, closeAsync, getAddress, getEndpointId, getHostname, getRpcService, getSelfGateway, getTerminationFuture, internalCallOnStart, internalCallOnStop, isRunning, onStart, onStop, runAsync, scheduleRunAsync, scheduleRunAsync, start, stop, validateRunsInMainThread

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Constructor Detail

FencedRpcEndpoint

protected FencedRpcEndpoint(RpcService rpcService,
                            String endpointId,
                            @Nullable
                            F fencingToken)

FencedRpcEndpoint

protected FencedRpcEndpoint(RpcService rpcService,
                            @Nullable
                            F fencingToken)

Method Detail

getFencingToken

public F getFencingToken()

setFencingToken

protected void setFencingToken(@Nullable
                               F newFencingToken)

getMainThreadExecutor

protected RpcEndpoint.MainThreadExecutor getMainThreadExecutor()

Returns a main thread executor which is bound to the currently valid fencing token. This means that runnables which are executed with this executor fail after the fencing token has changed. This allows to scope operations by the fencing token.

Overrides:

getMainThreadExecutor in class RpcEndpoint

Returns:

MainThreadExecutor bound to the current fencing token

getUnfencedMainThreadExecutor

protected Executor getUnfencedMainThreadExecutor()

Returns a main thread executor which is not bound to the fencing token. This means that Runnable which are executed with this executor will always be executed.

Returns:

MainThreadExecutor which is not bound to the fencing token

runAsyncWithoutFencing

protected void runAsyncWithoutFencing(Runnable runnable)

Run the given runnable in the main thread of the RpcEndpoint without checking the fencing token. This allows to run operations outside of the fencing token scope.

Parameters:

runnable - to execute in the main thread of the rpc endpoint without checking the fencing token.

callAsyncWithoutFencing

protected <V> CompletableFuture<V> callAsyncWithoutFencing(Callable<V> callable,
                                                           Time timeout)

Run the given callable in the main thread of the RpcEndpoint without checking the fencing token. This allows to run operations outside of the fencing token scope.

Parameters:

callable - to run in the main thread of the rpc endpoint without checkint the fencing token.

timeout - for the operation.

Returns:

Future containing the callable result.