tachyon.network.protocol.databuffer

Class DataNettyBuffer

java.lang.Object

tachyon.network.protocol.databuffer.DataNettyBuffer

All Implemented Interfaces:

DataBuffer

public final class DataNettyBuffer
extends Object
implements DataBuffer

A DataBuffer with the underlying data being a ByteBuf.

Constructor Summary

Constructors

Constructor and Description
DataNettyBuffer(io.netty.buffer.ByteBuf bytebuf, long length) Constructor for creating a DataNettyBuffer, by passing a Netty ByteBuf.

Method Summary

Methods

Modifier and Type	Method and Description
long	getLength() Returns the length of the data.
Object	getNettyOutput() We would not support this method in DataNettyBuffer because this class is only for reading netty buffers.
ByteBuffer	getReadOnlyByteBuffer() Returns a ByteBuffer for read-only access to the data.
void	release() Release the Netty ByteBuf.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataNettyBuffer

public DataNettyBuffer(io.netty.buffer.ByteBuf bytebuf,
               long length)

Constructor for creating a DataNettyBuffer, by passing a Netty ByteBuf. This way we avoid one copy from ByteBuf to another ByteBuffer, and making sure the buffer would not be recycled. IMPORTANT: release() must be called after reading is finished. Otherwise the memory space for the ByteBuf might never be reclaimed.

Parameters:

bytebuf - The ByteBuf having the data

length - The length of the underlying ByteBuffer data

Method Detail

getNettyOutput

public Object getNettyOutput()

We would not support this method in DataNettyBuffer because this class is only for reading netty buffers. TODO(qifan): Investigate if using NettyDataBuffer for outgoing message is fine.

Specified by:

getNettyOutput in interface DataBuffer

Returns:

the object to output to Netty. Must be ByteBuf or FileRegion

Throws:

UnsupportedOperationException - whenever called

getLength

public long getLength()

Description copied from interface: DataBuffer

Returns the length of the data.

Specified by:

getLength in interface DataBuffer

Returns:

the length of the data in bytes

getReadOnlyByteBuffer

public ByteBuffer getReadOnlyByteBuffer()

Description copied from interface: DataBuffer

Returns a ByteBuffer for read-only access to the data.

Specified by:

getReadOnlyByteBuffer in interface DataBuffer

Returns:

a read-only ByteBuffer representing the data

release

public void release()

Release the Netty ByteBuf.

Specified by:

release in interface DataBuffer