alluxio.client.block.stream

Class LocalFileDataWriter

java.lang.Object

alluxio.client.block.stream.LocalFileDataWriter

All Implemented Interfaces:

DataWriter, Cancelable, Closeable, AutoCloseable

@NotThreadSafe
public final class LocalFileDataWriter
extends Object
implements DataWriter

A local data writer that simply writes packets to a local file.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.block.stream.DataWriter

DataWriter.Factory

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels an operation.
int	chunkSize()
void	close()
static LocalFileDataWriter	create(FileSystemContext context, WorkerNetAddress address, long blockId, long blockSize, OutStreamOptions options) Creates an instance of LocalFileDataWriter.
void	flush() Flushes all the pending chunks.
Optional<String>	getUfsContentHash()
long	pos()
void	writeChunk(io.netty.buffer.ByteBuf buf) Writes a chunk.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LocalFileDataWriter create(FileSystemContext context,
                                         WorkerNetAddress address,
                                         long blockId,
                                         long blockSize,
                                         OutStreamOptions options)
                                  throws IOException

Creates an instance of LocalFileDataWriter. This requires the block to be locked beforehand.

Parameters:

context - the file system context

address - the worker network address

blockId - the block ID

blockSize - the block size in bytes

options - the output stream options

Returns:

the LocalFileDataWriter created

Throws:

IOException

pos

public long pos()

Specified by:

pos in interface DataWriter

Returns:

the current pos which is the same as the totally number of bytes written so far

chunkSize

public int chunkSize()

Specified by:

chunkSize in interface DataWriter

Returns:

the chunk size in bytes used

getUfsContentHash

public Optional<String> getUfsContentHash()

Specified by:

getUfsContentHash in interface DataWriter

Returns:

the content hash of the file if it is written to the UFS. Will only return a non-empty value after the data writer has been closed.

writeChunk

public void writeChunk(io.netty.buffer.ByteBuf buf)
                throws IOException

Description copied from interface: DataWriter

Writes a chunk. This method takes the ownership of this chunk even if it fails to write the chunk.

Specified by:

writeChunk in interface DataWriter

Parameters:

buf - the chunk

Throws:

IOException

cancel

public void cancel()
            throws IOException

Description copied from interface: Cancelable

Cancels an operation.

Specified by:

cancel in interface Cancelable

Throws:

IOException

flush

public void flush()

Description copied from interface: DataWriter

Flushes all the pending chunks.

Specified by:

flush in interface DataWriter

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException