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.

Constructor Summary

Constructors

Constructor and Description
PipelinedSubpartitionView(PipelinedSubpartition parent, BufferAvailabilityListener listener)

Method Summary

Modifier and Type	Method and Description
Throwable	getFailureCause()
ResultSubpartition.BufferAndBacklog	getNextBuffer() Returns the next Buffer instance of this queue iterator.
boolean	isAvailable(int numCreditsAvailable)
boolean	isReleased()
void	notifyDataAvailable()
void	notifyPriorityEvent(int priorityBufferNumber)
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

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

isAvailable

public boolean isAvailable(int numCreditsAvailable)

Specified by:

isAvailable in interface ResultSubpartitionView

getFailureCause

public Throwable getFailureCause()

Specified by:

getFailureCause in interface ResultSubpartitionView

unsynchronizedGetNumberOfQueuedBuffers

public int unsynchronizedGetNumberOfQueuedBuffers()

Specified by:

unsynchronizedGetNumberOfQueuedBuffers in interface ResultSubpartitionView

toString

public String toString()

Overrides:

toString in class Object