org.apache.flink.runtime.state.filesystem

Class FsStateBackend.FsCheckpointStateOutputStream

java.lang.Object

java.io.OutputStream

org.apache.flink.runtime.state.AbstractStateBackend.CheckpointStateOutputStream

org.apache.flink.runtime.state.filesystem.FsStateBackend.FsCheckpointStateOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Enclosing class:

FsStateBackend

public static final class FsStateBackend.FsCheckpointStateOutputStream
extends AbstractStateBackend.CheckpointStateOutputStream

A CheckpointStateOutputStream that writes into a file and returns the path to that file upon closing.

Constructor Summary

Constructors

Constructor and Description
FsStateBackend.FsCheckpointStateOutputStream(Path basePath, FileSystem fs, int bufferSize, int localStateThreshold)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() If the stream is only closed, we remove the produced file (cleanup through the auto close feature, for example).
StreamStateHandle	closeAndGetHandle() Closes the stream and gets a state handle that can create an input stream producing the data written to this stream.
Path	closeAndGetPath() Closes the stream and returns the path to the file that contains the stream's data.
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

FsStateBackend.FsCheckpointStateOutputStream

public FsStateBackend.FsCheckpointStateOutputStream(Path basePath,
                                            FileSystem fs,
                                            int bufferSize,
                                            int localStateThreshold)

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
         int off,
         int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()

If the stream is only closed, we remove the produced file (cleanup through the auto close feature, for example). This method throws no exception if the deletion fails, but only logs the error.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

closeAndGetHandle

public StreamStateHandle closeAndGetHandle()
                                    throws IOException

Description copied from class: AbstractStateBackend.CheckpointStateOutputStream

Closes the stream and gets a state handle that can create an input stream producing the data written to this stream.

Specified by:

closeAndGetHandle in class AbstractStateBackend.CheckpointStateOutputStream

Returns:

A state handle that can create an input stream producing the data written to this stream.

Throws:

IOException - Thrown, if the stream cannot be closed.

closeAndGetPath

public Path closeAndGetPath()
                     throws IOException

Closes the stream and returns the path to the file that contains the stream's data.

Returns:

The path to the file that contains the stream's data.

Throws:

IOException - Thrown if the stream cannot be successfully closed.