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

类 HsSubpartitionConsumer

java.lang.Object

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

所有已实现的接口:

HsSubpartitionConsumerInternalOperations, ResultSubpartitionView

public class HsSubpartitionConsumer
extends Object
implements ResultSubpartitionView, HsSubpartitionConsumerInternalOperations

The read view of HsResultPartition, data can be read from memory or disk.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.runtime.io.network.partition.ResultSubpartitionView

ResultSubpartitionView.AvailabilityWithBacklog

构造器概要

构造器

构造器和说明
HsSubpartitionConsumer(BufferAvailabilityListener availabilityListener)

方法概要

限定符和类型	方法和说明
void	acknowledgeAllDataProcessed()
ResultSubpartitionView.AvailabilityWithBacklog	getAvailabilityAndBacklog(boolean isCreditAvailable) Get the availability and backlog of the view.
int	getConsumingOffset(boolean withLock) Get the latest consuming offset of the subpartition.
Throwable	getFailureCause() ResultSubpartitionView can decide whether the failure cause should be reported to consumer as failure (primary failure) or ProducerFailedException (secondary failure).
ResultSubpartition.BufferAndBacklog	getNextBuffer() Returns the next Buffer instance of this queue iterator.
int	getNumberOfQueuedBuffers()
boolean	isReleased()
void	notifyDataAvailable() Callback for new data become available.
void	notifyNewBufferSize(int newBufferSize)
int	peekNextBufferSubpartitionId() Returns the index of the subpartition where the next buffer locates, or -1 if there is no buffer available and the subpartition to be consumed is not determined.
void	releaseAllResources()
void	resumeConsumption()
int	unsynchronizedGetNumberOfQueuedBuffers()

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

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

从接口继承的方法 org.apache.flink.runtime.io.network.partition.ResultSubpartitionView

notifyPriorityEvent, notifyRequiredSegmentId

构造器详细资料

HsSubpartitionConsumer

public HsSubpartitionConsumer(BufferAvailabilityListener availabilityListener)

方法详细资料

getNextBuffer

@Nullable
public ResultSubpartition.BufferAndBacklog getNextBuffer()

从接口复制的说明: ResultSubpartitionView

Returns the next Buffer instance of this queue iterator.

If there is currently no instance available, it will return null. This might happen for example when a pipelined queue producer is slower than the consumer or a spilled queue needs to read in more data.

Important: The consumer has to make sure that each buffer instance will eventually be recycled with Buffer.recycleBuffer() after it has been consumed.

指定者:

getNextBuffer 在接口中 ResultSubpartitionView

notifyDataAvailable

public void notifyDataAvailable()

从接口复制的说明: HsSubpartitionConsumerInternalOperations

Callback for new data become available.

指定者:

notifyDataAvailable 在接口中 HsSubpartitionConsumerInternalOperations

指定者:

notifyDataAvailable 在接口中 ResultSubpartitionView

getAvailabilityAndBacklog

public ResultSubpartitionView.AvailabilityWithBacklog getAvailabilityAndBacklog(boolean isCreditAvailable)

从接口复制的说明: ResultSubpartitionView

Get the availability and backlog of the view. The availability represents if the view is ready to get buffer from it. The backlog represents the number of available data buffers.

指定者:

getAvailabilityAndBacklog 在接口中 ResultSubpartitionView

参数:

isCreditAvailable - the availability of credits for this ResultSubpartitionView.

返回:

availability and backlog.

releaseAllResources

public void releaseAllResources()
                         throws IOException

指定者:

releaseAllResources 在接口中 ResultSubpartitionView

抛出:

IOException

isReleased

public boolean isReleased()

指定者:

isReleased 在接口中 ResultSubpartitionView

getConsumingOffset

public int getConsumingOffset(boolean withLock)

从接口复制的说明: HsSubpartitionConsumerInternalOperations

Get the latest consuming offset of the subpartition.

指定者:

getConsumingOffset 在接口中 HsSubpartitionConsumerInternalOperations

参数:

withLock - If true, read the consuming offset outside the guarding of lock. This is sometimes desired to avoid lock contention, if the caller does not depend on any other states to change atomically with the consuming offset.

返回:

latest consuming offset.

getFailureCause

public Throwable getFailureCause()

从接口复制的说明: ResultSubpartitionView

ResultSubpartitionView can decide whether the failure cause should be reported to consumer as failure (primary failure) or ProducerFailedException (secondary failure). Secondary failure can be reported only if producer (upstream task) is guaranteed to failover.

BEWARE: Incorrectly reporting failure cause as primary failure, can hide the root cause of the failure from the user.

指定者:

getFailureCause 在接口中 ResultSubpartitionView

resumeConsumption

public void resumeConsumption()

指定者:

resumeConsumption 在接口中 ResultSubpartitionView

acknowledgeAllDataProcessed

public void acknowledgeAllDataProcessed()

指定者:

acknowledgeAllDataProcessed 在接口中 ResultSubpartitionView

unsynchronizedGetNumberOfQueuedBuffers

public int unsynchronizedGetNumberOfQueuedBuffers()

指定者:

unsynchronizedGetNumberOfQueuedBuffers 在接口中 ResultSubpartitionView

getNumberOfQueuedBuffers

public int getNumberOfQueuedBuffers()

指定者:

getNumberOfQueuedBuffers 在接口中 ResultSubpartitionView

notifyNewBufferSize

public void notifyNewBufferSize(int newBufferSize)

指定者:

notifyNewBufferSize 在接口中 ResultSubpartitionView

peekNextBufferSubpartitionId

public int peekNextBufferSubpartitionId()

从接口复制的说明: ResultSubpartitionView

Returns the index of the subpartition where the next buffer locates, or -1 if there is no buffer available and the subpartition to be consumed is not determined.

指定者:

peekNextBufferSubpartitionId 在接口中 ResultSubpartitionView