org.apache.flink.runtime.checkpoint

Interface CheckpointIDCounter

All Known Implementing Classes:

StandaloneCheckpointIDCounter, ZooKeeperCheckpointIDCounter

public interface CheckpointIDCounter

A checkpoint ID counter.

Method Summary

Modifier and Type	Method and Description
long	getAndIncrement() Atomically increments the current checkpoint ID.
void	setCount(long newId) Sets the current checkpoint ID.
void	shutdown() Shuts the CheckpointIDCounter service down and frees all created resources.
void	start() Starts the CheckpointIDCounter service.
void	suspend() Suspends the counter.

Method Detail

start

void start()
    throws Exception

Starts the CheckpointIDCounter service.

Throws:

Exception

shutdown

void shutdown()
       throws Exception

Shuts the CheckpointIDCounter service down and frees all created resources.

Throws:

Exception

suspend

void suspend()
      throws Exception

Suspends the counter.

If the implementation allows recovery, the counter state needs to be kept. Otherwise, this acts as shutdown.

Throws:

Exception

getAndIncrement

long getAndIncrement()
              throws Exception

Atomically increments the current checkpoint ID.

Returns:

The previous checkpoint ID

Throws:

Exception

setCount

void setCount(long newId)
       throws Exception

Sets the current checkpoint ID.

Parameters:

newId - The new ID

Throws:

Exception