alluxio.client.block.stream

Class LocalFilePacketWriter

java.lang.Object

alluxio.client.block.stream.LocalFilePacketWriter

All Implemented Interfaces:

PacketWriter, Cancelable, Closeable, AutoCloseable

@NotThreadSafe
public final class LocalFilePacketWriter
extends Object
implements PacketWriter

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

Nested Class Summary

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

PacketWriter.Factory

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels an operation.
void	close()
static LocalFilePacketWriter	create(FileSystemContext context, WorkerNetAddress address, long blockId, OutStreamOptions options) Creates an instance of LocalFilePacketWriter.
void	flush() Flushes all the pending packets.
int	packetSize()
long	pos()
void	writePacket(io.netty.buffer.ByteBuf buf) Writes a packet.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

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

Parameters:

context - the file system context

address - the worker network address

blockId - the block ID

options - the output stream options

Returns:

the LocalFilePacketWriter created

Throws:

IOException

pos

public long pos()

Specified by:

pos in interface PacketWriter

Returns:

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

packetSize

public int packetSize()

Specified by:

packetSize in interface PacketWriter

Returns:

the packet size in bytes used

writePacket

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

Description copied from interface: PacketWriter

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

Specified by:

writePacket in interface PacketWriter

Parameters:

buf - the packet

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: PacketWriter

Flushes all the pending packets.

Specified by:

flush in interface PacketWriter

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException