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

Interface HsDataView

All Known Subinterfaces:

HsSubpartitionFileReader

All Known Implementing Classes:

HsSubpartitionFileReaderImpl, HsSubpartitionMemoryDataManager

public interface HsDataView

A view for HsSubpartitionView to find out what data exists in memory or disk and polling the data.

Method Summary

Modifier and Type	Method and Description
Optional<ResultSubpartition.BufferAndBacklog>	consumeBuffer(int nextBufferToConsume) Try to consume next buffer.
int	getBacklog() Get the number of buffers backlog.
Buffer.DataType	peekNextToConsumeDataType(int nextBufferToConsume) Get dataType of next buffer to consume.
void	releaseDataView() Release this HsDataView when related subpartition view is releasing.

Method Detail

consumeBuffer

Optional<ResultSubpartition.BufferAndBacklog> consumeBuffer(int nextBufferToConsume)
                                                     throws Throwable

Try to consume next buffer.

Only invoked by consumer thread.

Parameters:

nextBufferToConsume - next buffer index to consume.

Returns:

If the target buffer does exist, return buffer and next buffer's backlog, otherwise return Optional.empty().

Throws:

Throwable

peekNextToConsumeDataType

Buffer.DataType peekNextToConsumeDataType(int nextBufferToConsume)

Get dataType of next buffer to consume.

Parameters:

nextBufferToConsume - next buffer index to consume

Returns:

next buffer's dataType. If not found in memory, return Buffer.DataType.NONE.

getBacklog

int getBacklog()

Get the number of buffers backlog.

Returns:

backlog of this view's corresponding subpartition.

releaseDataView

void releaseDataView()

Release this HsDataView when related subpartition view is releasing.