org.apache.flink.runtime.rpc.akka

Class AkkaRpcServiceUtils

java.lang.Object

org.apache.flink.runtime.rpc.akka.AkkaRpcServiceUtils

public class AkkaRpcServiceUtils
extends Object

These RPC utilities contain helper methods around RPC use, such as starting an RPC service, or constructing RPC addresses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AkkaRpcServiceUtils.AkkaProtocol Whether to use TCP or encrypted TCP for Akka.
static class	AkkaRpcServiceUtils.AkkaRpcServiceBuilder Builder for AkkaRpcService.

Method Summary

Modifier and Type	Method and Description
static String	createRandomName(String prefix) Creates a random name of the form prefix_X, where X is an increasing number.
static AkkaRpcService	createRemoteRpcService(org.apache.flink.configuration.Configuration configuration, String externalAddress, String externalPortRange, String bindAddress, Optional<Integer> bindPort)
static String	createWildcardName(String prefix) Creates a wildcard name symmetric to createRandomName(String).
static long	extractMaximumFramesize(org.apache.flink.configuration.Configuration configuration)
static String	getLocalRpcUrl(String endpointName)
static String	getRpcUrl(String hostname, int port, String endpointName, HighAvailabilityServicesUtils.AddressResolution addressResolution, AkkaRpcServiceUtils.AkkaProtocol akkaProtocol)
static String	getRpcUrl(String hostname, int port, String endpointName, HighAvailabilityServicesUtils.AddressResolution addressResolution, org.apache.flink.configuration.Configuration config)
static AkkaRpcServiceUtils.AkkaRpcServiceBuilder	localServiceBuilder(org.apache.flink.configuration.Configuration configuration)
static AkkaRpcServiceUtils.AkkaRpcServiceBuilder	remoteServiceBuilder(org.apache.flink.configuration.Configuration configuration, String externalAddress, int externalPort)
static AkkaRpcServiceUtils.AkkaRpcServiceBuilder	remoteServiceBuilder(org.apache.flink.configuration.Configuration configuration, String externalAddress, String externalPortRange)

Methods inherited from class java.lang.Object

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

Method Detail

createRemoteRpcService

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

Throws:

Exception

remoteServiceBuilder

public static AkkaRpcServiceUtils.AkkaRpcServiceBuilder remoteServiceBuilder(org.apache.flink.configuration.Configuration configuration,
                                                                             @Nullable
                                                                             String externalAddress,
                                                                             String externalPortRange)

remoteServiceBuilder

@VisibleForTesting
public static AkkaRpcServiceUtils.AkkaRpcServiceBuilder remoteServiceBuilder(org.apache.flink.configuration.Configuration configuration,
                                                                                                @Nullable
                                                                                                String externalAddress,
                                                                                                int externalPort)

localServiceBuilder

public static AkkaRpcServiceUtils.AkkaRpcServiceBuilder localServiceBuilder(org.apache.flink.configuration.Configuration configuration)

getRpcUrl

public static String getRpcUrl(String hostname,
                               int port,
                               String endpointName,
                               HighAvailabilityServicesUtils.AddressResolution addressResolution,
                               org.apache.flink.configuration.Configuration config)
                        throws UnknownHostException

Parameters:

hostname - The hostname or address where the target RPC service is listening.

port - The port where the target RPC service is listening.

endpointName - The name of the RPC endpoint.

addressResolution - Whether to try address resolution of the given hostname or not. This allows to fail fast in case that the hostname cannot be resolved.

config - The configuration from which to deduce further settings.

Returns:

The RPC URL of the specified RPC endpoint.

Throws:

UnknownHostException

getRpcUrl

public static String getRpcUrl(String hostname,
                               int port,
                               String endpointName,
                               HighAvailabilityServicesUtils.AddressResolution addressResolution,
                               AkkaRpcServiceUtils.AkkaProtocol akkaProtocol)
                        throws UnknownHostException

Parameters:

hostname - The hostname or address where the target RPC service is listening.

port - The port where the target RPC service is listening.

endpointName - The name of the RPC endpoint.

addressResolution - Whether to try address resolution of the given hostname or not. This allows to fail fast in case that the hostname cannot be resolved.

akkaProtocol - True, if security/encryption is enabled, false otherwise.

Returns:

The RPC URL of the specified RPC endpoint.

Throws:

UnknownHostException

getLocalRpcUrl

public static String getLocalRpcUrl(String endpointName)

createRandomName

public static String createRandomName(String prefix)

Creates a random name of the form prefix_X, where X is an increasing number.

Parameters:

prefix - Prefix string to prepend to the monotonically increasing name offset number

Returns:

A random name of the form prefix_X where X is an increasing number

createWildcardName

public static String createWildcardName(String prefix)

Creates a wildcard name symmetric to createRandomName(String).

Parameters:

prefix - prefix of the wildcard name

Returns:

wildcard name starting with the prefix

extractMaximumFramesize

public static long extractMaximumFramesize(org.apache.flink.configuration.Configuration configuration)