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

类 HsSubpartitionFileReaderImpl

java.lang.Object

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

所有已实现的接口:

Comparable<HsSubpartitionFileReader>, HsDataView, HsSubpartitionFileReader

public class HsSubpartitionFileReaderImpl
extends Object
implements HsSubpartitionFileReader

Default implementation of HsSubpartitionFileReader.

Note: This class is not thread safe.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HsSubpartitionFileReaderImpl.BufferIndexOrError Indicates a buffer with index or an error.
static class	HsSubpartitionFileReaderImpl.Factory Factory of HsSubpartitionFileReader.

构造器概要

构造器

构造器和说明
HsSubpartitionFileReaderImpl(int subpartitionId, FileChannel dataFileChannel, HsSubpartitionViewInternalOperations operations, HsFileDataIndex dataIndex, int maxBufferReadAhead, java.util.function.Consumer<HsSubpartitionFileReader> fileReaderReleaser, ByteBuffer headerBuf)

方法概要

限定符和类型	方法和说明
int	compareTo(HsSubpartitionFileReader that) Provides priority calculation logic for io scheduler.
Optional<ResultSubpartition.BufferAndBacklog>	consumeBuffer(int nextBufferToConsume) Try to consume next buffer.
boolean	equals(Object o)
void	fail(Throwable failureCause) Fail this HsSubpartitionFileReader caused by failureCause.
int	getBacklog() Get the number of buffers backlog.
Deque<HsSubpartitionFileReaderImpl.BufferIndexOrError>	getLoadedBuffers()
int	hashCode()
Buffer.DataType	peekNextToConsumeDataType(int nextBufferToConsume) Get dataType of next buffer to consume.
void	prepareForScheduling() Refresh downstream consumption progress for another round scheduling of reading.
void	readBuffers(Queue<org.apache.flink.core.memory.MemorySegment> buffers, BufferRecycler recycler) Read subpartition data into buffers.
void	releaseDataView() Release this HsDataView when related subpartition view is releasing.

从类继承的方法 java.lang.Object

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

构造器详细资料

HsSubpartitionFileReaderImpl

public HsSubpartitionFileReaderImpl(int subpartitionId,
                                    FileChannel dataFileChannel,
                                    HsSubpartitionViewInternalOperations operations,
                                    HsFileDataIndex dataIndex,
                                    int maxBufferReadAhead,
                                    java.util.function.Consumer<HsSubpartitionFileReader> fileReaderReleaser,
                                    ByteBuffer headerBuf)

方法详细资料

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

readBuffers

public void readBuffers(Queue<org.apache.flink.core.memory.MemorySegment> buffers,
                        BufferRecycler recycler)
                 throws IOException

Read subpartition data into buffers.

This transfers the ownership of used buffers to this class. It's this class' responsibility to release the buffers using the recycler when no longer needed.

Calling this method does not always use up all the provided buffers. It's this class' decision when to stop reading. Currently, it stops reading when: 1) buffers are used up, or 2) reaches the end of the subpartition data within the region, or 3) enough data have been read ahead the downstream consuming offset.

指定者:

readBuffers 在接口中 HsSubpartitionFileReader

参数:

buffers - for reading, note that the ownership of the buffer taken out from the queue is transferred to this class, and the unused buffer must be returned.

recycler - to return buffer to read buffer pool.

抛出:

IOException

fail

public void fail(Throwable failureCause)

从接口复制的说明: HsSubpartitionFileReader

Fail this HsSubpartitionFileReader caused by failureCause.

指定者:

fail 在接口中 HsSubpartitionFileReader

参数:

failureCause - represents the reason why it failed.

prepareForScheduling

public void prepareForScheduling()

Refresh downstream consumption progress for another round scheduling of reading.

指定者:

prepareForScheduling 在接口中 HsSubpartitionFileReader

compareTo

public int compareTo(HsSubpartitionFileReader that)

Provides priority calculation logic for io scheduler.

指定者:

compareTo 在接口中 Comparable<HsSubpartitionFileReader>

getLoadedBuffers

public Deque<HsSubpartitionFileReaderImpl.BufferIndexOrError> getLoadedBuffers()

consumeBuffer

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

从接口复制的说明: HsDataView

Try to consume next buffer.

Only invoked by consumer thread.

指定者:

consumeBuffer 在接口中 HsDataView

参数:

nextBufferToConsume - next buffer index to consume.

返回:

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

抛出:

Throwable

peekNextToConsumeDataType

public Buffer.DataType peekNextToConsumeDataType(int nextBufferToConsume)

从接口复制的说明: HsDataView

Get dataType of next buffer to consume.

指定者:

peekNextToConsumeDataType 在接口中 HsDataView

参数:

nextBufferToConsume - next buffer index to consume

返回:

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

releaseDataView

public void releaseDataView()

从接口复制的说明: HsDataView

Release this HsDataView when related subpartition view is releasing.

指定者:

releaseDataView 在接口中 HsDataView

getBacklog

public int getBacklog()

从接口复制的说明: HsDataView

Get the number of buffers backlog.

指定者:

getBacklog 在接口中 HsDataView

返回:

backlog of this view's corresponding subpartition.