org.apache.flink.runtime.state

类 CheckpointStreamFactory.CheckpointStateOutputStream

java.lang.Object

java.io.OutputStream

org.apache.flink.core.fs.FSDataOutputStream

org.apache.flink.runtime.state.CheckpointStreamFactory.CheckpointStateOutputStream

所有已实现的接口:

Closeable, Flushable, AutoCloseable

直接已知子类:

DuplicatingCheckpointOutputStream, FileBasedStateOutputStream, FsCheckpointStreamFactory.FsCheckpointStateOutputStream, MemCheckpointStreamFactory.MemoryCheckpointOutputStream

封闭接口:

CheckpointStreamFactory

public abstract static class CheckpointStreamFactory.CheckpointStateOutputStream
extends org.apache.flink.core.fs.FSDataOutputStream

A dedicated output stream that produces a StreamStateHandle when closed.

Important: When closing this stream after the successful case, you must call closeAndGetHandle() - only that method will actually retain the resource written to. The method has the semantics of "close on success". The close() method is supposed to remove the target resource if called before closeAndGetHandle(), hence having the semantics of "close on failure". That way, simple try-with-resources statements automatically clean up unsuccessful partial state resources in case the writing does not complete.

Note: This is an abstract class and not an interface because OutputStream is an abstract class.

构造器概要

构造器

构造器和说明
CheckpointStateOutputStream()

方法概要

限定符和类型	方法和说明
abstract void	close() This method should close the stream, if has not been closed before.
abstract StreamStateHandle	closeAndGetHandle() Closes the stream and gets a state handle that can create an input stream producing the data written to this stream.

从类继承的方法 org.apache.flink.core.fs.FSDataOutputStream

flush, getPos, sync

从类继承的方法 java.io.OutputStream

write, write, write

从类继承的方法 java.lang.Object

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

构造器详细资料

CheckpointStateOutputStream

public CheckpointStateOutputStream()

方法详细资料

closeAndGetHandle

@Nullable
public abstract StreamStateHandle closeAndGetHandle()
                                                       throws IOException

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

This closing must be called (also when the caller is not interested in the handle) to successfully close the stream and retain the produced resource. In contrast, the close() method removes the target resource when called.

返回:

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

抛出:

IOException - Thrown, if the stream cannot be closed.

close

public abstract void close()
                    throws IOException

This method should close the stream, if has not been closed before. If this method actually closes the stream, it should delete/release the resource behind the stream, such as the file that the stream writes to.

The above implies that this method is intended to be the "unsuccessful close", such as when cancelling the stream writing, or when an exception occurs. Closing the stream for the successful case must go through closeAndGetHandle().

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 org.apache.flink.core.fs.FSDataOutputStream

抛出:

IOException - Thrown, if the stream cannot be closed.