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

Class PipelinedSubpartitionView

java.lang.Object

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

All Implemented Interfaces:

ResultSubpartitionView

Direct Known Subclasses:

PipelinedApproximateSubpartitionView

public class PipelinedSubpartitionView
extends Object
implements ResultSubpartitionView

View over a pipelined in-memory only subpartition.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.partition.ResultSubpartitionView

ResultSubpartitionView.AvailabilityWithBacklog

Constructor Summary

Constructors

Constructor and Description
PipelinedSubpartitionView(PipelinedSubpartition parent, BufferAvailabilityListener listener)

Method Summary

Modifier and Type	Method and Description
void	acknowledgeAllDataProcessed()
ResultSubpartitionView.AvailabilityWithBacklog	getAvailabilityAndBacklog(boolean isCreditAvailable) Get the availability and backlog of the view.
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()
void	notifyNewBufferSize(int newBufferSize)
void	notifyPriorityEvent(int priorityBufferNumber)
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()
String	toString()
int	unsynchronizedGetNumberOfQueuedBuffers()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.io.network.partition.ResultSubpartitionView

notifyRequiredSegmentId

Constructor Detail

PipelinedSubpartitionView

public PipelinedSubpartitionView(PipelinedSubpartition parent,
                                 BufferAvailabilityListener listener)

Method Detail

getNextBuffer

@Nullable
public ResultSubpartition.BufferAndBacklog getNextBuffer()

Description copied from interface: 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.

Specified by:

getNextBuffer in interface ResultSubpartitionView

notifyDataAvailable

public void notifyDataAvailable()

Specified by:

notifyDataAvailable in interface ResultSubpartitionView

notifyPriorityEvent

public void notifyPriorityEvent(int priorityBufferNumber)

Specified by:

notifyPriorityEvent in interface ResultSubpartitionView

releaseAllResources

public void releaseAllResources()

Specified by:

releaseAllResources in interface ResultSubpartitionView

isReleased

public boolean isReleased()

Specified by:

isReleased in interface ResultSubpartitionView

resumeConsumption

public void resumeConsumption()

Specified by:

resumeConsumption in interface ResultSubpartitionView

acknowledgeAllDataProcessed

public void acknowledgeAllDataProcessed()

Specified by:

acknowledgeAllDataProcessed in interface ResultSubpartitionView

getAvailabilityAndBacklog

public ResultSubpartitionView.AvailabilityWithBacklog getAvailabilityAndBacklog(boolean isCreditAvailable)

Description copied from interface: 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.

Specified by:

getAvailabilityAndBacklog in interface ResultSubpartitionView

Parameters:

isCreditAvailable - the availability of credits for this ResultSubpartitionView.

Returns:

availability and backlog.

getFailureCause

public Throwable getFailureCause()

Description copied from interface: 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.

Specified by:

getFailureCause in interface ResultSubpartitionView

unsynchronizedGetNumberOfQueuedBuffers

public int unsynchronizedGetNumberOfQueuedBuffers()

Specified by:

unsynchronizedGetNumberOfQueuedBuffers in interface ResultSubpartitionView

getNumberOfQueuedBuffers

public int getNumberOfQueuedBuffers()

Specified by:

getNumberOfQueuedBuffers in interface ResultSubpartitionView

notifyNewBufferSize

public void notifyNewBufferSize(int newBufferSize)

Specified by:

notifyNewBufferSize in interface ResultSubpartitionView

peekNextBufferSubpartitionId

public int peekNextBufferSubpartitionId()

Description copied from interface: 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.

Specified by:

peekNextBufferSubpartitionId in interface ResultSubpartitionView

toString

public String toString()

Overrides:

toString in class Object