org.apache.flink.runtime.state

Interface CheckpointStreamWithResultProvider

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CheckpointStreamWithResultProvider.PrimaryAndSecondaryStream, CheckpointStreamWithResultProvider.PrimaryStreamOnly

public interface CheckpointStreamWithResultProvider
extends Closeable

Interface that provides access to a CheckpointStateOutputStream and a method to provide the SnapshotResult. This abstracts from different ways that a result is obtained from checkpoint output streams.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CheckpointStreamWithResultProvider.KeyedStateHandleFactory Factory method for a KeyedStateHandle to be used in toKeyedStateHandleSnapshotResult(SnapshotResult, KeyGroupRangeOffsets, KeyedStateHandleFactory).
static class	CheckpointStreamWithResultProvider.PrimaryAndSecondaryStream Implementation of CheckpointStreamWithResultProvider that creates both, the primary/remote/jm-owned state and the secondary/local/tm-owned state.
static class	CheckpointStreamWithResultProvider.PrimaryStreamOnly Implementation of CheckpointStreamWithResultProvider that only creates the primary/remote/jm-owned state.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method and Description
default void	close()
SnapshotResult<StreamStateHandle>	closeAndFinalizeCheckpointStreamResult() Closes the stream ans returns a snapshot result with the stream handle(s).
static CheckpointStreamWithResultProvider	createDuplicatingStream(long checkpointId, CheckpointedStateScope checkpointedStateScope, CheckpointStreamFactory primaryStreamFactory, LocalRecoveryDirectoryProvider secondaryStreamDirProvider)
static CheckpointStreamWithResultProvider	createSimpleStream(CheckpointedStateScope checkpointedStateScope, CheckpointStreamFactory primaryStreamFactory)
CheckpointStreamFactory.CheckpointStateOutputStream	getCheckpointOutputStream() Returns the encapsulated output stream.
static SnapshotResult<KeyedStateHandle>	toKeyedStateHandleSnapshotResult(SnapshotResult<StreamStateHandle> snapshotResult, KeyGroupRangeOffsets keyGroupRangeOffsets, CheckpointStreamWithResultProvider.KeyedStateHandleFactory stateHandleFactory) Helper method that takes a SnapshotResult and a KeyGroupRangeOffsets and creates a SnapshotResult by combining the key groups offsets with all the present stream state handles.

Field Detail

LOG

static final org.slf4j.Logger LOG

Method Detail

closeAndFinalizeCheckpointStreamResult

@Nonnull
SnapshotResult<StreamStateHandle> closeAndFinalizeCheckpointStreamResult()
                                                                           throws IOException

Closes the stream ans returns a snapshot result with the stream handle(s).

Throws:

IOException

getCheckpointOutputStream

@Nonnull
CheckpointStreamFactory.CheckpointStateOutputStream getCheckpointOutputStream()

Returns the encapsulated output stream.

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

createSimpleStream

@Nonnull
static CheckpointStreamWithResultProvider createSimpleStream(@Nonnull
                                                                      CheckpointedStateScope checkpointedStateScope,
                                                                      @Nonnull
                                                                      CheckpointStreamFactory primaryStreamFactory)
                                                               throws IOException

Throws:

IOException

createDuplicatingStream

@Nonnull
static CheckpointStreamWithResultProvider createDuplicatingStream(@Nonnegative
                                                                           long checkpointId,
                                                                           @Nonnull
                                                                           CheckpointedStateScope checkpointedStateScope,
                                                                           @Nonnull
                                                                           CheckpointStreamFactory primaryStreamFactory,
                                                                           @Nonnull
                                                                           LocalRecoveryDirectoryProvider secondaryStreamDirProvider)
                                                                    throws IOException

Throws:

IOException

toKeyedStateHandleSnapshotResult

@Nonnull
static SnapshotResult<KeyedStateHandle> toKeyedStateHandleSnapshotResult(@Nonnull
                                                                                  SnapshotResult<StreamStateHandle> snapshotResult,
                                                                                  @Nonnull
                                                                                  KeyGroupRangeOffsets keyGroupRangeOffsets,
                                                                                  @Nonnull
                                                                                  CheckpointStreamWithResultProvider.KeyedStateHandleFactory stateHandleFactory)

Helper method that takes a SnapshotResult and a KeyGroupRangeOffsets and creates a SnapshotResult by combining the key groups offsets with all the present stream state handles.