alluxio.client.file

Class AlluxioFileInStream

java.lang.Object

java.io.InputStream

alluxio.client.file.FileInStream

alluxio.client.file.AlluxioFileInStream

All Implemented Interfaces:

BoundedStream, CanUnbuffer, PositionedReadable, Positioned, Seekable, Closeable, AutoCloseable

@PublicApi
 @NotThreadSafe
public class AlluxioFileInStream
extends FileInStream

An implementation of FileInStream for data stored in Alluxio. This class wraps the block in stream for each of the blocks in the file and abstracts the switching between streams. The backing streams can read from Alluxio space in the local machine, remote machines, or the under storage system. The internal bookkeeping works as follows: 1. updateStream() is a potentially expensive operation and is responsible for creating new BlockInStreams and updating mBlockInStream. After calling this method, mBlockInStream is ready to serve reads from the current mPosition. 2. mPosition can become out of sync with mBlockInStream when seek or skip is called. When this happens, mBlockInStream is set to null and no effort is made to sync between the two until updateStream() is called. 3. updateStream() is only called when followed by a read request. Thus, if a mBlockInStream is created, it is guaranteed we read at least one byte from it.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlluxioFileInStream(URIStatus status, InStreamOptions options, FileSystemContext context)

Method Summary

Modifier and Type	Method and Description
void	close()
long	getPos()
int	positionedRead(long pos, byte[] b, int off, int len) Reads up to the specified number of bytes, from a given position within a file, and return the number of bytes read.
int	read()
int	read(ByteBuffer byteBuffer, int off, int len) Reads up to len bytes of data from the input stream into the byte buffer.
long	remaining()
void	seek(long pos) Moves the starting read position of the stream to the specified position which is relative to the start of the stream.
long	skip(long n)
void	unbuffer() Reduce the buffering.

Methods inherited from class alluxio.client.file.FileInStream

read, read, read

Methods inherited from class java.io.InputStream

available, mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

AlluxioFileInStream

protected AlluxioFileInStream(URIStatus status,
                              InStreamOptions options,
                              FileSystemContext context)

Method Detail

read

public int read()
         throws IOException

Overrides:

read in class FileInStream

Throws:

IOException

read

public int read(ByteBuffer byteBuffer,
                int off,
                int len)
         throws IOException

Description copied from class: FileInStream

Reads up to len bytes of data from the input stream into the byte buffer.

Overrides:

read in class FileInStream

Parameters:

byteBuffer - the buffer into which the data is read

off - the start offset in the buffer at which the data is written

len - the maximum number of bytes to read

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

remaining

public long remaining()

Returns:

the remaining number of bytes left in the stream, starting at the current position

positionedRead

public int positionedRead(long pos,
                          byte[] b,
                          int off,
                          int len)
                   throws IOException

Description copied from interface: PositionedReadable

Reads up to the specified number of bytes, from a given position within a file, and return the number of bytes read. This does not change the current offset of a file, and is thread-safe. Not all implementations meet the thread safety requirement. According to the documentation of the PositionedReadable interface in Hadoop, those that do not meet the requirement cannot be used as a backing store for some applications, such as Apache HBase. All implementations of this interface in Alluxio must meet the thread safety requirement.

Parameters:

pos - position within file

b - destination buffer

off - offset in the buffer

len - number of bytes to read

Returns:

actual number of bytes read; -1 means "EOF";

Throws:

IOException

getPos

public long getPos()

Returns:

the current position

seek

public void seek(long pos)
          throws IOException

Description copied from interface: Seekable

Moves the starting read position of the stream to the specified position which is relative to the start of the stream. Seeking to a position before the current read position is supported.

Parameters:

pos - the position to seek to, it must be between 0 and the end of the stream - 1

Throws:

IOException

unbuffer

public void unbuffer()

Description copied from interface: CanUnbuffer

Reduce the buffering. This will also free sockets and file descriptors held by the stream, if possible.

Specified by:

unbuffer in interface CanUnbuffer

Overrides:

unbuffer in class FileInStream