- java.lang.Object
-
- java.io.Reader
-
- org.jline.utils.NonBlockingReader
-
- org.jline.utils.NonBlockingReaderImpl
-
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable,java.lang.Readable
public class NonBlockingReaderImpl extends NonBlockingReader
This class wraps a regular reader 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.
- Since:
- 2.7
-
-
Field Summary
Fields Modifier and Type Field Description static intREAD_EXPIRED-
Fields inherited from class org.jline.utils.NonBlockingReader
closed, EOF
-
-
Constructor Summary
Constructors Constructor Description NonBlockingReaderImpl(java.lang.String name, java.io.Reader in)Creates aNonBlockingReaderout of a normal blocking reader.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intavailable()Returns an estimate of the number of characters available to be read without blocking.voidclear()voidclose()Closes this reader and marks it as closed.protected intread(long timeout, boolean isPeek)Attempts to read a character from the input stream for a specific period of time.intreadBuffered(char[] b, int off, int len, long timeout)booleanready()voidshutdown()Shuts down the thread that is handling blocking I/O.-
Methods inherited from class org.jline.utils.NonBlockingReader
checkClosed, peek, read, read, read, readBuffered, readBuffered
-
-
-
-
Field Detail
-
READ_EXPIRED
public static final int READ_EXPIRED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NonBlockingReaderImpl
public NonBlockingReaderImpl(java.lang.String name, java.io.Reader in)Creates aNonBlockingReaderout 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 reader namein- The reader to wrap
-
-
Method Detail
-
shutdown
public void shutdown()
Description copied from class:NonBlockingReaderShuts down the thread that is handling blocking I/O.This method terminates the background thread that is used to handle blocking I/O operations. This allows the application to clean up resources and prevent thread leaks when the reader is no longer needed.
Note that if the thread is currently blocked waiting for I/O, it will not actually shut down until the I/O is received or the thread is interrupted. In some implementations, this method may interrupt the thread to force it to shut down immediately.
After calling this method, the reader should not be used anymore, as subsequent read operations may fail or block indefinitely.
- Overrides:
shutdownin classNonBlockingReader
-
close
public void close() throws java.io.IOExceptionDescription copied from class:NonBlockingReaderCloses this reader and marks it as closed.Subsequent read operations behavior depends on the
PROP_CLOSE_MODEsetting:"strict"- ThrowClosedException(default in JLine 4.x)"warn"- Log a warning but continue (default in JLine 3.x)"lenient"- Silently allow access
- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Overrides:
closein classNonBlockingReader- Throws:
java.io.IOException- if an I/O error occurs
-
ready
public boolean ready() throws java.io.IOException- Overrides:
readyin classjava.io.Reader- Throws:
java.io.IOException
-
readBuffered
public int readBuffered(char[] b, int off, int len, long timeout) throws java.io.IOException- Specified by:
readBufferedin classNonBlockingReader- Throws:
java.io.IOException
-
read
protected int read(long timeout, boolean isPeek) throws java.io.IOExceptionAttempts to read a character from the input stream for a specific period of time.- Specified by:
readin classNonBlockingReader- Parameters:
timeout- The amount of time to wait for the characterisPeek-trueif the character read must not be consumed- Returns:
- The character read, -1 if EOF is reached, or -2 if the read timed out.
- Throws:
java.io.IOException- if anything wrong happens
-
available
public int available()
Returns an estimate of the number of characters available to be read without blocking.Returns
1if a character has already been buffered by the background pump thread, or if the underlying reader reportsready(). Returns0at EOF, when the pump is actively reading (to avoid contention on the underlying reader's lock), or when the underlying reader is not ready. BecauseReader.ready()returns aboolean, the result is always either0or1? callers should not rely on this for a precise character count, only as a "data may be available" signal consistent with theInputStream.available()contract.- Overrides:
availablein classNonBlockingReader- Returns:
1if data is likely available,0otherwise
-
clear
public void clear() throws java.io.IOException- Throws:
java.io.IOException
-
-