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.

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 RpcService	createRpcService(String hostname, int port, org.apache.flink.configuration.Configuration configuration) Utility method to create RPC service from configuration and hostname, port.
static RpcService	createRpcService(String hostname, String portRangeDefinition, org.apache.flink.configuration.Configuration configuration) Utility method to create RPC service from configuration and hostname, port.
static RpcService	createRpcService(String hostname, String portRangeDefinition, org.apache.flink.configuration.Configuration configuration, String actorSystemName, BootstrapTools.ActorSystemExecutorConfiguration actorSystemExecutorConfiguration) Utility method to create RPC service from configuration and hostname, port.
static long	extractMaximumFramesize(org.apache.flink.configuration.Configuration configuration)
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)

Methods inherited from class java.lang.Object

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

Method Detail

createRpcService

public static RpcService createRpcService(String hostname,
                                          String portRangeDefinition,
                                          org.apache.flink.configuration.Configuration configuration)
                                   throws Exception

Utility method to create RPC service from configuration and hostname, port.

Parameters:

hostname - The hostname/address that describes the TaskManager's data location.

portRangeDefinition - The port range to start TaskManager on.

configuration - The configuration for the TaskManager.

Returns:

The rpc service which is used to start and connect to the TaskManager RpcEndpoint .

Throws:

IOException - Thrown, if the actor system can not bind to the address

Exception - Thrown is some other error occurs while creating akka actor system

createRpcService

public static RpcService createRpcService(String hostname,
                                          int port,
                                          org.apache.flink.configuration.Configuration configuration)
                                   throws Exception

Utility method to create RPC service from configuration and hostname, port.

Parameters:

hostname - The hostname/address that describes the TaskManager's data location.

port - If true, the TaskManager will not initiate the TCP network stack.

configuration - The configuration for the TaskManager.

Returns:

The rpc service which is used to start and connect to the TaskManager RpcEndpoint .

Throws:

IOException - Thrown, if the actor system can not bind to the address

Exception - Thrown is some other error occurs while creating akka actor system

createRpcService

public static RpcService createRpcService(String hostname,
                                          String portRangeDefinition,
                                          org.apache.flink.configuration.Configuration configuration,
                                          String actorSystemName,
                                          @Nonnull
                                          BootstrapTools.ActorSystemExecutorConfiguration actorSystemExecutorConfiguration)
                                   throws Exception

Utility method to create RPC service from configuration and hostname, port.

Parameters:

hostname - The hostname/address that describes the TaskManager's data location.

portRangeDefinition - The port range to start TaskManager on.

configuration - The configuration for the TaskManager.

actorSystemName - The actor system name of the RpcService.

actorSystemExecutorConfiguration - The configuration of the executor of the actor system.

Returns:

The rpc service which is used to start and connect to the TaskManager RpcEndpoint .

Throws:

IOException - Thrown, if the actor system can not bind to the address

Exception - Thrown is some other error occurs while creating akka actor system

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

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

extractMaximumFramesize

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