org.apache.flink.runtime.io.network.api.writer

Interface ResultPartitionWriter

All Superinterfaces:

AutoCloseable, AvailabilityProvider

All Known Implementing Classes:

ConsumableNotifyingResultPartitionWriterDecorator, ReleaseOnConsumptionResultPartition, ResultPartition

public interface ResultPartitionWriter
extends AutoCloseable, AvailabilityProvider

A buffer-oriented runtime result writer API for producing results.

If AutoCloseable.close() is called before fail(Throwable) or finish(), it abruptly triggers failure and cancellation of production. In this case fail(Throwable) still needs to be called afterwards to fully release all resources associated the the partition and propagate failure cause to the consumer if possible.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

AvailabilityProvider.AvailabilityHelper

Field Summary

Fields inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

AVAILABLE

Method Summary

Modifier and Type	Method and Description
default boolean	addBufferConsumer(BufferConsumer bufferConsumer, int subpartitionIndex) Adds the bufferConsumer to the subpartition with the given index.
boolean	addBufferConsumer(BufferConsumer bufferConsumer, int subpartitionIndex, boolean isPriorityEvent) Adds the bufferConsumer to the subpartition with the given index.
void	fail(Throwable throwable) Fail the production of the partition.
void	finish() Successfully finish the production of the partition.
void	flush(int subpartitionIndex) Manually trigger consumption from enqueued BufferConsumers in one specified subpartition.
void	flushAll() Manually trigger consumption from enqueued BufferConsumers in all subpartitions.
BufferBuilder	getBufferBuilder(int targetChannel) Requests a BufferBuilder from this partition for writing data.
int	getNumberOfSubpartitions()
int	getNumTargetKeyGroups()
ResultPartitionID	getPartitionId()
ResultSubpartition	getSubpartition(int subpartitionIndex) Returns the subpartition with the given index.
void	readRecoveredState(ChannelStateReader stateReader) Reads the previous output states with the given reader for unaligned checkpoint.
void	setup() Setup partition, potentially heavy-weight, blocking operation comparing to just creation.
BufferBuilder	tryGetBufferBuilder(int targetChannel) Try to request a BufferBuilder from this partition for writing data.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

getAvailableFuture, isApproximatelyAvailable, isAvailable

Method Detail

setup

void setup()
    throws IOException

Setup partition, potentially heavy-weight, blocking operation comparing to just creation.

Throws:

IOException

readRecoveredState

void readRecoveredState(ChannelStateReader stateReader)
                 throws IOException,
                        InterruptedException

Reads the previous output states with the given reader for unaligned checkpoint. It should be done before task processing the inputs.

Throws:

IOException

InterruptedException

getPartitionId

ResultPartitionID getPartitionId()

getNumberOfSubpartitions

int getNumberOfSubpartitions()

getNumTargetKeyGroups

int getNumTargetKeyGroups()

getBufferBuilder

BufferBuilder getBufferBuilder(int targetChannel)
                        throws IOException,
                               InterruptedException

Requests a BufferBuilder from this partition for writing data.

Throws:

IOException

InterruptedException

tryGetBufferBuilder

BufferBuilder tryGetBufferBuilder(int targetChannel)
                           throws IOException

Try to request a BufferBuilder from this partition for writing data.

Returns null if no buffer is available or the buffer provider has been destroyed.

Throws:

IOException

addBufferConsumer

boolean addBufferConsumer(BufferConsumer bufferConsumer,
                          int subpartitionIndex,
                          boolean isPriorityEvent)
                   throws IOException

Adds the bufferConsumer to the subpartition with the given index.

This method takes the ownership of the passed bufferConsumer and thus is responsible for releasing it's resources.

To avoid problems with data re-ordering, before adding new BufferConsumer the previously added one the given subpartitionIndex must be marked as BufferConsumer.isFinished().

Returns:

true if operation succeeded and bufferConsumer was enqueued for consumption.

Throws:

IOException

addBufferConsumer

default boolean addBufferConsumer(BufferConsumer bufferConsumer,
                                  int subpartitionIndex)
                           throws IOException

Adds the bufferConsumer to the subpartition with the given index.

This method takes the ownership of the passed bufferConsumer and thus is responsible for releasing it's resources.

To avoid problems with data re-ordering, before adding new BufferConsumer the previously added one the given subpartitionIndex must be marked as BufferConsumer.isFinished().

Returns:

true if operation succeeded and bufferConsumer was enqueued for consumption.

Throws:

IOException

getSubpartition

ResultSubpartition getSubpartition(int subpartitionIndex)

Returns the subpartition with the given index.

flushAll

void flushAll()

Manually trigger consumption from enqueued BufferConsumers in all subpartitions.

flush

void flush(int subpartitionIndex)

Manually trigger consumption from enqueued BufferConsumers in one specified subpartition.

fail

void fail(@Nullable
          Throwable throwable)

Fail the production of the partition.

This method propagates non-null failure causes to consumers on a best-effort basis. This call also leads to the release of all resources associated with the partition. Closing of the partition is still needed afterwards if it has not been done before.

Parameters:

throwable - failure cause

finish

void finish()
     throws IOException

Successfully finish the production of the partition.

Closing of partition is still needed afterwards.

Throws:

IOException