Package org.apache.flink.core.fs.local

Class LocalRecoverableFsDataOutputStream

java.lang.Object

java.io.OutputStream

org.apache.flink.core.fs.FSDataOutputStream

org.apache.flink.core.fs.RecoverableFsDataOutputStream

org.apache.flink.core.fs.CommitterFromPersistRecoverableFsDataOutputStream<org.apache.flink.core.fs.local.LocalRecoverable>

org.apache.flink.core.fs.local.LocalRecoverableFsDataOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@Internal
public class LocalRecoverableFsDataOutputStream
extends CommitterFromPersistRecoverableFsDataOutputStream<org.apache.flink.core.fs.local.LocalRecoverable>

A RecoverableFsDataOutputStream for the LocalFileSystem.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.core.fs.RecoverableFsDataOutputStream

RecoverableFsDataOutputStream.Committer

Constructor Summary

Constructors

Constructor	Description
LocalRecoverableFsDataOutputStream(File targetFile, File tempFile)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream.
protected RecoverableFsDataOutputStream.Committer	createCommitterFromResumeRecoverable(org.apache.flink.core.fs.local.LocalRecoverable recoverable)
void	flush()	Flushes the stream, writing any data currently buffered in stream implementation to the proper output stream.
long	getPos()	Gets the position of the stream (non-negative), defined as the number of bytes from the beginning of the file to the current writing position.
org.apache.flink.core.fs.local.LocalRecoverable	persist()	Ensures all data so far is persistent (similar to FSDataOutputStream.sync()) and returns a handle to recover the stream at the current position.
void	sync()	Flushes the data all the way to the persistent non-volatile storage (for example disks).
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class org.apache.flink.core.fs.CommitterFromPersistRecoverableFsDataOutputStream

closeForCommit

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalRecoverableFsDataOutputStream

public LocalRecoverableFsDataOutputStream(File targetFile,
                                          File tempFile)
                                   throws IOException

Throws:

IOException

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

Description copied from class: FSDataOutputStream

Flushes the stream, writing any data currently buffered in stream implementation to the proper output stream. After this method has been called, the stream implementation must not hold onto any buffered data any more.

A completed flush does not mean that the data is necessarily persistent. Data persistence can is only assumed after calls to FSDataOutputStream.close() or FSDataOutputStream.sync().

Implementation note: This overrides the method defined in OutputStream as abstract to force implementations of the FSDataOutputStream to implement this method directly.

Specified by:

flush in interface Flushable

Specified by:

flush in class FSDataOutputStream

Throws:

IOException - Thrown if an I/O error occurs while flushing the stream.

sync

public void sync()
          throws IOException

Description copied from class: FSDataOutputStream

Flushes the data all the way to the persistent non-volatile storage (for example disks). The method behaves similar to the fsync function, forcing all data to be persistent on the devices.

Specified by:

sync in class FSDataOutputStream

Throws:

IOException - Thrown if an I/O error occurs

getPos

public long getPos()
            throws IOException

Description copied from class: FSDataOutputStream

Gets the position of the stream (non-negative), defined as the number of bytes from the beginning of the file to the current writing position. The position corresponds to the zero-based index of the next byte that will be written.

This method must report accurately report the current position of the stream. Various components of the high-availability and recovery logic rely on the accurate

Specified by:

getPos in class FSDataOutputStream

Returns:

The current position in the stream, defined as the number of bytes from the beginning of the file to the current writing position.

Throws:

IOException - Thrown if an I/O error occurs while obtaining the position from the stream implementation.

persist

public org.apache.flink.core.fs.local.LocalRecoverable persist()
                                                        throws IOException

Description copied from class: RecoverableFsDataOutputStream

Ensures all data so far is persistent (similar to FSDataOutputStream.sync()) and returns a handle to recover the stream at the current position.

Specified by:

persist in class CommitterFromPersistRecoverableFsDataOutputStream<org.apache.flink.core.fs.local.LocalRecoverable>

Throws:

IOException

See Also:

RecoverableFsDataOutputStream.persist()

createCommitterFromResumeRecoverable

protected RecoverableFsDataOutputStream.Committer createCommitterFromResumeRecoverable(org.apache.flink.core.fs.local.LocalRecoverable recoverable)

Specified by:

createCommitterFromResumeRecoverable in class CommitterFromPersistRecoverableFsDataOutputStream<org.apache.flink.core.fs.local.LocalRecoverable>

Parameters:

recoverable - a resume recoverable to create the committer from. Typically the parameter is the return value of CommitterFromPersistRecoverableFsDataOutputStream.persist().

Returns:

the committer created from recoverable.

See Also:

RecoverableFsDataOutputStream.closeForCommit()

close

public void close()
           throws IOException

Description copied from class: RecoverableFsDataOutputStream

Closes this stream. Closing the steam releases the local resources that the stream uses, but does NOT result in durability of previously written data. This method should be interpreted as a "close in order to dispose" or "close on failure".

In order to persist all previously written data, one needs to call the RecoverableFsDataOutputStream.closeForCommit() method and call RecoverableFsDataOutputStream.Committer.commit() on the returned committer object.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class RecoverableFsDataOutputStream

Throws:

IOException - Thrown if an error occurred during closing.