org.apache.flink.streaming.runtime.io

Class CheckpointedInputGate

java.lang.Object

org.apache.flink.streaming.runtime.io.CheckpointedInputGate

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.flink.runtime.io.AvailabilityProvider, org.apache.flink.runtime.io.PullingAsyncDataInput<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>

@Internal
public class CheckpointedInputGate
extends Object
implements org.apache.flink.runtime.io.PullingAsyncDataInput<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>, Closeable

The CheckpointedInputGate uses CheckpointBarrierHandler to handle incoming CheckpointBarrier from the InputGate.

Nested Class Summary

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

org.apache.flink.runtime.io.AvailabilityProvider.AvailabilityHelper

Field Summary

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

AVAILABLE

Constructor Summary

Constructors

Constructor and Description
CheckpointedInputGate(org.apache.flink.runtime.io.network.partition.consumer.InputGate inputGate, CheckpointBarrierHandler barrierHandler) Creates a new checkpoint stream aligner.

Method Summary

Modifier and Type	Method and Description
void	close() Cleans up all internally held resources.
CompletableFuture<Void>	getAllBarriersReceivedFuture(long checkpointId)
CompletableFuture<?>	getAvailableFuture()
org.apache.flink.runtime.io.network.partition.consumer.InputChannel	getChannel(int channelIndex)
List<org.apache.flink.runtime.checkpoint.channel.InputChannelInfo>	getChannelInfos()
int	getNumberOfInputChannels()
boolean	isFinished()
Optional<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>	pollNext()
void	spillInflightBuffers(long checkpointId, int channelIndex, org.apache.flink.runtime.checkpoint.channel.ChannelStateWriter channelStateWriter)
String	toString()

Methods inherited from class java.lang.Object

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

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

isApproximatelyAvailable, isAvailable

Constructor Detail

CheckpointedInputGate

public CheckpointedInputGate(org.apache.flink.runtime.io.network.partition.consumer.InputGate inputGate,
                             CheckpointBarrierHandler barrierHandler)

Creates a new checkpoint stream aligner.

The aligner will allow only alignments that buffer up to the given number of bytes. When that number is exceeded, it will stop the alignment and notify the task that the checkpoint has been cancelled.

Parameters:

inputGate - The input gate to draw the buffers and events from.

barrierHandler - Handler that controls which channels are blocked.

Method Detail

getAvailableFuture

public CompletableFuture<?> getAvailableFuture()

Specified by:

getAvailableFuture in interface org.apache.flink.runtime.io.AvailabilityProvider

pollNext

public Optional<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent> pollNext()
                                                                                        throws Exception

Specified by:

pollNext in interface org.apache.flink.runtime.io.PullingAsyncDataInput<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>

Throws:

Exception

spillInflightBuffers

public void spillInflightBuffers(long checkpointId,
                                 int channelIndex,
                                 org.apache.flink.runtime.checkpoint.channel.ChannelStateWriter channelStateWriter)
                          throws IOException

Throws:

IOException

getAllBarriersReceivedFuture

public CompletableFuture<Void> getAllBarriersReceivedFuture(long checkpointId)

isFinished

public boolean isFinished()

Specified by:

isFinished in interface org.apache.flink.runtime.io.PullingAsyncDataInput<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>

close

public void close()
           throws IOException

Cleans up all internally held resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - Thrown if the cleanup of I/O resources failed.

getNumberOfInputChannels

public int getNumberOfInputChannels()

Returns:

number of underlying input channels.

toString

public String toString()

Overrides:

toString in class Object

getChannel

public org.apache.flink.runtime.io.network.partition.consumer.InputChannel getChannel(int channelIndex)

getChannelInfos

public List<org.apache.flink.runtime.checkpoint.channel.InputChannelInfo> getChannelInfos()