Package org.jline.utils
Class NonBlockingInputStreamImpl
- java.lang.Object
-
- java.io.InputStream
-
- org.jline.utils.NonBlockingInputStream
-
- org.jline.utils.NonBlockingInputStreamImpl
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class NonBlockingInputStreamImpl extends NonBlockingInputStream
This class wraps a regular input stream and allows it to appear as if it is non-blocking; that is, reads can be performed against it that timeout if no data is seen for a period of time. This effect is achieved by having a separate thread perform all non-blocking read requests and then waiting on the thread to complete.VERY IMPORTANT NOTES
- This class is not thread safe. It expects at most one reader.
- The
shutdown()
method must be called in order to shut down the thread that handles blocking I/O.
-
-
Field Summary
Fields Modifier and Type Field Description private int
b
private java.io.IOException
exception
private java.io.InputStream
in
private java.lang.String
name
private java.lang.Thread
thread
private long
threadDelay
private boolean
threadIsReading
-
Fields inherited from class org.jline.utils.NonBlockingInputStream
EOF, READ_EXPIRED
-
-
Constructor Summary
Constructors Constructor Description NonBlockingInputStreamImpl(java.lang.String name, java.io.InputStream in)
Creates aNonBlockingReader
out of a normal blocking reader.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
int
read(long timeout, boolean isPeek)
Attempts to read a byte from the input stream for a specific period of time.private void
run()
void
shutdown()
Shuts down the thread that is handling blocking I/O.private void
startReadingThreadIfNeeded()
-
Methods inherited from class org.jline.utils.NonBlockingInputStream
peek, read, read, read, readBuffered
-
-
-
-
Constructor Detail
-
NonBlockingInputStreamImpl
public NonBlockingInputStreamImpl(java.lang.String name, java.io.InputStream in)
Creates aNonBlockingReader
out of a normal blocking reader. Note that this call also spawn a separate thread to perform the blocking I/O on behalf of the thread that is using this class. Theshutdown()
method must be called in order to shut this thread down.- Parameters:
name
- The stream namein
- The reader to wrap
-
-
Method Detail
-
startReadingThreadIfNeeded
private void startReadingThreadIfNeeded()
-
shutdown
public void shutdown()
Shuts down the thread that is handling blocking I/O. Note that if the thread is currently blocked waiting for I/O it will not actually shut down until the I/O is received.- Overrides:
shutdown
in classNonBlockingInputStream
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read(long timeout, boolean isPeek) throws java.io.IOException
Attempts to read a byte from the input stream for a specific period of time.- Specified by:
read
in classNonBlockingInputStream
- Parameters:
timeout
- The amount of time to wait for the characterisPeek
-true
if the byte read must not be consumed- Returns:
- The byte read, -1 if EOF is reached, or -2 if the read timed out.
- Throws:
java.io.IOException
- if anything wrong happens
-
run
private void run()
-
-