alluxio.client.block.stream

Class BlockOutStream

java.lang.Object

java.io.OutputStream

alluxio.client.block.stream.BlockOutStream

All Implemented Interfaces:

BoundedStream, Cancelable, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

UnderFileSystemFileOutStream

@NotThreadSafe
public class BlockOutStream
extends OutputStream
implements BoundedStream, Cancelable

Provides an OutputStream implementation that is based on DataWriter which streams data chunk by chunk.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockOutStream(DataWriter dataWriter, long length, WorkerNetAddress address) Constructs a new BlockOutStream with only one DataWriter.
protected	BlockOutStream(List<DataWriter> dataWriters, long length, List<WorkerNetAddress> workerNetAddresses) Constructs a new BlockOutStream with only one DataWriter.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels an operation.
void	close()
static BlockOutStream	create(FileSystemContext context, long blockId, long blockSize, WorkerNetAddress address, OutStreamOptions options) Creates an BlockOutStream.
static BlockOutStream	createReplicatedBlockOutStream(FileSystemContext context, long blockId, long blockSize, List<WorkerNetAddress> workerNetAddresses, OutStreamOptions options) Creates a new remote block output stream.
void	flush()
WorkerNetAddress	getAddress()
long	remaining()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(io.netty.buffer.ByteBuf buf) Writes the data in the specified byte buf to this output stream.
void	write(io.netty.buffer.ByteBuf buf, int off, int len) Writes len bytes from the specified byte buf starting at offset off to this output stream.
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockOutStream

protected BlockOutStream(DataWriter dataWriter,
                         long length,
                         WorkerNetAddress address)

Constructs a new BlockOutStream with only one DataWriter.

Parameters:

dataWriter - the data writer

length - the length of the stream

address - the Alluxio worker address

BlockOutStream

protected BlockOutStream(List<DataWriter> dataWriters,
                         long length,
                         List<WorkerNetAddress> workerNetAddresses)

Constructs a new BlockOutStream with only one DataWriter.

Parameters:

dataWriters - the data writer

length - the length of the stream

workerNetAddresses - the worker network addresses

Method Detail

create

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

Creates an BlockOutStream.

Parameters:

context - the file system context

blockId - the block ID

blockSize - the block size in bytes

address - the Alluxio worker address

options - the out stream options

Returns:

the OutputStream object

Throws:

IOException

remaining

public long remaining()

Specified by:

remaining in interface BoundedStream

Returns:

the remaining size of the block

createReplicatedBlockOutStream

public static BlockOutStream createReplicatedBlockOutStream(FileSystemContext context,
                                                            long blockId,
                                                            long blockSize,
                                                            List<WorkerNetAddress> workerNetAddresses,
                                                            OutStreamOptions options)
                                                     throws IOException

Creates a new remote block output stream.

Parameters:

context - the file system context

blockId - the block id

blockSize - the block size

workerNetAddresses - the worker network addresses

options - the options

Returns:

the BlockOutStream instance created

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

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

write

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

Writes the data in the specified byte buf to this output stream.

Parameters:

buf - the buffer

Throws:

IOException

write

public void write(io.netty.buffer.ByteBuf buf,
                  int off,
                  int len)
           throws IOException

Writes len bytes from the specified byte buf starting at offset off to this output stream.

Parameters:

buf - the buffer

off - the offset

len - the length

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

cancel

public void cancel()
            throws IOException

Description copied from interface: Cancelable

Cancels an operation.

Specified by:

cancel in interface Cancelable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

getAddress

public WorkerNetAddress getAddress()

Returns:

the worker address for this stream