reactor.util.concurrent

Class RingBufferReader

java.lang.Object

reactor.util.concurrent.RingBufferReader

All Implemented Interfaces:

java.lang.Runnable, java.util.function.LongSupplier

public final class RingBufferReader
extends java.lang.Object
implements java.lang.Runnable, java.util.function.LongSupplier

Used for Gating ringbuffer consumers on a cursor sequence and optional dependent ringbuffer consumer(s), using the given WaitStrategy.

Method Summary

Modifier and Type	Method and Description
void	alert() Alert the ringbuffer consumers of a status change and stay in this status until cleared.
void	checkAlert() Check if an alert has been raised and throw an if it has.
void	clearAlert() Clear the current alert status.
long	getAsLong()
long	getCursor() Get the current cursor value that can be read.
boolean	isAlerted() The current alert status for the barrier.
void	run()
void	signal() Signal the ringbuffer consumers.
long	waitFor(long sequence) Wait for the given sequence to be available for consumption.
long	waitFor(long sequence, java.lang.Runnable consumer) Wait for the given sequence to be available for consumption.

Methods inherited from class java.lang.Object

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

Method Detail

waitFor

public long waitFor(long sequence)
             throws reactor.util.concurrent.RingBuffer.AlertException,
                    java.lang.InterruptedException

Wait for the given sequence to be available for consumption.

Parameters:

sequence - to wait for

Returns:

the sequence up to which is available

Throws:

RingBuffer.AlertException - if a status change has occurred for the Disruptor

java.lang.InterruptedException - if the thread needs awaking on a condition variable.

waitFor

public long waitFor(long sequence,
                    java.lang.Runnable consumer)
             throws reactor.util.concurrent.RingBuffer.AlertException,
                    java.lang.InterruptedException

Wait for the given sequence to be available for consumption.

Parameters:

consumer - a spin observer to invoke when nothing is available to read

sequence - to wait for

Returns:

the sequence up to which is available

Throws:

RingBuffer.AlertException - if a status change has occurred for the Disruptor

java.lang.InterruptedException - if the thread needs awaking on a condition variable.

getCursor

public long getCursor()

Get the current cursor value that can be read.

Returns:

value of the cursor for entries that have been published.

isAlerted

public boolean isAlerted()

The current alert status for the barrier.

Returns:

true if in alert otherwise false.

alert

public void alert()

Alert the ringbuffer consumers of a status change and stay in this status until cleared.

signal

public void signal()

Signal the ringbuffer consumers.

clearAlert

public void clearAlert()

Clear the current alert status.

checkAlert

public void checkAlert()
                throws reactor.util.concurrent.RingBuffer.AlertException

Check if an alert has been raised and throw an if it has.

Throws:

RingBuffer.AlertException - if alert has been raised.

getAsLong

public long getAsLong()

Specified by:

getAsLong in interface java.util.function.LongSupplier

run

public void run()

Specified by:

run in interface java.lang.Runnable