org.apache.flink.runtime.state.filesystem

类 FileBasedStateOutputStream

java.lang.Object

java.io.OutputStream

org.apache.flink.core.fs.FSDataOutputStream

org.apache.flink.runtime.state.CheckpointStateOutputStream

org.apache.flink.runtime.state.filesystem.FileBasedStateOutputStream

所有已实现的接口:

Closeable, Flushable, AutoCloseable

public final class FileBasedStateOutputStream
extends CheckpointStateOutputStream

A CheckpointStateOutputStream that writes into a specified file and returns a FileStateHandle upon closing.

Unlike the FsCheckpointStreamFactory.FsCheckpointStateOutputStream, this stream does not have a threshold below which it returns a memory byte stream handle, and does not create random files, but writes to a specified file.

构造器概要

构造器

构造器和说明
FileBasedStateOutputStream(org.apache.flink.core.fs.FileSystem fileSystem, org.apache.flink.core.fs.Path path)

方法概要

限定符和类型	方法和说明
void	close() This method should close the stream, if has not been closed before.
FileStateHandle	closeAndGetHandle() Closes the stream and gets a state handle that can create an input stream producing the data written to this stream.
void	flush()
long	getPos()
boolean	isClosed()
void	sync()
void	write(byte[] b, int off, int len)
void	write(int b)

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

write

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

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

构造器详细资料

FileBasedStateOutputStream

public FileBasedStateOutputStream(org.apache.flink.core.fs.FileSystem fileSystem,
                                  org.apache.flink.core.fs.Path path)
                           throws IOException

抛出:

IOException

方法详细资料

write

public final void write(int b)
                 throws IOException

指定者:

write 在类中 OutputStream

抛出:

IOException

write

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

覆盖:

write 在类中 OutputStream

抛出:

IOException

getPos

public long getPos()
            throws IOException

指定者:

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

抛出:

IOException

flush

public void flush()
           throws IOException

指定者:

flush 在接口中 Flushable

指定者:

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

抛出:

IOException

sync

public void sync()
          throws IOException

指定者:

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

抛出:

IOException

isClosed

public boolean isClosed()

close

public void close()

从类复制的说明: CheckpointStateOutputStream

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 CheckpointStateOutputStream.closeAndGetHandle().

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 CheckpointStateOutputStream

closeAndGetHandle

@Nullable
public FileStateHandle closeAndGetHandle()
                                            throws IOException

从类复制的说明: CheckpointStateOutputStream

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 CheckpointStateOutputStream.close() method removes the target resource when called.

指定者:

closeAndGetHandle 在类中 CheckpointStateOutputStream

返回:

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

抛出:

IOException - Thrown, if the stream cannot be closed.