org.apache.flink.runtime.checkpoint

Class CheckpointCoordinator

java.lang.Object

org.apache.flink.runtime.checkpoint.CheckpointCoordinator

public class CheckpointCoordinator
extends Object

The checkpoint coordinator coordinates the distributed snapshots of operators and state. It triggers the checkpoint by sending the messages to the relevant tasks and collects the checkpoint acknowledgements. It also collects and maintains the overview of the state handles reported by the tasks that acknowledge the checkpoint.

Constructor Summary

Constructors

Constructor and Description
CheckpointCoordinator(org.apache.flink.api.common.JobID job, int numSuccessfulCheckpointsToRetain, long checkpointTimeout, ExecutionVertex[] tasksToTrigger, ExecutionVertex[] tasksToWaitFor, ExecutionVertex[] tasksToCommitTo, ClassLoader userClassLoader)

Method Summary

Modifier and Type	Method and Description
akka.actor.ActorRef	createJobStatusListener(akka.actor.ActorSystem actorSystem, long checkpointInterval)
int	getNumberOfPendingCheckpoints()
int	getNumberOfRetainedSuccessfulCheckpoints()
Map<Long,PendingCheckpoint>	getPendingCheckpoints()
List<SuccessfulCheckpoint>	getSuccessfulCheckpoints()
boolean	isShutdown()
void	receiveAcknowledgeMessage(AcknowledgeCheckpoint message)
void	restoreLatestCheckpointedState(Map<JobVertexID,ExecutionJobVertex> tasks, boolean errorIfNoCheckpoint, boolean allOrNothingState)
void	shutdown() Shuts down the checkpoint coordinator.
void	startPeriodicCheckpointScheduler(long interval)
void	stopPeriodicCheckpointScheduler()
void	triggerCheckpoint() Triggers a new checkpoint and uses the current system time as the checkpoint time.
boolean	triggerCheckpoint(long timestamp) Triggers a new checkpoint and uses the given timestamp as the checkpoint timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckpointCoordinator

public CheckpointCoordinator(org.apache.flink.api.common.JobID job,
                             int numSuccessfulCheckpointsToRetain,
                             long checkpointTimeout,
                             ExecutionVertex[] tasksToTrigger,
                             ExecutionVertex[] tasksToWaitFor,
                             ExecutionVertex[] tasksToCommitTo,
                             ClassLoader userClassLoader)

Method Detail

shutdown

public void shutdown()

Shuts down the checkpoint coordinator. After this method has been called, the coordinator does not accept and further messages and cannot trigger any further checkpoints.

isShutdown

public boolean isShutdown()

triggerCheckpoint

public void triggerCheckpoint()

Triggers a new checkpoint and uses the current system time as the checkpoint time.

triggerCheckpoint

public boolean triggerCheckpoint(long timestamp)

Triggers a new checkpoint and uses the given timestamp as the checkpoint timestamp.

Parameters:

timestamp - The timestamp for the checkpoint.

receiveAcknowledgeMessage

public void receiveAcknowledgeMessage(AcknowledgeCheckpoint message)

restoreLatestCheckpointedState

public void restoreLatestCheckpointedState(Map<JobVertexID,ExecutionJobVertex> tasks,
                                           boolean errorIfNoCheckpoint,
                                           boolean allOrNothingState)
                                    throws Exception

Throws:

Exception

getNumberOfPendingCheckpoints

public int getNumberOfPendingCheckpoints()

getNumberOfRetainedSuccessfulCheckpoints

public int getNumberOfRetainedSuccessfulCheckpoints()

getPendingCheckpoints

public Map<Long,PendingCheckpoint> getPendingCheckpoints()

getSuccessfulCheckpoints

public List<SuccessfulCheckpoint> getSuccessfulCheckpoints()

startPeriodicCheckpointScheduler

public void startPeriodicCheckpointScheduler(long interval)

stopPeriodicCheckpointScheduler

public void stopPeriodicCheckpointScheduler()

createJobStatusListener

public akka.actor.ActorRef createJobStatusListener(akka.actor.ActorSystem actorSystem,
                                                   long checkpointInterval)