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

Class HsSubpartitionConsumerMemoryDataManager

java.lang.Object

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

All Implemented Interfaces:

HsDataView

public class HsSubpartitionConsumerMemoryDataManager
extends Object
implements HsDataView

This class is responsible for managing the data of a single consumer. HsSubpartitionMemoryDataManager will create a new HsSubpartitionConsumerMemoryDataManager when a consumer is registered.

Constructor Summary

Constructors

Constructor	Description
HsSubpartitionConsumerMemoryDataManager(Lock resultPartitionLock, Lock consumerLock, int subpartitionId, HsConsumerId consumerId, HsMemoryDataManagerOperation memoryDataManagerOperation)

Method Summary

Modifier and Type	Method	Description
boolean	addBuffer(HsBufferContext bufferContext)
void	addInitialBuffers(Deque<HsBufferContext> buffers)
Optional<ResultSubpartition.BufferAndBacklog>	consumeBuffer(int toConsumeIndex, Collection<Buffer> buffersToRecycle)	Check whether the head of unConsumedBuffers is the buffer to be consumed.
int	getBacklog()	Get the number of buffers whose Buffer.DataType is buffer.
Buffer.DataType	peekNextToConsumeDataType(int nextToConsumeIndex, Collection<Buffer> buffersToRecycle)	Check whether the head of unConsumedBuffers is the buffer to be consumed next time.
void	releaseDataView()	Release this HsDataView when related subpartition view is releasing.

Methods inherited from class java.lang.Object

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

Constructor Detail

HsSubpartitionConsumerMemoryDataManager

public HsSubpartitionConsumerMemoryDataManager(Lock resultPartitionLock,
                                               Lock consumerLock,
                                               int subpartitionId,
                                               HsConsumerId consumerId,
                                               HsMemoryDataManagerOperation memoryDataManagerOperation)

Method Detail

addInitialBuffers

public void addInitialBuffers(Deque<HsBufferContext> buffers)

addBuffer

public boolean addBuffer(HsBufferContext bufferContext)

consumeBuffer

public Optional<ResultSubpartition.BufferAndBacklog> consumeBuffer(int toConsumeIndex,
                                                                   Collection<Buffer> buffersToRecycle)

Check whether the head of unConsumedBuffers is the buffer to be consumed. If so, return the buffer and backlog.

Specified by:

consumeBuffer in interface HsDataView

Parameters:

toConsumeIndex - index of buffer to be consumed.

buffersToRecycle - buffers to recycle if needed.

Returns:

If the head of unConsumedBuffers is target, return optional of the buffer and backlog. Otherwise, return Optional.empty().

peekNextToConsumeDataType

public Buffer.DataType peekNextToConsumeDataType(int nextToConsumeIndex,
                                                 Collection<Buffer> buffersToRecycle)

Check whether the head of unConsumedBuffers is the buffer to be consumed next time. If so, return the next buffer's data type.

Specified by:

peekNextToConsumeDataType in interface HsDataView

Parameters:

nextToConsumeIndex - index of the buffer to be consumed next time.

buffersToRecycle - buffers to recycle if needed.

Returns:

If the head of unConsumedBuffers is target, return the buffer's data type. Otherwise, return Buffer.DataType.NONE.

getBacklog

public int getBacklog()

Description copied from interface: HsDataView

Get the number of buffers whose Buffer.DataType is buffer.

Specified by:

getBacklog in interface HsDataView

Returns:

backlog of this view's corresponding subpartition.

releaseDataView

public void releaseDataView()

Description copied from interface: HsDataView

Release this HsDataView when related subpartition view is releasing.

Specified by:

releaseDataView in interface HsDataView