Package org.apache.flink.runtime.io.network.partition.hybrid.index

Class FileRegionWriteReadUtils

java.lang.Object

org.apache.flink.runtime.io.network.partition.hybrid.index.FileRegionWriteReadUtils

public class FileRegionWriteReadUtils
extends Object

Utils for read and write FileDataIndexRegionHelper.Region.

Constructor Summary

Constructors

Constructor	Description
FileRegionWriteReadUtils()

Method Summary

Modifier and Type	Method	Description
static ByteBuffer	allocateAndConfigureBuffer(int bufferSize)	Allocate a buffer with specific size and configure it to native order.
static ProducerMergedPartitionFileIndex.FixedSizeRegion	readFixedSizeRegionFromFile(FileChannel channel, ByteBuffer regionBuffer, long fileOffset)	Read ProducerMergedPartitionFileIndex.FixedSizeRegion from FileChannel.
static HsFileDataIndexImpl.InternalRegion	readHsInternalRegionFromFile(FileChannel channel, ByteBuffer headerBuffer, long fileOffset)	Read HsFileDataIndexImpl.InternalRegion from FileChannel.
static void	writeFixedSizeRegionToFile(FileChannel channel, ByteBuffer regionBuffer, FileDataIndexRegionHelper.Region region)	Write ProducerMergedPartitionFileIndex.FixedSizeRegion to FileChannel.
static void	writeHsInternalRegionToFile(FileChannel channel, ByteBuffer headerBuffer, HsFileDataIndexImpl.InternalRegion region)	Write HsFileDataIndexImpl.InternalRegion to FileChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRegionWriteReadUtils

public FileRegionWriteReadUtils()

Method Detail

allocateAndConfigureBuffer

public static ByteBuffer allocateAndConfigureBuffer(int bufferSize)

Allocate a buffer with specific size and configure it to native order.

Parameters:

bufferSize - the size of buffer to allocate.

Returns:

a native order buffer with expected size.

writeHsInternalRegionToFile

public static void writeHsInternalRegionToFile(FileChannel channel,
                                               ByteBuffer headerBuffer,
                                               HsFileDataIndexImpl.InternalRegion region)
                                        throws IOException

Write HsFileDataIndexImpl.InternalRegion to FileChannel.

Note that this type of region's length may be variable because it contains an array to indicate each buffer's release state.

Parameters:

channel - the file's channel to write.

headerBuffer - the buffer to write HsFileDataIndexImpl.InternalRegion's header.

region - the region to be written to channel.

Throws:

IOException

readHsInternalRegionFromFile

public static HsFileDataIndexImpl.InternalRegion readHsInternalRegionFromFile(FileChannel channel,
                                                                              ByteBuffer headerBuffer,
                                                                              long fileOffset)
                                                                       throws IOException

Read HsFileDataIndexImpl.InternalRegion from FileChannel.

Note that this type of region's length may be variable because it contains an array to indicate each buffer's release state.

Parameters:

channel - the channel to read.

headerBuffer - the buffer to read HsFileDataIndexImpl.InternalRegion's header.

fileOffset - the file offset to start read.

Returns:

the HsFileDataIndexImpl.InternalRegion that read from this channel.

Throws:

IOException

writeFixedSizeRegionToFile

public static void writeFixedSizeRegionToFile(FileChannel channel,
                                              ByteBuffer regionBuffer,
                                              FileDataIndexRegionHelper.Region region)
                                       throws IOException

Write ProducerMergedPartitionFileIndex.FixedSizeRegion to FileChannel.

Note that this type of region's length is fixed.

Parameters:

channel - the file's channel to write.

regionBuffer - the buffer to write ProducerMergedPartitionFileIndex.FixedSizeRegion's header.

region - the region to be written to channel.

Throws:

IOException

readFixedSizeRegionFromFile

public static ProducerMergedPartitionFileIndex.FixedSizeRegion readFixedSizeRegionFromFile(FileChannel channel,
                                                                                           ByteBuffer regionBuffer,
                                                                                           long fileOffset)
                                                                                    throws IOException

Read ProducerMergedPartitionFileIndex.FixedSizeRegion from FileChannel.

Note that this type of region's length is fixed.

Parameters:

channel - the channel to read.

regionBuffer - the buffer to read ProducerMergedPartitionFileIndex.FixedSizeRegion's header.

fileOffset - the file offset to start read.

Returns:

the ProducerMergedPartitionFileIndex.FixedSizeRegion that read from this channel.

Throws:

IOException