OpenJDK 27 · jdk.internal.org.jline.utils.NonBlockingReaderImpl

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.

Field Summary

Modifier and Type	Field and Description
private int	ch
private IOException	exception
private Reader	in
private String	name
public static final int	READ_EXPIRED Hides jdk.internal.org.jline.utils.NonBlockingReader.READ_EXPIRED.
private Thread	thread
private long	threadDelay
private boolean	threadIsReading

Inherited from jdk.internal.org.jline.utils.NonBlockingReader:: EOF

Constructor Summary

Access	Constructor and Description
public	NonBlockingReaderImpl(String The reader name name, Reader The reader to wrap in) Creates a `NonBlockingReader` out of a normal blocking reader.

Method Summary

Modifier and Type	Method and Description
public synchronized void	clear()
public void	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
protected synchronized int	Returns: The character read, -1 if EOF is reached, or -2 if the read timed out. read(long The amount of time to wait for the character timeout, boolean isPeek) Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.read. Attempts to read a character from the input stream for a specific period of time.
public int	readBuffered(char[] b, int off, int len, long timeout) Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.readBuffered.
public synchronized boolean	ready() Overrides java.io.Reader.ready. Tells whether this stream is ready to be read.
private void	run()
public synchronized void	shutdown() Overrides jdk.internal.org.jline.utils.NonBlockingReader.shutdown. Shuts down the thread that is handling blocking I/O.
private synchronized void	startReadingThreadIfNeeded()

Inherited from jdk.internal.org.jline.utils.NonBlockingReader:: available peek read read read readBuffered readBuffered

Field Detail

ch	back to summary
private int ch

exception	back to summary
private IOException exception

in	back to summary
private Reader in

name	back to summary
private String name

READ_EXPIRED	back to summary
public static final int READ_EXPIRED Hides jdk.internal.org.jline.utils.NonBlockingReader.READ_EXPIRED.

thread	back to summary
private Thread thread

threadDelay	back to summary
private long threadDelay

threadIsReading	back to summary
private boolean threadIsReading

Constructor Detail

NonBlockingReaderImpl back to summary

NonBlockingReaderImpl	back to summary
public NonBlockingReaderImpl(String name, Reader in) Creates a `NonBlockingReader` 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. The `shutdown()` method must be called in order to shut this thread down. Parameters name:String The reader name in:Reader The reader to wrap

public NonBlockingReaderImpl(String name, Reader in)

Creates a NonBlockingReader 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. The shutdown() method must be called in order to shut this thread down.

Parameters

name:String: The reader name
in:Reader: The reader to wrap

Method Detail

clear	back to summary
public synchronized void clear() throws IOException

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

read	back to summary
protected synchronized int read(long timeout, boolean isPeek) throws IOException Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.read. Attempts to read a character from the input stream for a specific period of time. Parameters timeout:long The amount of time to wait for the character Returns:int The character read, -1 if EOF is reached, or -2 if the read timed out. Exceptions IOException: Doc from jdk.internal.org.jline.utils.NonBlockingReader.read. if anything wrong happens

read

back to summary

protected synchronized int read(long timeout, boolean isPeek) throws IOException

Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.read.

Attempts to read a character from the input stream for a specific period of time.

Parameters

timeout:long: The amount of time to wait for the character

Returns:int

The character read, -1 if EOF is reached, or -2 if the read timed out.

Exceptions

IOException:

Doc from jdk.internal.org.jline.utils.NonBlockingReader.read.

if anything wrong happens

readBuffered	back to summary
public int readBuffered(char[] b, int off, int len, long timeout) throws IOException Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.readBuffered. Annotations @Override

readBuffered

back to summary

public int readBuffered(char[] b, int off, int len, long timeout) throws IOException

Implements abstract jdk.internal.org.jline.utils.NonBlockingReader.readBuffered.

Annotations

@Override

ready	back to summary
public synchronized boolean ready() throws IOException Overrides java.io.Reader.ready. Doc from java.io.Reader.ready. Tells whether this stream is ready to be read. Annotations @Override Exceptions IOException: If an I/O error occurs

ready

back to summary

public synchronized boolean ready() throws IOException

Overrides java.io.Reader.ready.

Doc from java.io.Reader.ready.

Tells whether this stream is ready to be read.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

run	back to summary
private void run()

shutdown	back to summary
public synchronized void shutdown() Overrides jdk.internal.org.jline.utils.NonBlockingReader.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.

shutdown

back to summary

public synchronized void shutdown()

Overrides jdk.internal.org.jline.utils.NonBlockingReader.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.

startReadingThreadIfNeeded	back to summary
private synchronized void startReadingThreadIfNeeded()

public Class NonBlockingReaderImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail