Package org.apache.commons.io.input
Class ReadAheadInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ReadAheadInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
Implements
InputStream to asynchronously read ahead from an underlying input stream when a specified amount of data has been read from the current
buffer. It does so by maintaining two buffers: an active buffer and a read ahead buffer. The active buffer contains data which should be returned when a
read() call is issued. The read ahead buffer is used to asynchronously read from the underlying input stream. When the current active buffer is exhausted, we
flip the two buffers so that we can start reading from the read ahead buffer without being blocked by disk I/O.
To build an instance, use ReadAheadInputStream.Builder.
This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19.
- Since:
- 2.9.0
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionReadAheadInputStream(InputStream inputStream, int bufferSizeInBytes) Deprecated.ReadAheadInputStream(InputStream inputStream, int bufferSizeInBytes, ExecutorService executorService) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionintstatic ReadAheadInputStream.Builderbuilder()Constructs a newReadAheadInputStream.Builder.voidclose()intread()intread(byte[] b, int offset, int len) longskip(long n) Methods inherited from class java.io.FilterInputStream
mark, markSupported, read, reset
-
Constructor Details
-
ReadAheadInputStream
Deprecated.Constructs an instance with the specified buffer size and read-ahead threshold- Parameters:
inputStream- The underlying input stream.bufferSizeInBytes- The buffer size.
-
ReadAheadInputStream
@Deprecated public ReadAheadInputStream(InputStream inputStream, int bufferSizeInBytes, ExecutorService executorService) Deprecated.Constructs an instance with the specified buffer size and read-ahead threshold- Parameters:
inputStream- The underlying input stream.bufferSizeInBytes- The buffer size.executorService- An executor service for the read-ahead thread.
-
-
Method Details
-
builder
Constructs a newReadAheadInputStream.Builder.- Returns:
- a new
ReadAheadInputStream.Builder. - Since:
- 2.12.0
-
available
- Overrides:
availablein classFilterInputStream- Throws:
IOException
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classFilterInputStream- Throws:
IOException
-
read
- Overrides:
readin classFilterInputStream- Throws:
IOException
-
read
- Overrides:
readin classFilterInputStream- Throws:
IOException
-
skip
- Overrides:
skipin classFilterInputStream- Throws:
IOException
-
builder(),ReadAheadInputStream.Builder, andReadAheadInputStream.Builder.get()