org.apache.flink.fs.s3.common.utils

Class RefCountedBufferingFileStream

java.lang.Object

java.io.OutputStream

org.apache.flink.core.fs.FSDataOutputStream

org.apache.flink.fs.s3.common.utils.RefCountedFSOutputStream

org.apache.flink.fs.s3.common.utils.RefCountedBufferingFileStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, RefCounted

@Internal
public class RefCountedBufferingFileStream
extends RefCountedFSOutputStream

A RefCountedFile that also uses an in-memory buffer for buffering small writes. This is done to avoid frequent 'flushes' of the file stream to disk.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
RefCountedBufferingFileStream(RefCountedFile file, int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
File	getInputFile() Gets the underlying File that allows to read the contents of the file.
long	getPos()
int	getReferenceCounter()
boolean	isClosed() Checks if the file is closed for writes.
static RefCountedBufferingFileStream	openNew(org.apache.flink.util.function.FunctionWithException<File,RefCountedFile,IOException> tmpFileProvider)
boolean	release() Decreases the reference counter.
static RefCountedBufferingFileStream	restore(org.apache.flink.util.function.FunctionWithException<File,RefCountedFile,IOException> tmpFileProvider, File initialTmpFile)
void	retain() Increases the reference counter.
void	sync()
String	toString()
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, wait, wait, wait

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

RefCountedBufferingFileStream

@VisibleForTesting
public RefCountedBufferingFileStream(RefCountedFile file,
                                                        int bufferSize)

Method Detail

getInputFile

public File getInputFile()

Description copied from class: RefCountedFSOutputStream

Gets the underlying File that allows to read the contents of the file.

Specified by:

getInputFile in class RefCountedFSOutputStream

Returns:

A handle to the File object.

getPos

public long getPos()

Specified by:

getPos in class org.apache.flink.core.fs.FSDataOutputStream

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

Specified by:

flush in class org.apache.flink.core.fs.FSDataOutputStream

Throws:

IOException

sync

public void sync()
          throws IOException

Specified by:

sync in class org.apache.flink.core.fs.FSDataOutputStream

Throws:

IOException

isClosed

public boolean isClosed()
                 throws IOException

Description copied from class: RefCountedFSOutputStream

Checks if the file is closed for writes.

Specified by:

isClosed in class RefCountedFSOutputStream

Returns:

true if the file is closed, false otherwise.

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class org.apache.flink.core.fs.FSDataOutputStream

retain

public void retain()

Description copied from interface: RefCounted

Increases the reference counter.

release

public boolean release()

Description copied from interface: RefCounted

Decreases the reference counter.

Returns:

true if the reference counter reached 0, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

getReferenceCounter

@VisibleForTesting
public int getReferenceCounter()

openNew

public static RefCountedBufferingFileStream openNew(org.apache.flink.util.function.FunctionWithException<File,RefCountedFile,IOException> tmpFileProvider)
                                             throws IOException

Throws:

IOException

restore

public static RefCountedBufferingFileStream restore(org.apache.flink.util.function.FunctionWithException<File,RefCountedFile,IOException> tmpFileProvider,
                                                    File initialTmpFile)
                                             throws IOException

Throws:

IOException