org.apache.flink.runtime.io.network.partition

Enum BoundedBlockingSubpartitionType

java.lang.Object

java.lang.Enum<BoundedBlockingSubpartitionType>

org.apache.flink.runtime.io.network.partition.BoundedBlockingSubpartitionType

All Implemented Interfaces:

Serializable, Comparable<BoundedBlockingSubpartitionType>

public enum BoundedBlockingSubpartitionType
extends Enum<BoundedBlockingSubpartitionType>

The type of the BoundedBlockingSubpartition. Also doubles as the factory.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Selects the BoundedBlockingSubpartition type based on the current memory architecture.
FILE A BoundedBlockingSubpartition type that simply stores the partition data in a file.
FILE_MMAP Creates a BoundedBlockingSubpartition that stores the partition data in a file and memory maps that file for reading.
MMAP A BoundedBlockingSubpartition type that stores the partition data in memory mapped file.

Method Summary

Modifier and Type	Method and Description
abstract org.apache.flink.runtime.io.network.partition.BoundedBlockingSubpartition	create(int index, ResultPartition parent, File tempFile, int readBufferSize, boolean sslEnabled) Creates BoundedBlockingSubpartition of this type.
static BoundedBlockingSubpartitionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoundedBlockingSubpartitionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FILE

public static final BoundedBlockingSubpartitionType FILE

A BoundedBlockingSubpartition type that simply stores the partition data in a file. Data is eagerly spilled (written to disk) and readers directly read from the file.

MMAP

public static final BoundedBlockingSubpartitionType MMAP

A BoundedBlockingSubpartition type that stores the partition data in memory mapped file. Data is written to and read from the mapped memory region. Disk spilling happens lazily, when the OS swaps out the pages from the memory mapped file.

FILE_MMAP

public static final BoundedBlockingSubpartitionType FILE_MMAP

Creates a BoundedBlockingSubpartition that stores the partition data in a file and memory maps that file for reading. Data is eagerly spilled (written to disk) and then mapped into memory. The main difference to the MMAP variant is that no I/O is necessary when pages from the memory mapped file are evicted.

AUTO

public static final BoundedBlockingSubpartitionType AUTO

Selects the BoundedBlockingSubpartition type based on the current memory architecture. If 64-bit, the type of FILE_MMAP is recommended. Otherwise, the type of FILE is by default.

Method Detail

values

public static BoundedBlockingSubpartitionType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BoundedBlockingSubpartitionType c : BoundedBlockingSubpartitionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoundedBlockingSubpartitionType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

create

public abstract org.apache.flink.runtime.io.network.partition.BoundedBlockingSubpartition create(int index,
                                                                                                 ResultPartition parent,
                                                                                                 File tempFile,
                                                                                                 int readBufferSize,
                                                                                                 boolean sslEnabled)
                                                                                          throws IOException

Creates BoundedBlockingSubpartition of this type.

Throws:

IOException