org.apache.flink.runtime.rpc.akka

Class AkkaRpcSystem

java.lang.Object

org.apache.flink.runtime.rpc.akka.AkkaRpcSystem

All Implemented Interfaces:

AutoCloseable, RpcSystem, RpcSystemUtils

public class AkkaRpcSystem
extends Object
implements RpcSystem

RpcSystem implementation based on Akka.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.rpc.RpcSystem

RpcSystem.FixedThreadPoolExecutorConfiguration, RpcSystem.ForkJoinExecutorConfiguration, RpcSystem.RpcServiceBuilder

Constructor Summary

Constructors

Constructor and Description
AkkaRpcSystem()

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	getInetSocketAddressFromRpcUrl(String url) Returns an InetSocketAddress corresponding to the given RPC url.
long	getMaximumMessageSizeInBytes(Configuration config) Returns the maximum number of bytes that an RPC message may carry according to the given configuration.
String	getRpcUrl(String hostname, int port, String endpointName, AddressResolution addressResolution, Configuration config) Constructs an RPC URL for the given parameters, that can be used to connect to the targeted RpcService.
RpcSystem.RpcServiceBuilder	localServiceBuilder(Configuration configuration) Returns a builder for an RpcService that is only reachable from the local machine.
RpcSystem.RpcServiceBuilder	remoteServiceBuilder(Configuration configuration, String externalAddress, String externalPortRange) Returns a builder for an RpcService that is reachable from other machines.

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.RpcSystem

close, load, load

Constructor Detail

AkkaRpcSystem

public AkkaRpcSystem()

Method Detail

localServiceBuilder

public RpcSystem.RpcServiceBuilder localServiceBuilder(Configuration configuration)

Description copied from interface: RpcSystem

Returns a builder for an RpcService that is only reachable from the local machine.

Specified by:

localServiceBuilder in interface RpcSystem

Parameters:

configuration - Flink configuration

Returns:

rpc service builder

remoteServiceBuilder

public RpcSystem.RpcServiceBuilder remoteServiceBuilder(Configuration configuration,
                                                        @Nullable
                                                        String externalAddress,
                                                        String externalPortRange)

Description copied from interface: RpcSystem

Returns a builder for an RpcService that is reachable from other machines.

Specified by:

remoteServiceBuilder in interface RpcSystem

Parameters:

configuration - Flink configuration

externalAddress - optional address under which the RpcService should be reachable

externalPortRange - port range from which 1 port will be chosen under which the RpcService should be reachable

Returns:

rpc service builder

getInetSocketAddressFromRpcUrl

public InetSocketAddress getInetSocketAddressFromRpcUrl(String url)
                                                 throws Exception

Description copied from interface: RpcSystemUtils

Returns an InetSocketAddress corresponding to the given RPC url.

Specified by:

getInetSocketAddressFromRpcUrl in interface RpcSystemUtils

Parameters:

url - RPC url

Returns:

inet socket address

Throws:

Exception - if the URL is invalid

See Also:

RpcSystemUtils.getRpcUrl(java.lang.String, int, java.lang.String, org.apache.flink.runtime.rpc.AddressResolution, org.apache.flink.configuration.Configuration)

getRpcUrl

public String getRpcUrl(String hostname,
                        int port,
                        String endpointName,
                        AddressResolution addressResolution,
                        Configuration config)
                 throws UnknownHostException

Description copied from interface: RpcSystemUtils

Constructs an RPC URL for the given parameters, that can be used to connect to the targeted RpcService.

Specified by:

getRpcUrl in interface RpcSystemUtils

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

getMaximumMessageSizeInBytes

public long getMaximumMessageSizeInBytes(Configuration config)

Description copied from interface: RpcSystemUtils

Returns the maximum number of bytes that an RPC message may carry according to the given configuration. If no limit exists then Long.MAX_VALUE should be returned.

Specified by:

getMaximumMessageSizeInBytes in interface RpcSystemUtils

Parameters:

config - Flink configuration

Returns:

maximum number of bytes that an RPC message may carry