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

Interface ResultSubpartitionView

public interface ResultSubpartitionView

A view to consume a ResultSubpartition instance.

Method Summary

Modifier and Type	Method and Description
Throwable	getFailureCause()
ResultSubpartition.BufferAndBacklog	getNextBuffer() Returns the next Buffer instance of this queue iterator.
boolean	isAvailable()
boolean	isReleased()
boolean	nextBufferIsEvent() Returns whether the next buffer is an event or not.
void	notifyDataAvailable()
void	notifySubpartitionConsumed()
void	releaseAllResources()

Method Detail

getNextBuffer

@Nullable
ResultSubpartition.BufferAndBacklog getNextBuffer()
                                                     throws IOException,
                                                            InterruptedException

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.

Throws:

IOException

InterruptedException

notifyDataAvailable

void notifyDataAvailable()

releaseAllResources

void releaseAllResources()
                  throws IOException

Throws:

IOException

notifySubpartitionConsumed

void notifySubpartitionConsumed()
                         throws IOException

Throws:

IOException

isReleased

boolean isReleased()

getFailureCause

Throwable getFailureCause()

nextBufferIsEvent

boolean nextBufferIsEvent()

Returns whether the next buffer is an event or not.

isAvailable

boolean isAvailable()