org.apache.flink.runtime.state

Interface CheckpointStreamFactory

All Known Subinterfaces:

CheckpointStorageLocation

All Known Implementing Classes:

FsCheckpointStorageLocation, FsCheckpointStreamFactory, MemCheckpointStreamFactory, NonPersistentMetadataCheckpointStorageLocation, PersistentMetadataCheckpointStorageLocation

public interface CheckpointStreamFactory

A factory for checkpoint output streams, which are used to persist data for checkpoints.

Stream factories can be created from the CheckpointStorageAccess through CheckpointStorageWorkerView.resolveCheckpointStorageLocation(long, CheckpointStorageLocationReference).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CheckpointStreamFactory.CheckpointStateOutputStream A dedicated output stream that produces a StreamStateHandle when closed.

Method Summary

Modifier and Type	Method and Description
CheckpointStreamFactory.CheckpointStateOutputStream	createCheckpointStateOutputStream(CheckpointedStateScope scope) Creates an new CheckpointStreamFactory.CheckpointStateOutputStream.

Method Detail

createCheckpointStateOutputStream

CheckpointStreamFactory.CheckpointStateOutputStream createCheckpointStateOutputStream(CheckpointedStateScope scope)
                                                                               throws IOException

Creates an new CheckpointStreamFactory.CheckpointStateOutputStream. When the stream is closed, it returns a state handle that can retrieve the state back.

Parameters:

scope - The state's scope, whether it is exclusive or shared.

Returns:

An output stream that writes state for the given checkpoint.

Throws:

IOException - Exceptions may occur while creating the stream and should be forwarded.