org.apache.flink.runtime.taskexecutor

Class TaskManagerServicesConfiguration

java.lang.Object

org.apache.flink.runtime.taskexecutor.TaskManagerServicesConfiguration

public class TaskManagerServicesConfiguration
extends Object

Configuration for the task manager services such as the network environment, the memory manager, the io manager and the metric registry.

Constructor Summary

Constructors

Constructor and Description

TaskManagerServicesConfiguration(InetAddress taskManagerAddress, String[] tmpDirPaths, String[] localRecoveryStateRootDirectories, boolean localRecoveryEnabled, NetworkEnvironmentConfiguration networkConfig, QueryableStateConfiguration queryableStateConfig, int numberOfSlots, long configuredMemory, MemoryType memoryType, boolean preAllocateMemory, float memoryFraction, long timerServiceShutdownTimeout)

Method Summary

Modifier and Type	Method and Description
protected static void	checkNetworkBufferConfig(int pageSize, float networkBufFraction, long networkBufMin, long networkBufMax) Validates the (new) network buffer configuration.
protected static void	checkNetworkConfigOld(int numNetworkBuffers) Validates the (old) network buffer configuration.
static TaskManagerServicesConfiguration	fromConfiguration(Configuration configuration, InetAddress remoteAddress, boolean localCommunication) Utility method to extract TaskManager config parameters from the configuration and to sanity check them.
long	getConfiguredMemory() Returns the size of the managed memory (in megabytes), if configured.
String[]	getLocalRecoveryStateRootDirectories()
float	getMemoryFraction()
MemoryType	getMemoryType() Returns the memory type to use.
NetworkEnvironmentConfiguration	getNetworkConfig()
int	getNumberOfSlots()
QueryableStateConfiguration	getQueryableStateConfig()
InetAddress	getTaskManagerAddress()
long	getTimerServiceShutdownTimeout()
String[]	getTmpDirPaths()
static boolean	hasNewNetworkBufConf(Configuration config) Returns whether the new network buffer memory configuration is present in the configuration object, i.e.
boolean	isLocalRecoveryEnabled()
boolean	isPreAllocateMemory()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskManagerServicesConfiguration

public TaskManagerServicesConfiguration(InetAddress taskManagerAddress,
                                        String[] tmpDirPaths,
                                        String[] localRecoveryStateRootDirectories,
                                        boolean localRecoveryEnabled,
                                        NetworkEnvironmentConfiguration networkConfig,
                                        QueryableStateConfiguration queryableStateConfig,
                                        int numberOfSlots,
                                        long configuredMemory,
                                        MemoryType memoryType,
                                        boolean preAllocateMemory,
                                        float memoryFraction,
                                        long timerServiceShutdownTimeout)

Method Detail

getTaskManagerAddress

public InetAddress getTaskManagerAddress()

getTmpDirPaths

public String[] getTmpDirPaths()

getLocalRecoveryStateRootDirectories

public String[] getLocalRecoveryStateRootDirectories()

isLocalRecoveryEnabled

public boolean isLocalRecoveryEnabled()

getNetworkConfig

public NetworkEnvironmentConfiguration getNetworkConfig()

getQueryableStateConfig

public QueryableStateConfiguration getQueryableStateConfig()

getNumberOfSlots

public int getNumberOfSlots()

getMemoryFraction

public float getMemoryFraction()

getMemoryType

public MemoryType getMemoryType()

Returns the memory type to use.

Returns:

on-heap or off-heap memory

getConfiguredMemory

public long getConfiguredMemory()

Returns the size of the managed memory (in megabytes), if configured.

Returns:

managed memory or a default value (currently -1) if not configured

See Also:

TaskManagerOptions.MANAGED_MEMORY_SIZE

isPreAllocateMemory

public boolean isPreAllocateMemory()

getTimerServiceShutdownTimeout

public long getTimerServiceShutdownTimeout()

fromConfiguration

public static TaskManagerServicesConfiguration fromConfiguration(Configuration configuration,
                                                                 InetAddress remoteAddress,
                                                                 boolean localCommunication)
                                                          throws Exception

Utility method to extract TaskManager config parameters from the configuration and to sanity check them.

Parameters:

configuration - The configuration.

remoteAddress - identifying the IP address under which the TaskManager will be accessible

localCommunication - True, to skip initializing the network stack. Use only in cases where only one task manager runs.

Returns:

TaskExecutorConfiguration that wrappers InstanceConnectionInfo, NetworkEnvironmentConfiguration, etc.

Throws:

Exception

checkNetworkConfigOld

protected static void checkNetworkConfigOld(int numNetworkBuffers)

Validates the (old) network buffer configuration.

Parameters:

numNetworkBuffers - number of buffers used in the network stack

Throws:

IllegalConfigurationException - if the condition does not hold

checkNetworkBufferConfig

protected static void checkNetworkBufferConfig(int pageSize,
                                               float networkBufFraction,
                                               long networkBufMin,
                                               long networkBufMax)
                                        throws IllegalConfigurationException

Validates the (new) network buffer configuration.

Parameters:

pageSize - size of memory buffers

networkBufFraction - fraction of JVM memory to use for network buffers

networkBufMin - minimum memory size for network buffers (in bytes)

networkBufMax - maximum memory size for network buffers (in bytes)

Throws:

IllegalConfigurationException - if the condition does not hold

hasNewNetworkBufConf

public static boolean hasNewNetworkBufConf(Configuration config)

Returns whether the new network buffer memory configuration is present in the configuration object, i.e. at least one new parameter is given or the old one is not present.

Parameters:

config - configuration object

Returns:

true if the new configuration method is used, false otherwise