org.apache.flink.runtime.rpc.akka

Class FencedAkkaInvocationHandler<F extends Serializable>

java.lang.Object

org.apache.flink.runtime.rpc.akka.FencedAkkaInvocationHandler<F>

Type Parameters:

F - type of the fencing token

All Implemented Interfaces:

InvocationHandler, FencedMainThreadExecutable, FencedRpcGateway<F>, MainThreadExecutable, RpcGateway, RpcServer, StartStoppable

public class FencedAkkaInvocationHandler<F extends Serializable>
extends Object
implements FencedMainThreadExecutable, FencedRpcGateway<F>

Fenced extension of the AkkaInvocationHandler. This invocation handler will be used in combination with the FencedRpcEndpoint. The fencing is done by wrapping all messages in a FencedMessage.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isLocal

Constructor Summary

Constructors

Constructor and Description
FencedAkkaInvocationHandler(String address, String hostname, akka.actor.ActorRef rpcEndpoint, Time timeout, long maximumFramesize, CompletableFuture<Boolean> terminationFuture, CompletableFuture<Void> internalTerminationFuture, java.util.function.Supplier<F> fencingTokenSupplier)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<?>	ask(Object message, Time timeout) Sends the message to the RPC endpoint and returns a future containing its response.
<V> CompletableFuture<V>	callAsync(Callable<V> callable, Time callTimeout) Execute the callable in the main thread of the underlying RPC endpoint and return a future for the callable result.
<V> CompletableFuture<V>	callAsyncWithoutFencing(Callable<V> callable, Time timeout) Run the given callable in the main thread without attaching a fencing token.
protected RpcInvocation	createRpcInvocationMessage(String methodName, Class<?>[] parameterTypes, Object[] args) Create the RpcInvocation message for the given RPC.
akka.actor.ActorRef	getActorRef() Returns the ActorRef of the underlying RPC actor.
String	getAddress() Returns the fully qualified address under which the associated rpc endpoint is reachable.
F	getFencingToken() Get the current fencing token.
String	getHostname() Returns the fully qualified hostname under which the associated rpc endpoint is reachable.
CompletableFuture<Void>	getInternalTerminationFuture() Returns the internal termination future.
CompletableFuture<Boolean>	getTerminationFuture() Return a future which is completed when the rpc endpoint has been terminated.
Object	invoke(Object proxy, Method method, Object[] args)
void	runAsync(Runnable runnable) Execute the runnable in the main thread of the underlying RPC endpoint.
void	runAsyncWithoutFencing(Runnable runnable) Run the given runnable in the main thread without attaching a fencing token.
void	scheduleRunAsync(Runnable runnable, long delayMillis) Execute the runnable in the main thread of the underlying RPC endpoint, with a delay of the given number of milliseconds.
void	start() Starts the processing of remote procedure calls.
void	stop() Stops the processing of remote procedure calls.
void	tell(Object message) Sends the message to the RPC endpoint.

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.runtime.rpc.MainThreadExecutable

callAsync, runAsync, scheduleRunAsync

Methods inherited from interface org.apache.flink.runtime.rpc.RpcGateway

getAddress, getHostname

Field Detail

isLocal

protected final boolean isLocal

Constructor Detail

FencedAkkaInvocationHandler

public FencedAkkaInvocationHandler(String address,
                                   String hostname,
                                   akka.actor.ActorRef rpcEndpoint,
                                   Time timeout,
                                   long maximumFramesize,
                                   @Nullable
                                   CompletableFuture<Boolean> terminationFuture,
                                   @Nullable
                                   CompletableFuture<Void> internalTerminationFuture,
                                   java.util.function.Supplier<F> fencingTokenSupplier)

Method Detail

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

runAsyncWithoutFencing

public void runAsyncWithoutFencing(Runnable runnable)

Description copied from interface: FencedMainThreadExecutable

Run the given runnable in the main thread without attaching a fencing token.

Specified by:

runAsyncWithoutFencing in interface FencedMainThreadExecutable

Parameters:

runnable - to run in the main thread without validating the fencing token.

callAsyncWithoutFencing

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

Description copied from interface: FencedMainThreadExecutable

Run the given callable in the main thread without attaching a fencing token.

Specified by:

callAsyncWithoutFencing in interface FencedMainThreadExecutable

Type Parameters:

V - type of the callable result

Parameters:

callable - to run in the main thread without validating the fencing token.

timeout - for the operation

Returns:

Future containing the callable result

tell

public void tell(Object message)

Sends the message to the RPC endpoint.

Parameters:

message - to send to the RPC endpoint.

ask

public CompletableFuture<?> ask(Object message,
                                Time timeout)

Sends the message to the RPC endpoint and returns a future containing its response.

Parameters:

message - to send to the RPC endpoint

timeout - time to wait until the response future is failed with a TimeoutException

Returns:

Response future

getFencingToken

public F getFencingToken()

Description copied from interface: FencedRpcGateway

Get the current fencing token.

Specified by:

getFencingToken in interface FencedRpcGateway<F extends Serializable>

Returns:

current fencing token

getActorRef

public akka.actor.ActorRef getActorRef()

Returns the ActorRef of the underlying RPC actor.

Returns:

the ActorRef of the underlying RPC actor

runAsync

public void runAsync(Runnable runnable)

Description copied from interface: MainThreadExecutable

Execute the runnable in the main thread of the underlying RPC endpoint.

Specified by:

runAsync in interface MainThreadExecutable

Parameters:

runnable - Runnable to be executed

scheduleRunAsync

public void scheduleRunAsync(Runnable runnable,
                             long delayMillis)

Description copied from interface: MainThreadExecutable

Execute the runnable in the main thread of the underlying RPC endpoint, with a delay of the given number of milliseconds.

Specified by:

scheduleRunAsync in interface MainThreadExecutable

Parameters:

runnable - Runnable to be executed

delayMillis - The delay, in milliseconds, after which the runnable will be executed

callAsync

public <V> CompletableFuture<V> callAsync(Callable<V> callable,
                                          Time callTimeout)

Description copied from interface: MainThreadExecutable

Execute the callable in the main thread of the underlying RPC endpoint and return a future for the callable result. If the future is not completed within the given timeout, the returned future will throw a TimeoutException.

Specified by:

callAsync in interface MainThreadExecutable

Type Parameters:

V - Return value of the callable

Parameters:

callable - Callable to be executed

callTimeout - Timeout for the future to complete

Returns:

Future of the callable result

start

public void start()

Description copied from interface: StartStoppable

Starts the processing of remote procedure calls.

Specified by:

start in interface StartStoppable

stop

public void stop()

Description copied from interface: StartStoppable

Stops the processing of remote procedure calls.

Specified by:

stop in interface StartStoppable

createRpcInvocationMessage

protected RpcInvocation createRpcInvocationMessage(String methodName,
                                                   Class<?>[] parameterTypes,
                                                   Object[] args)
                                            throws IOException

Create the RpcInvocation message for the given RPC.

Parameters:

methodName - of the RPC

parameterTypes - of the RPC

args - of the RPC

Returns:

RpcInvocation message which encapsulates the RPC details

Throws:

IOException - if we cannot serialize the RPC invocation parameters

getAddress

public String getAddress()

Description copied from interface: RpcGateway

Returns the fully qualified address under which the associated rpc endpoint is reachable.

Specified by:

getAddress in interface RpcGateway

Returns:

Fully qualified (RPC) address under which the associated rpc endpoint is reachable

getHostname

public String getHostname()

Description copied from interface: RpcGateway

Returns the fully qualified hostname under which the associated rpc endpoint is reachable.

Specified by:

getHostname in interface RpcGateway

Returns:

Fully qualified hostname under which the associated rpc endpoint is reachable

getTerminationFuture

public CompletableFuture<Boolean> getTerminationFuture()

Description copied from interface: RpcServer

Return a future which is completed when the rpc endpoint has been terminated.

Specified by:

getTerminationFuture in interface RpcServer

Returns:

Future indicating when the rpc endpoint has been terminated

getInternalTerminationFuture

public CompletableFuture<Void> getInternalTerminationFuture()

Returns the internal termination future.

Returns:

Internal termination future