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

Class ResultSubpartition

java.lang.Object

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

Direct Known Subclasses:

PipelinedSubpartition

public abstract class ResultSubpartition
extends Object

A single subpartition of a ResultPartition instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultSubpartition.BufferAndBacklog A combination of a Buffer and the backlog length indicating how many non-event buffers are available in the subpartition.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResultPartition	parent The parent partition this subpartition belongs to.
protected ResultSubpartitionInfo	subpartitionInfo The info of the subpartition to identify it globally within a task.

Constructor Summary

Constructors

Constructor and Description
ResultSubpartition(int index, ResultPartition parent)

Method Summary

Modifier and Type	Method and Description
boolean	add(BufferConsumer bufferConsumer) Adds the given buffer.
abstract boolean	add(BufferConsumer bufferConsumer, boolean isPriorityEvent) Adds the given buffer.
protected boolean	canBeCompressed(Buffer buffer) Whether the buffer can be compressed or not.
abstract ResultSubpartitionView	createReadView(BufferAvailabilityListener availabilityListener)
abstract void	finish()
abstract void	flush()
int	getSubPartitionIndex()
ResultSubpartitionInfo	getSubpartitionInfo()
protected abstract long	getTotalNumberOfBuffers() Gets the total numbers of buffers (data buffers plus events).
protected abstract long	getTotalNumberOfBytes()
abstract boolean	isReleased()
protected void	onConsumedSubpartition() Notifies the parent partition about a consumed ResultSubpartitionView.
void	readRecoveredState(ChannelStateReader stateReader)
abstract void	release()
abstract List<Buffer>	requestInflightBufferSnapshot()
abstract int	unsynchronizedGetNumberOfQueuedBuffers() Makes a best effort to get the current size of the queue.

Methods inherited from class java.lang.Object

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

Field Detail

subpartitionInfo

protected final ResultSubpartitionInfo subpartitionInfo

The info of the subpartition to identify it globally within a task.

parent

protected final ResultPartition parent

The parent partition this subpartition belongs to.

Constructor Detail

ResultSubpartition

public ResultSubpartition(int index,
                          ResultPartition parent)

Method Detail

canBeCompressed

protected boolean canBeCompressed(Buffer buffer)

Whether the buffer can be compressed or not. Note that event is not compressed because it is usually small and the size can become even larger after compression.

getSubpartitionInfo

public ResultSubpartitionInfo getSubpartitionInfo()

getTotalNumberOfBuffers

protected abstract long getTotalNumberOfBuffers()

Gets the total numbers of buffers (data buffers plus events).

getTotalNumberOfBytes

protected abstract long getTotalNumberOfBytes()

getSubPartitionIndex

public int getSubPartitionIndex()

onConsumedSubpartition

protected void onConsumedSubpartition()

Notifies the parent partition about a consumed ResultSubpartitionView.

readRecoveredState

public void readRecoveredState(ChannelStateReader stateReader)
                        throws IOException,
                               InterruptedException

Throws:

IOException

InterruptedException

add

public abstract boolean add(BufferConsumer bufferConsumer,
                            boolean isPriorityEvent)
                     throws IOException

Adds the given buffer.

The request may be executed synchronously, or asynchronously, depending on the implementation.

IMPORTANT: Before adding new BufferConsumer previously added must be in finished state. Because of the performance reasons, this is only enforced during the data reading.

Parameters:

bufferConsumer - the buffer to add (transferring ownership to this writer)

isPriorityEvent -

Returns:

true if operation succeeded and bufferConsumer was enqueued for consumption.

Throws:

IOException - thrown in case of errors while adding the buffer

add

public boolean add(BufferConsumer bufferConsumer)
            throws IOException

Adds the given buffer.

The request may be executed synchronously, or asynchronously, depending on the implementation.

IMPORTANT: Before adding new BufferConsumer previously added must be in finished state. Because of the performance reasons, this is only enforced during the data reading.

Parameters:

bufferConsumer - the buffer to add (transferring ownership to this writer)

Returns:

true if operation succeeded and bufferConsumer was enqueued for consumption.

Throws:

IOException - thrown in case of errors while adding the buffer

requestInflightBufferSnapshot

public abstract List<Buffer> requestInflightBufferSnapshot()

flush

public abstract void flush()

finish

public abstract void finish()
                     throws IOException

Throws:

IOException

release

public abstract void release()
                      throws IOException

Throws:

IOException

createReadView

public abstract ResultSubpartitionView createReadView(BufferAvailabilityListener availabilityListener)
                                               throws IOException

Throws:

IOException

isReleased

public abstract boolean isReleased()

unsynchronizedGetNumberOfQueuedBuffers

public abstract int unsynchronizedGetNumberOfQueuedBuffers()

Makes a best effort to get the current size of the queue. This method must not acquire locks or interfere with the task and network threads in any way.