org.apache.flink.streaming.runtime.tasks

Interface SubtaskCheckpointCoordinator

All Superinterfaces:

AutoCloseable, Closeable

@Internal
public interface SubtaskCheckpointCoordinator
extends Closeable

Coordinates checkpointing-related work for a subtask (i.e. Task and StreamTask). Responsibilities:

1. build a snapshot (invokable)
2. report snapshot to the JobManager
3. action upon checkpoint notification
4. maintain storage locations

Method Summary

Modifier and Type	Method and Description
void	abortCheckpointOnBarrier(long checkpointId, org.apache.flink.runtime.checkpoint.CheckpointException cause, OperatorChain<?,?> operatorChain)
void	checkpointState(org.apache.flink.runtime.checkpoint.CheckpointMetaData checkpointMetaData, org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions, org.apache.flink.runtime.checkpoint.CheckpointMetricsBuilder checkpointMetrics, OperatorChain<?,?> operatorChain, java.util.function.Supplier<Boolean> isRunning) Must be called after initInputsCheckpoint(long, CheckpointOptions).
org.apache.flink.runtime.checkpoint.channel.ChannelStateWriter	getChannelStateWriter()
org.apache.flink.runtime.state.CheckpointStorageWorkerView	getCheckpointStorage()
void	initInputsCheckpoint(long id, org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions) Initialize new checkpoint.
void	notifyCheckpointAborted(long checkpointId, OperatorChain<?,?> operatorChain, java.util.function.Supplier<Boolean> isRunning) Notified on the task side once a distributed checkpoint has been aborted.
void	notifyCheckpointComplete(long checkpointId, OperatorChain<?,?> operatorChain, java.util.function.Supplier<Boolean> isRunning) Notified on the task side once a distributed checkpoint has been completed.

Methods inherited from interface java.io.Closeable

close

Method Detail

initInputsCheckpoint

void initInputsCheckpoint(long id,
                          org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions)
                   throws org.apache.flink.runtime.checkpoint.CheckpointException

Initialize new checkpoint.

Throws:

org.apache.flink.runtime.checkpoint.CheckpointException

getChannelStateWriter

org.apache.flink.runtime.checkpoint.channel.ChannelStateWriter getChannelStateWriter()

getCheckpointStorage

org.apache.flink.runtime.state.CheckpointStorageWorkerView getCheckpointStorage()

abortCheckpointOnBarrier

void abortCheckpointOnBarrier(long checkpointId,
                              org.apache.flink.runtime.checkpoint.CheckpointException cause,
                              OperatorChain<?,?> operatorChain)
                       throws IOException

Throws:

IOException

checkpointState

void checkpointState(org.apache.flink.runtime.checkpoint.CheckpointMetaData checkpointMetaData,
                     org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions,
                     org.apache.flink.runtime.checkpoint.CheckpointMetricsBuilder checkpointMetrics,
                     OperatorChain<?,?> operatorChain,
                     java.util.function.Supplier<Boolean> isRunning)
              throws Exception

Must be called after initInputsCheckpoint(long, CheckpointOptions).

Throws:

Exception

notifyCheckpointComplete

void notifyCheckpointComplete(long checkpointId,
                              OperatorChain<?,?> operatorChain,
                              java.util.function.Supplier<Boolean> isRunning)
                       throws Exception

Notified on the task side once a distributed checkpoint has been completed.

Parameters:

checkpointId - The checkpoint id to notify as been completed.

operatorChain - The chain of operators executed by the task.

isRunning - Whether the task is running.

Throws:

Exception

notifyCheckpointAborted

void notifyCheckpointAborted(long checkpointId,
                             OperatorChain<?,?> operatorChain,
                             java.util.function.Supplier<Boolean> isRunning)
                      throws Exception

Notified on the task side once a distributed checkpoint has been aborted.

Parameters:

checkpointId - The checkpoint id to notify as been completed.

operatorChain - The chain of operators executed by the task.

isRunning - Whether the task is running.

Throws:

Exception