alluxio.util.io

Class ChannelAdapters

java.lang.Object

alluxio.util.io.ChannelAdapters

public class ChannelAdapters
extends Object

Channel adapters.

Thread Safety

The channel implementations in this class are thread safe, as per the general requirement of the Channel interface. However, in case a channel is based on an underlying buffer, cautions must be taken to preserve thread safety:

• Two channels should not share the same underlying buffer and be operated on concurrently.
• A buffer should not be manipulated directly while there is an outstanding channel that uses it as the underlying buffer.

Method Summary

Modifier and Type	Method and Description
static WritableByteChannel	intoByteArray(byte[] output) Adapts a byte array to be the destination of a WritableByteChannel.
static WritableByteChannel	intoByteArray(byte[] output, int offset, int length) Adapts a byte array to be the destination of a WritableByteChannel.
static WritableByteChannel	intoByteBuf(io.netty.buffer.ByteBuf output) todo(bowen): implement.
static WritableByteChannel	intoByteBuffer(ByteBuffer output) Adapts a ByteBuffer to be the destination of a WritableByteChannel.

Methods inherited from class java.lang.Object

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

Method Detail

intoByteBuffer

public static WritableByteChannel intoByteBuffer(ByteBuffer output)

Adapts a ByteBuffer to be the destination of a WritableByteChannel.
The returned channel, when its WritableByteChannel.write(ByteBuffer) method is called, will copy p bytes from the source buffer to the output buffer, where p = min(src.remaining(), output.remaining()). After the write is successful, the positions of both the source and output buffer will have increased by p. If the output buffer has no space remaining, while the source buffer has available bytes, ClosedChannelException is thrown.

Parameters:

output - the output byte buffer

Returns:

channel

intoByteArray

public static WritableByteChannel intoByteArray(byte[] output)

Adapts a byte array to be the destination of a WritableByteChannel. Bytes will be written from the beginning of the array and to the end.

Parameters:

output - output buffer

Returns:

channel

intoByteArray

public static WritableByteChannel intoByteArray(byte[] output,
                                                int offset,
                                                int length)

Adapts a byte array to be the destination of a WritableByteChannel. Bytes will be written from index offset to offset + length.

Parameters:

output - output buffer

offset - offset within the buffer

length - length of the writable region within the buffer

Returns:

channel

intoByteBuf

public static WritableByteChannel intoByteBuf(io.netty.buffer.ByteBuf output)

todo(bowen): implement.

Parameters:

output - output

Returns:

channel