org.michailov.async.io

Class AsyncByteStreamWriter

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncByteStreamWriter

public class AsyncByteStreamWriter
extends AsyncAgent

Asynchronous byte writer over a plain old OutputStream.

The stream bytes are read from a ByteRingBuffer.

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

See Also:

WhenReady, AsyncAgent, ByteRingBuffer

Constructor Summary

Constructors

Constructor and Description
AsyncByteStreamWriter(java.io.OutputStream outputStream, ByteRingBuffer byteRingBuffer, AsyncOptions asyncOptions) Constructs a new AsyncByteStreamWriter instance to write to the given OutputStream from the given ByteRingBuffer.

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that reads bytes from the ring buffer and writes them to the stream.
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 read from.
java.io.OutputStream	getOutputStream() Returns the underlying OutputStream.
boolean	isEOF() Checks whether this writer has reached EOF of the byte ring buffer.
protected boolean	ready() "ready" predicate that returns true when bytes can be read from 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

AsyncByteStreamWriter

public AsyncByteStreamWriter(java.io.OutputStream outputStream,
                             ByteRingBuffer byteRingBuffer,
                             AsyncOptions asyncOptions)

Constructs a new AsyncByteStreamWriter instance to write to the given OutputStream from the given ByteRingBuffer.

Parameters:

outputStream - An OutputStream to write to.

byteRingBuffer - A ByteRingBuffer to read from.

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

Method Detail

getOutputStream

public java.io.OutputStream getOutputStream()

Returns the underlying OutputStream.

Returns:

The underlying OutputStream.

getByteRingBuffer

public ByteRingBuffer getByteRingBuffer()

Returns the attached ring buffer where bytes will be read from.

Returns:

The attached ring buffer where bytes will be read from.

isEOF

public boolean isEOF()

Checks whether this writer has reached EOF of the byte ring buffer.

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 ring buffer without blocking.

Notice that OutputStream, unlike InputStream, has no way to report how many bytes can be written 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 ring buffer and writes them to the stream.

Overrides:

action in class AsyncAgent