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()
Buffer	getNextBuffer() Returns the next Buffer instance of this queue iterator.
boolean	isReleased()
void	notifySubpartitionConsumed()
boolean	registerListener(NotificationListener listener) Subscribes to data availability notifications.
void	releaseAllResources()

Method Detail

getNextBuffer

Buffer 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.recycle() after it has been consumed.

Throws:

IOException

InterruptedException

registerListener

boolean registerListener(NotificationListener listener)
                  throws IOException

Subscribes to data availability notifications.

Returns whether the subscription was successful. A subscription fails, if there is data available.

Throws:

IOException

releaseAllResources

void releaseAllResources()
                  throws IOException

Throws:

IOException

notifySubpartitionConsumed

void notifySubpartitionConsumed()
                         throws IOException

Throws:

IOException

isReleased

boolean isReleased()

getFailureCause

Throwable getFailureCause()