org.apache.flink.runtime.rpc

Class RpcUtils

java.lang.Object

org.apache.flink.runtime.rpc.RpcUtils

public class RpcUtils
extends Object

Utility functions for Flink's RPC implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	INF_DURATION
static org.apache.flink.api.common.time.Time	INF_TIMEOUT HACK: Set to 21474835 seconds, Akka's maximum delay (Akka 2.4.20).

Method Summary

Modifier and Type	Method and Description
static RpcService	createRemoteRpcService(RpcSystem rpcSystem, org.apache.flink.configuration.Configuration configuration, String externalAddress, String externalPortRange, String bindAddress, Optional<Integer> bindPort) Convenient shortcut for constructing a remote RPC Service that takes care of checking for null and empty optionals.
static Set<Class<? extends RpcGateway>>	extractImplementedRpcGateways(Class<?> clazz) Extracts all RpcGateway interfaces implemented by the given clazz.
static String	getHostname(RpcService rpcService) Returns the hostname onto which the given RpcService has been bound.
static RpcSystem.ForkJoinExecutorConfiguration	getTestForkJoinExecutorConfiguration()
static void	terminateRpcEndpoint(RpcEndpoint rpcEndpoint, org.apache.flink.api.common.time.Time timeout) Shuts the given RpcEndpoint down and awaits its termination.
static void	terminateRpcEndpoints(org.apache.flink.api.common.time.Time timeout, RpcEndpoint... rpcEndpoints) Shuts the given RpcEndpoints down and waits for their termination.
static void	terminateRpcService(RpcService rpcService, org.apache.flink.api.common.time.Time timeout) Shuts the given rpc service down and waits for its termination.
static void	terminateRpcServices(org.apache.flink.api.common.time.Time timeout, RpcService... rpcServices) Shuts the given rpc services down and waits for their termination.

Methods inherited from class java.lang.Object

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

Field Detail

INF_TIMEOUT

public static final org.apache.flink.api.common.time.Time INF_TIMEOUT

HACK: Set to 21474835 seconds, Akka's maximum delay (Akka 2.4.20). The value cannot be higher or an IllegalArgumentException will be thrown during an RPC. Check the private method checkMaxDelay() in akka.actor.LightArrayRevolverScheduler.

INF_DURATION

public static final java.time.Duration INF_DURATION

Method Detail

extractImplementedRpcGateways

public static Set<Class<? extends RpcGateway>> extractImplementedRpcGateways(Class<?> clazz)

Extracts all RpcGateway interfaces implemented by the given clazz.

Parameters:

clazz - from which to extract the implemented RpcGateway interfaces

Returns:

A set of all implemented RpcGateway interfaces

terminateRpcEndpoint

public static void terminateRpcEndpoint(RpcEndpoint rpcEndpoint,
                                        org.apache.flink.api.common.time.Time timeout)
                                 throws ExecutionException,
                                        InterruptedException,
                                        TimeoutException

Shuts the given RpcEndpoint down and awaits its termination.

Parameters:

rpcEndpoint - to terminate

timeout - for this operation

Throws:

ExecutionException - if a problem occurred

InterruptedException - if the operation has been interrupted

TimeoutException - if a timeout occurred

terminateRpcEndpoints

public static void terminateRpcEndpoints(org.apache.flink.api.common.time.Time timeout,
                                         RpcEndpoint... rpcEndpoints)
                                  throws InterruptedException,
                                         ExecutionException,
                                         TimeoutException

Shuts the given RpcEndpoints down and waits for their termination.

Parameters:

rpcEndpoints - to shut down

timeout - for this operation

Throws:

InterruptedException - if the operation has been interrupted

ExecutionException - if a problem occurred

TimeoutException - if a timeout occurred

terminateRpcService

public static void terminateRpcService(RpcService rpcService,
                                       org.apache.flink.api.common.time.Time timeout)
                                throws InterruptedException,
                                       ExecutionException,
                                       TimeoutException

Shuts the given rpc service down and waits for its termination.

Parameters:

rpcService - to shut down

timeout - for this operation

Throws:

InterruptedException - if the operation has been interrupted

ExecutionException - if a problem occurred

TimeoutException - if a timeout occurred

terminateRpcServices

public static void terminateRpcServices(org.apache.flink.api.common.time.Time timeout,
                                        RpcService... rpcServices)
                                 throws InterruptedException,
                                        ExecutionException,
                                        TimeoutException

Shuts the given rpc services down and waits for their termination.

Parameters:

rpcServices - to shut down

timeout - for this operation

Throws:

InterruptedException - if the operation has been interrupted

ExecutionException - if a problem occurred

TimeoutException - if a timeout occurred

getHostname

public static String getHostname(RpcService rpcService)

Returns the hostname onto which the given RpcService has been bound. If the RpcService has been started in local mode, then the hostname is "hostname".

Parameters:

rpcService - to retrieve the hostname for

Returns:

hostname onto which the given RpcService has been bound or localhost

getTestForkJoinExecutorConfiguration

public static RpcSystem.ForkJoinExecutorConfiguration getTestForkJoinExecutorConfiguration()

createRemoteRpcService

public static RpcService createRemoteRpcService(RpcSystem rpcSystem,
                                                org.apache.flink.configuration.Configuration configuration,
                                                @Nullable
                                                String externalAddress,
                                                String externalPortRange,
                                                @Nullable
                                                String bindAddress,
                                                Optional<Integer> bindPort)
                                         throws Exception

Convenient shortcut for constructing a remote RPC Service that takes care of checking for null and empty optionals.

Throws:

Exception

See Also:

RpcSystem.remoteServiceBuilder(Configuration, String, String)