alluxio

Interface PositionReader

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AlluxioHdfsPositionReader, COSPositionReader, DoraCachePositionReader, GCSPositionReader, HdfsPositionedUnderFileInputStream, LocalCachePositionReader, LocalPositionReader, NettyDataReader, ObjectPositionReader, OBSPositionReader, OSSPositionReader, PagedFileReader, S3APositionReader

@ThreadSafe
public interface PositionReader
extends Closeable

Position read interface. All implementer should be thread-safe.

Method Summary

Modifier and Type	Method and Description
default void	close() Closes the positon reader and do cleanup job if any.
default int	read(long position, byte[] buffer, int length)
default int	read(long position, byte[] buffer, int offset, int length)
default int	read(long position, ByteBuffer buffer, int length)
default int	read(long position, io.netty.buffer.ByteBuf buffer, int length)
default int	read(long position, ReadTargetBuffer buffer, int length)
int	readInternal(long position, ReadTargetBuffer buffer, int length)

Method Detail

read

default int read(long position,
                 byte[] buffer,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte array

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

read

default int read(long position,
                 byte[] buffer,
                 int offset,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte array

offset - the offset of the buffer

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

read

default int read(long position,
                 ByteBuffer buffer,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte buffer

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

read

default int read(long position,
                 io.netty.buffer.ByteBuf buffer,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte buf

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

read

default int read(long position,
                 ReadTargetBuffer buffer,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte buffer

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

readInternal

int readInternal(long position,
                 ReadTargetBuffer buffer,
                 int length)
          throws IOException

Parameters:

position - position of the file to start reading data

buffer - target byte buffer

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

close

default void close()
            throws IOException

Closes the positon reader and do cleanup job if any.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException