org.michailov.async.io

Class AsyncByteStreamReader

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncByteStreamReader

public class AsyncByteStreamReader
extends AsyncAgent

Asynchronous byte reader over a plain old InputStream wrapped in an EOFInputStream. The reader doesn't block as long as the stream correctly reports its available bytes.

The reader reads available bytes from the stream if there are any. If there aren't, it schedules a future to do that.

The stream bytes are read into a ByteRingBuffer.

Note: The caller is responsible for opening and closing the stream as needed.

See Also:

EOFInputStream, WhenReady, AsyncAgent, ByteRingBuffer

Constructor Summary

Constructors

Constructor and Description
AsyncByteStreamReader(EOFInputStream inputStream, ByteRingBuffer byteRingBuffer, AsyncOptions asyncOptions) Constructs a new AsyncByteStreamReader instance to read from the given InputStream into the given ByteRingBuffer.

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that reads bytes from the stream and writes them to the ring buffer.
protected boolean	done() The 'done' predicate passed to WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).
ByteRingBuffer	getByteRingBuffer() Returns the attached ring buffer where bytes will be written.
EOFInputStream	getInputStream() Returns the underlying InputStream.
boolean	isEOF() Checks whether this reader has reached EOF of the stream.
protected boolean	ready() "ready" predicate that returns true when bytes can be read from the stream and written to the ring buffer without blocking.

Methods inherited from class org.michailov.async.AsyncAgent

applyAsync, isIdle, setIdle, setIdleAndThrow, startApplyLoopAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsyncByteStreamReader

public AsyncByteStreamReader(EOFInputStream inputStream,
                             ByteRingBuffer byteRingBuffer,
                             AsyncOptions asyncOptions)

Constructs a new AsyncByteStreamReader instance to read from the given InputStream into the given ByteRingBuffer.

Parameters:

inputStream - An EOFInputStream to read from.

byteRingBuffer - A ByteRingBuffer to write to.

asyncOptions - AsyncOptions that will control all async operations on this instance.

Method Detail

getInputStream

public EOFInputStream getInputStream()

Returns the underlying InputStream.

Returns:

The underlying InputStream.

getByteRingBuffer

public ByteRingBuffer getByteRingBuffer()

Returns the attached ring buffer where bytes will be written.

Returns:

The attached ring buffer where bytes will be written.

isEOF

public boolean isEOF()

Checks whether this reader has reached EOF of the stream.

Returns:

true iff EOF has been reached or an exception has been encountered.

ready

protected boolean ready()

"ready" predicate that returns true when bytes can be read from the stream and written to the ring buffer without blocking.

Overrides:

ready in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time to execute AsyncAgent.action().

done

protected boolean done()

Description copied from class: AsyncAgent

The 'done' predicate passed to WhenReady.startApplyLoopAsync(java.util.function.Predicate<S>, java.util.function.Predicate<S>, java.util.function.Function<S, R>, S).

Overrides:

done in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time for the loop to stop.

action

protected void action()

"action" function that reads bytes from the stream and writes them to the ring buffer.

Overrides:

action in class AsyncAgent