alluxio.worker.block.io

Class BlockWriter

java.lang.Object

alluxio.worker.block.io.BlockClient

alluxio.worker.block.io.BlockWriter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

PagedFileWriter

public abstract class BlockWriter
extends BlockClient

An abstract writer class to write or update a block stored in managed storage.

This class does not provide thread-safety.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.worker.block.io.BlockClient

BlockClient.Type

Constructor Summary

Constructors

Constructor and Description
BlockWriter() Default constructor for the abstract writer implementations.

Method Summary

Modifier and Type	Method and Description
abstract void	abort() Abort writing.
abstract long	append(io.netty.buffer.ByteBuf buf) Appends buf.readableBytes() bytes to the end of this block writer from the given buf.
abstract long	append(ByteBuffer inputBuf) Appends data to the end of a block from an input ByteBuffer.
abstract long	append(DataBuffer buffer) Appends buffer.readableBytes() bytes to the end of this block writer from the given buffer.
abstract void	commitFile() Commit the file.
abstract WritableByteChannel	getChannel()
abstract long	getPosition()

Methods inherited from class alluxio.worker.block.io.BlockClient

close, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockWriter

public BlockWriter()

Default constructor for the abstract writer implementations.

Method Detail

append

public abstract long append(ByteBuffer inputBuf)

Appends data to the end of a block from an input ByteBuffer.

Parameters:

inputBuf - ByteBuffer that input data is stored in

Returns:

the size of data that was appended in bytes

append

public abstract long append(io.netty.buffer.ByteBuf buf)
                     throws IOException

Appends buf.readableBytes() bytes to the end of this block writer from the given buf.

Parameters:

buf - the byte buffer that holds the data

Returns:

the size of data that was appended in bytes

Throws:

IOException

append

public abstract long append(DataBuffer buffer)
                     throws IOException

Appends buffer.readableBytes() bytes to the end of this block writer from the given buffer.

Parameters:

buffer - the byte buffer that holds the data

Returns:

the size of data that was appended in bytes

Throws:

IOException

getPosition

public abstract long getPosition()

Returns:

the current write position (same as the number of bytes written)

getChannel

public abstract WritableByteChannel getChannel()

Returns:

a writeable byte channel of the block

commitFile

public abstract void commitFile()

Commit the file.

abort

public abstract void abort()

Abort writing.