org.apache.flink.runtime.rpc.akka

Class AkkaRpcService

java.lang.Object

org.apache.flink.runtime.rpc.akka.AkkaRpcService

All Implemented Interfaces:

RpcService

@ThreadSafe
public class AkkaRpcService
extends Object
implements RpcService

Akka based RpcService implementation. The RPC service starts an Akka actor to receive RPC invocations from a RpcGateway.

Constructor Summary

Constructors

Constructor and Description
AkkaRpcService(akka.actor.ActorSystem actorSystem, Time timeout)

Method Summary

Methods

Modifier and Type	Method and Description
<C extends RpcGateway> Future<C>	connect(String address, Class<C> clazz) Connect to a remote rpc server under the provided address.
<T> Future<T>	execute(Callable<T> callable) Execute the given callable and return its result as a Future.
void	execute(Runnable runnable) Execute the given runnable in the executor of the RPC service.
String	getAddress() Return the hostname or host address under which the rpc service can be reached.
Executor	getExecutor() Gets the executor, provided by this RPC service.
ScheduledExecutor	getScheduledExecutor() Gets a scheduled executor from the RPC service.
Future<Void>	getTerminationFuture() Returns a future indicating when the RPC service has been shut down.
ScheduledFuture<?>	scheduleRunnable(Runnable runnable, long delay, TimeUnit unit) Execute the runnable in the execution context of this RPC Service, as returned by RpcService.getExecutor(), after a scheduled delay.
<C extends RpcGateway,S extends RpcEndpoint<C>> C	startServer(S rpcEndpoint) Start a rpc server which forwards the remote procedure calls to the provided rpc endpoint.
void	stopServer(RpcGateway selfGateway) Stop the underlying rpc server of the provided self gateway.
void	stopService() Stop the rpc service shutting down all started rpc servers.

Methods inherited from class java.lang.Object

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

Constructor Detail

AkkaRpcService

public AkkaRpcService(akka.actor.ActorSystem actorSystem,
              Time timeout)

Method Detail

getAddress

public String getAddress()

Description copied from interface: RpcService

Return the hostname or host address under which the rpc service can be reached. If the rpc service cannot be contacted remotely, then it will return an empty string.

Specified by:

getAddress in interface RpcService

Returns:

Address of the rpc service or empty string if local rpc service

connect

public <C extends RpcGateway> Future<C> connect(String address,
                                       Class<C> clazz)

Description copied from interface: RpcService

Connect to a remote rpc server under the provided address. Returns a rpc gateway which can be used to communicate with the rpc server. If the connection failed, then the returned future is failed with a RpcConnectionException.

Specified by:

connect in interface RpcService

Type Parameters:

C - Type of the rpc gateway to return

Parameters:

address - Address of the remote rpc server

clazz - Class of the rpc gateway to return

Returns:

Future containing the rpc gateway or an RpcConnectionException if the connection attempt failed

startServer

public <C extends RpcGateway,S extends RpcEndpoint<C>> C startServer(S rpcEndpoint)

Description copied from interface: RpcService

Start a rpc server which forwards the remote procedure calls to the provided rpc endpoint.

Specified by:

startServer in interface RpcService

Type Parameters:

C - Type of the self rpc gateway associated with the rpc server

S - Type of the rpc endpoint

Parameters:

rpcEndpoint - Rpc protocl to dispath the rpcs to

Returns:

Self gateway to dispatch remote procedure calls to oneself

stopServer

public void stopServer(RpcGateway selfGateway)

Description copied from interface: RpcService

Stop the underlying rpc server of the provided self gateway.

Specified by:

stopServer in interface RpcService

Parameters:

selfGateway - Self gateway describing the underlying rpc server

stopService

public void stopService()

Description copied from interface: RpcService

Stop the rpc service shutting down all started rpc servers.

Specified by:

stopService in interface RpcService

getTerminationFuture

public Future<Void> getTerminationFuture()

Description copied from interface: RpcService

Returns a future indicating when the RPC service has been shut down.

Specified by:

getTerminationFuture in interface RpcService

Returns:

Termination future

getExecutor

public Executor getExecutor()

Description copied from interface: RpcService

Gets the executor, provided by this RPC service. This executor can be used for example for the handleAsync(...) or thenAcceptAsync(...) methods of futures.

IMPORTANT: This executor does not isolate the method invocations against any concurrent invocations and is therefore not suitable to run completion methods of futures that modify state of an RpcEndpoint. For such operations, one needs to use the MainThreadExecutionContext of that RpcEndpoint.

Specified by:

getExecutor in interface RpcService

Returns:

The execution context provided by the RPC service

getScheduledExecutor

public ScheduledExecutor getScheduledExecutor()

Description copied from interface: RpcService

Gets a scheduled executor from the RPC service. This executor can be used to schedule tasks to be executed in the future.

IMPORTANT: This executor does not isolate the method invocations against any concurrent invocations and is therefore not suitable to run completion methods of futures that modify state of an RpcEndpoint. For such operations, one needs to use the MainThreadExecutionContext of that RpcEndpoint.

Specified by:

getScheduledExecutor in interface RpcService

Returns:

The RPC service provided scheduled executor

scheduleRunnable

public ScheduledFuture<?> scheduleRunnable(Runnable runnable,
                                  long delay,
                                  TimeUnit unit)

Description copied from interface: RpcService

Execute the runnable in the execution context of this RPC Service, as returned by RpcService.getExecutor(), after a scheduled delay.

Specified by:

scheduleRunnable in interface RpcService

Parameters:

runnable - Runnable to be executed

delay - The delay after which the runnable will be executed

execute

public void execute(Runnable runnable)

Description copied from interface: RpcService

Execute the given runnable in the executor of the RPC service. This method can be used to run code outside of the main thread of a RpcEndpoint.

IMPORTANT: This executor does not isolate the method invocations against any concurrent invocations and is therefore not suitable to run completion methods of futures that modify state of an RpcEndpoint. For such operations, one needs to use the MainThreadExecutionContext of that RpcEndpoint.

Specified by:

execute in interface RpcService

Parameters:

runnable - to execute

execute

public <T> Future<T> execute(Callable<T> callable)

Description copied from interface: RpcService

Execute the given callable and return its result as a Future. This method can be used to run code outside of the main thread of a RpcEndpoint.

IMPORTANT: This executor does not isolate the method invocations against any concurrent invocations and is therefore not suitable to run completion methods of futures that modify state of an RpcEndpoint. For such operations, one needs to use the MainThreadExecutionContext of that RpcEndpoint.

Specified by:

execute in interface RpcService

Type Parameters:

T - is the return value type

Parameters:

callable - to execute

Returns:

Future containing the callable's future result