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

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

Modifier and Type	Field and Description
private int	b
private IOException	exception
private InputStream	in
private String	name
private Thread	thread
private long	threadDelay
private boolean	threadIsReading

Inherited from jdk.internal.org.jline.utils.NonBlockingInputStream:: EOF READ_EXPIRED

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public synchronized int	Returns: The byte 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 `true`if the byte read must not be consumed isPeek) Implements abstract jdk.internal.org.jline.utils.NonBlockingInputStream.read. Attempts to read a byte from the input stream for a specific period of time.
private void	run()
public synchronized void	shutdown() Overrides jdk.internal.org.jline.utils.NonBlockingInputStream.shutdown. Shuts down the thread that is handling blocking I/O.
private synchronized void	startReadingThreadIfNeeded()

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

Field Detail

b	back to summary
private int b

exception	back to summary
private IOException exception

in	back to summary
private InputStream in

name	back to summary
private String name

thread	back to summary
private Thread thread

threadDelay	back to summary
private long threadDelay

threadIsReading	back to summary
private boolean threadIsReading

Constructor Detail

NonBlockingInputStreamImpl back to summary

NonBlockingInputStreamImpl	back to summary
public NonBlockingInputStreamImpl(String name, InputStream 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 stream name in:InputStream The reader to wrap

public NonBlockingInputStreamImpl(String name, InputStream 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 stream name
in:InputStream: The reader to wrap

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

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

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

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

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

Parameters

timeout:long: The amount of time to wait for the character
isPeek:boolean: trueif the byte read must not be consumed

Returns:int

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

Exceptions

IOException:: if anything wrong happens

run	back to summary
private void run()

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