org.apache.flink.streaming.runtime.io.checkpointing

Class SingleCheckpointBarrierHandler

java.lang.Object

org.apache.flink.streaming.runtime.io.checkpointing.CheckpointBarrierHandler

org.apache.flink.streaming.runtime.io.checkpointing.SingleCheckpointBarrierHandler

All Implemented Interfaces:

Closeable, AutoCloseable

@Internal
 @NotThreadSafe
public class SingleCheckpointBarrierHandler
extends CheckpointBarrierHandler

SingleCheckpointBarrierHandler is used for triggering checkpoint while reading the first barrier and keeping track of the number of received barriers and consumed barriers. It can handle/track just single checkpoint at a time. The behaviour when to actually trigger the checkpoint and what the CheckpointableInput should do is controlled by BarrierHandlerState.

Method Summary

Modifier and Type	Method and Description
static SingleCheckpointBarrierHandler	aligned(String taskName, org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint, org.apache.flink.util.clock.Clock clock, int numOpenChannels, BarrierAlignmentUtil.DelayableTimer registerTimer, boolean enableCheckpointAfterTasksFinished, org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)
static SingleCheckpointBarrierHandler	alternating(String taskName, org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint, SubtaskCheckpointCoordinator checkpointCoordinator, org.apache.flink.util.clock.Clock clock, int numOpenChannels, BarrierAlignmentUtil.DelayableTimer registerTimer, boolean enableCheckpointAfterTasksFinished, org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)
void	close()
static SingleCheckpointBarrierHandler	createUnalignedCheckpointBarrierHandler(SubtaskCheckpointCoordinator checkpointCoordinator, String taskName, org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint, org.apache.flink.util.clock.Clock clock, boolean enableCheckpointsAfterTasksFinish, org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)
CompletableFuture<Void>	getAllBarriersReceivedFuture(long checkpointId)
long	getLatestCheckpointId()
protected boolean	isCheckpointPending()
protected void	markCheckpointAlignedAndTransformState(org.apache.flink.runtime.checkpoint.channel.InputChannelInfo alignedChannel, org.apache.flink.runtime.io.network.api.CheckpointBarrier barrier, org.apache.flink.util.function.FunctionWithException<org.apache.flink.streaming.runtime.io.checkpointing.BarrierHandlerState,org.apache.flink.streaming.runtime.io.checkpointing.BarrierHandlerState,Exception> stateTransformer)
void	processBarrier(org.apache.flink.runtime.io.network.api.CheckpointBarrier barrier, org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo, boolean isRpcTriggered)
void	processBarrierAnnouncement(org.apache.flink.runtime.io.network.api.CheckpointBarrier announcedBarrier, int sequenceNumber, org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
void	processCancellationBarrier(org.apache.flink.runtime.io.network.api.CancelCheckpointMarker cancelBarrier, org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
void	processEndOfPartition(org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
String	toString()
static SingleCheckpointBarrierHandler	unaligned(String taskName, org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint, SubtaskCheckpointCoordinator checkpointCoordinator, org.apache.flink.util.clock.Clock clock, int numOpenChannels, BarrierAlignmentUtil.DelayableTimer registerTimer, boolean enableCheckpointAfterTasksFinished, org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)

Methods inherited from class org.apache.flink.streaming.runtime.io.checkpointing.CheckpointBarrierHandler

addProcessedBytes, getAlignmentDurationNanos, getCheckpointStartDelayNanos, getClock, markAlignmentEnd, markAlignmentEnd, markAlignmentStart, markAlignmentStartAndEnd, notifyAbort, notifyAbortOnCancellationBarrier, notifyCheckpoint, resetAlignment

Methods inherited from class java.lang.Object

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

Method Detail

createUnalignedCheckpointBarrierHandler

@VisibleForTesting
public static SingleCheckpointBarrierHandler createUnalignedCheckpointBarrierHandler(SubtaskCheckpointCoordinator checkpointCoordinator,
                                                                                                        String taskName,
                                                                                                        org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint,
                                                                                                        org.apache.flink.util.clock.Clock clock,
                                                                                                        boolean enableCheckpointsAfterTasksFinish,
                                                                                                        org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)

unaligned

public static SingleCheckpointBarrierHandler unaligned(String taskName,
                                                       org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint,
                                                       SubtaskCheckpointCoordinator checkpointCoordinator,
                                                       org.apache.flink.util.clock.Clock clock,
                                                       int numOpenChannels,
                                                       BarrierAlignmentUtil.DelayableTimer registerTimer,
                                                       boolean enableCheckpointAfterTasksFinished,
                                                       org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)

aligned

public static SingleCheckpointBarrierHandler aligned(String taskName,
                                                     org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint,
                                                     org.apache.flink.util.clock.Clock clock,
                                                     int numOpenChannels,
                                                     BarrierAlignmentUtil.DelayableTimer registerTimer,
                                                     boolean enableCheckpointAfterTasksFinished,
                                                     org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)

alternating

public static SingleCheckpointBarrierHandler alternating(String taskName,
                                                         org.apache.flink.runtime.jobgraph.tasks.CheckpointableTask toNotifyOnCheckpoint,
                                                         SubtaskCheckpointCoordinator checkpointCoordinator,
                                                         org.apache.flink.util.clock.Clock clock,
                                                         int numOpenChannels,
                                                         BarrierAlignmentUtil.DelayableTimer registerTimer,
                                                         boolean enableCheckpointAfterTasksFinished,
                                                         org.apache.flink.runtime.io.network.partition.consumer.CheckpointableInput... inputs)

processBarrier

public void processBarrier(org.apache.flink.runtime.io.network.api.CheckpointBarrier barrier,
                           org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo,
                           boolean isRpcTriggered)
                    throws IOException

Specified by:

processBarrier in class CheckpointBarrierHandler

Throws:

IOException

markCheckpointAlignedAndTransformState

protected void markCheckpointAlignedAndTransformState(org.apache.flink.runtime.checkpoint.channel.InputChannelInfo alignedChannel,
                                                      org.apache.flink.runtime.io.network.api.CheckpointBarrier barrier,
                                                      org.apache.flink.util.function.FunctionWithException<org.apache.flink.streaming.runtime.io.checkpointing.BarrierHandlerState,org.apache.flink.streaming.runtime.io.checkpointing.BarrierHandlerState,Exception> stateTransformer)
                                               throws IOException

Throws:

IOException

processBarrierAnnouncement

public void processBarrierAnnouncement(org.apache.flink.runtime.io.network.api.CheckpointBarrier announcedBarrier,
                                       int sequenceNumber,
                                       org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
                                throws IOException

Specified by:

processBarrierAnnouncement in class CheckpointBarrierHandler

Throws:

IOException

processCancellationBarrier

public void processCancellationBarrier(org.apache.flink.runtime.io.network.api.CancelCheckpointMarker cancelBarrier,
                                       org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
                                throws IOException

Specified by:

processCancellationBarrier in class CheckpointBarrierHandler

Throws:

IOException

processEndOfPartition

public void processEndOfPartition(org.apache.flink.runtime.checkpoint.channel.InputChannelInfo channelInfo)
                           throws IOException

Specified by:

processEndOfPartition in class CheckpointBarrierHandler

Throws:

IOException

getLatestCheckpointId

public long getLatestCheckpointId()

Specified by:

getLatestCheckpointId in class CheckpointBarrierHandler

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class CheckpointBarrierHandler

Throws:

IOException

isCheckpointPending

protected boolean isCheckpointPending()

Specified by:

isCheckpointPending in class CheckpointBarrierHandler

getAllBarriersReceivedFuture

public CompletableFuture<Void> getAllBarriersReceivedFuture(long checkpointId)

Overrides:

getAllBarriersReceivedFuture in class CheckpointBarrierHandler

toString

public String toString()

Overrides:

toString in class Object