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

接口 DataBuffer

所有已知实现类:

HashBasedDataBuffer, SortBasedDataBuffer

public interface DataBuffer

Data of different channels can be appended to a DataBuffer and after the DataBuffer is full or finished, the appended data can be copied from it in channel index order.

The lifecycle of a DataBuffer can be: new, write, [read, reset, write], finish, read, release. There can be multiple [read, reset, write] operations before finish.

方法概要

限定符和类型	方法和说明
boolean	append(ByteBuffer source, int targetChannel, Buffer.DataType dataType) Appends data of the specified channel to this DataBuffer and returns true if this DataBuffer is full.
void	finish() Finishes this DataBuffer which means no record can be appended any more.
BufferWithChannel	getNextBuffer(org.apache.flink.core.memory.MemorySegment transitBuffer) Copies data in this DataBuffer to the target MemorySegment in channel index order and returns BufferWithChannel which contains the copied data and the corresponding channel index.
boolean	hasRemaining() Returns true if not all data appended to this DataBuffer is consumed.
boolean	isFinished() Whether this DataBuffer is finished or not.
boolean	isReleased() Whether this DataBuffer is released or not.
long	numTotalBytes() Returns the total number of bytes written to this DataBuffer.
long	numTotalRecords() Returns the total number of records written to this DataBuffer.
void	release() Releases this DataBuffer which releases all resources.
void	reset() Resets this DataBuffer to be reused for data appending.

方法详细资料

append

boolean append(ByteBuffer source,
               int targetChannel,
               Buffer.DataType dataType)
        throws IOException

Appends data of the specified channel to this DataBuffer and returns true if this DataBuffer is full.

抛出:

IOException

getNextBuffer

BufferWithChannel getNextBuffer(@Nullable
                                org.apache.flink.core.memory.MemorySegment transitBuffer)

Copies data in this DataBuffer to the target MemorySegment in channel index order and returns BufferWithChannel which contains the copied data and the corresponding channel index.

numTotalRecords

long numTotalRecords()

Returns the total number of records written to this DataBuffer.

numTotalBytes

long numTotalBytes()

Returns the total number of bytes written to this DataBuffer.

hasRemaining

boolean hasRemaining()

Returns true if not all data appended to this DataBuffer is consumed.

reset

void reset()

Resets this DataBuffer to be reused for data appending.

finish

void finish()

Finishes this DataBuffer which means no record can be appended any more.

isFinished

boolean isFinished()

Whether this DataBuffer is finished or not.

release

void release()

Releases this DataBuffer which releases all resources.

isReleased

boolean isReleased()

Whether this DataBuffer is released or not.