com.github.davidmoten.rx.util

Class RxRingBuffer

java.lang.Object

com.github.davidmoten.rx.util.RxRingBuffer

All Implemented Interfaces:

rx.Subscription

public class RxRingBuffer
extends Object
implements rx.Subscription

This assumes Spsc or Spmc usage. This means only a single producer calling the on* methods. This is the Rx contract of an Observer (see http://reactivex.io/documentation/contract.html). Concurrent invocations of on* methods will not be thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE
Object	terminalState We store the terminal state separately so it doesn't count against the size.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Object o, rx.Observer child)
Throwable	asError(Object o)
int	available()
int	capacity()
int	count()
static RxRingBuffer	getSpmcInstance()
static RxRingBuffer	getSpscInstance()
static RxRingBuffer	getSpscInstance(int size)
Object	getValue(Object o)
boolean	isCompleted(Object o)
boolean	isEmpty()
boolean	isError(Object o)
boolean	isUnsubscribed()
void	onCompleted()
void	onError(Throwable t)
void	onNext(Object o)
Object	peek()
Object	poll()
void	release()
void	unsubscribe()

Methods inherited from class java.lang.Object

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

Field Detail

terminalState

public volatile Object terminalState

We store the terminal state separately so it doesn't count against the size. We don't just +1 the size since some of the queues require sizes that are a power of 2. This is a subjective thing ... wanting to keep the size (ie 1024) the actual number of onNext that can be sent rather than something like 1023 onNext + 1 terminal event. It also simplifies checking that we have received only 1 terminal event, as we don't need to peek at the last item or retain a boolean flag.

SIZE

public static final int SIZE

Method Detail

getSpscInstance

public static RxRingBuffer getSpscInstance()

getSpscInstance

public static RxRingBuffer getSpscInstance(int size)

getSpmcInstance

public static RxRingBuffer getSpmcInstance()

release

public void release()

unsubscribe

public void unsubscribe()

Specified by:

unsubscribe in interface rx.Subscription

onNext

public void onNext(Object o)
            throws rx.exceptions.MissingBackpressureException

Parameters:

o - the value to buffer

Throws:

rx.exceptions.MissingBackpressureException - if more onNext are sent than have been requested

onCompleted

public void onCompleted()

onError

public void onError(Throwable t)

available

public int available()

capacity

public int capacity()

count

public int count()

isEmpty

public boolean isEmpty()

poll

public Object poll()

peek

public Object peek()

isCompleted

public boolean isCompleted(Object o)

isError

public boolean isError(Object o)

getValue

public Object getValue(Object o)

accept

public boolean accept(Object o,
                      rx.Observer child)

asError

public Throwable asError(Object o)

isUnsubscribed

public boolean isUnsubscribed()

Specified by:

isUnsubscribed in interface rx.Subscription