org.michailov.async.io

Class AsyncRingBufferWatcher<TRingBuffer extends RingBuffer>

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncRingBufferWatcher<TRingBuffer>

public class AsyncRingBufferWatcher<TRingBuffer extends RingBuffer>
extends AsyncAgent

Asynchronous watcher of a RingBuffer. Fires the given callback when there are items available for reading.

See Also:

WhenReady, AsyncAgent, RingBuffer

Constructor Summary

Constructors

Constructor and Description
AsyncRingBufferWatcher(TRingBuffer ringBuffer, java.util.function.Consumer<TRingBuffer> onAvailableToRead, AsyncOptions asyncOptions) Constructs an AsyncCharDecoder instance over the given ring buffers.

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that invokes the onAvailableToRead callback synchronously.
protected boolean	done() "done" predicate that returns true when this async agent wants to quit the current async loop.
TRingBuffer	getRingBuffer() Returns the watched ring buffer.
boolean	isEOF() Checks whether this watcher has reached EOF of the watched ring buffer.
protected boolean	ready() "ready" predicate that returns true when items can be read from the watched ring buffer.

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

AsyncRingBufferWatcher

public AsyncRingBufferWatcher(TRingBuffer ringBuffer,
                              java.util.function.Consumer<TRingBuffer> onAvailableToRead,
                              AsyncOptions asyncOptions)

Constructs an AsyncCharDecoder instance over the given ring buffers.

Parameters:

ringBuffer - RingBuffer to watch.

onAvailableToRead - A callback to invoke when there are items available to read from the ring buffer.

asyncOptions - AsyncOptions to use for all async operations.

Method Detail

getRingBuffer

public TRingBuffer getRingBuffer()

Returns the watched ring buffer.

Returns:

The watched ring buffer.

isEOF

public boolean isEOF()

Checks whether this watcher has reached EOF of the watched 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 items can be read from the watched ring buffer.

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()

"done" predicate that returns true when this async agent wants to quit the current async loop.

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 invokes the onAvailableToRead callback synchronously.

Overrides:

action in class AsyncAgent