reactor.core.publisher

Class UnicastProcessor<T>

java.lang.Object

reactor.core.publisher.Flux<OUT>

reactor.core.publisher.FluxProcessor<T,T>

reactor.core.publisher.UnicastProcessor<T>

Type Parameters:

T - the input and output type

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Queue<T>, org.reactivestreams.Processor<T,T>, org.reactivestreams.Publisher<T>, org.reactivestreams.Subscriber<T>, org.reactivestreams.Subscription, Fuseable, Fuseable.QueueSubscription<T>, Producer, Receiver, Trackable

public final class UnicastProcessor<T>
extends FluxProcessor<T,T>
implements Fuseable.QueueSubscription<T>, Fuseable, Producer, Receiver

A Processor implementation that takes a custom queue and allows only a single subscriber.

The implementation keeps the order of signals.

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Fuseable

Fuseable.ConditionalSubscriber<T>, Fuseable.QueueSubscription<T>, Fuseable.ScalarCallable<T>, Fuseable.SynchronousSubscription<T>

Field Summary

Fields inherited from interface reactor.core.Fuseable

ANY, ASYNC, NONE, SYNC, THREAD_BARRIER

Fields inherited from interface reactor.core.Trackable

UNSPECIFIED

Constructor Summary

Constructors

Constructor and Description
UnicastProcessor(java.util.Queue<T> queue)
UnicastProcessor(java.util.Queue<T> queue, Cancellation onTerminate)
UnicastProcessor(java.util.Queue<T> queue, java.util.function.Consumer<? super T> onOverflow, Cancellation onTerminate)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	clear()
static <T> UnicastProcessor<T>	create() Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.
static <T> UnicastProcessor<T>	create(java.util.Queue<T> queue) Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.
static <T> UnicastProcessor<T>	create(java.util.Queue<T> queue, Cancellation endcallback) Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.
static <T> UnicastProcessor<T>	create(java.util.Queue<T> queue, java.util.function.Consumer<? super T> onOverflow, Cancellation endcallback) Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.
java.lang.Object	downstream() Return the direct data receiver.
long	getCapacity() Return defined element capacity
java.lang.Throwable	getError() Current error if any, default to null
long	getPrefetch() The prefetch configuration of the Flux
boolean	isCancelled()
boolean	isEmpty()
boolean	isStarted() Has this upstream started or "onSubscribed" ?
boolean	isTerminated() Has this upstream finished or "completed" / "failed" ?
void	onComplete()
void	onError(java.lang.Throwable t)
void	onNext(T t)
void	onSubscribe(org.reactivestreams.Subscription s)
T	poll()
void	request(long n)
long	requestedFromDownstream() Return defined element capacity, used to drive new Subscription request needs.
int	requestFusion(int requestedMode) Request a specific fusion mode from this QueueSubscription.
int	size()
void	subscribe(org.reactivestreams.Subscriber<? super T> s)
java.lang.Object	upstream() Return the direct source of data, Supports reference.

Methods inherited from class reactor.core.publisher.FluxProcessor

connect, connectSink, connectSink, serialize, switchOnNext, wrap

Methods inherited from class reactor.core.publisher.Flux

all, any, as, awaitOnSubscribe, blockFirst, blockFirst, blockFirstMillis, blockLast, blockLast, blockLastMillis, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferMillis, bufferMillis, bufferMillis, bufferMillis, bufferMillis, bufferMillis, bufferMillis, cache, cache, cache, cache, cancelOn, cast, collect, collect, collectList, collectMap, collectMap, collectMap, collectMultimap, collectMultimap, collectMultimap, collectSortedList, collectSortedList, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapIterable, concatMapIterable, concatWith, count, create, create, defaultIfEmpty, defer, delay, delayMillis, delayMillis, delaySubscription, delaySubscription, delaySubscriptionMillis, delaySubscriptionMillis, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doAfterTerminate, doOnCancel, doOnComplete, doOnError, doOnError, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elapsed, elapsed, elementAt, elementAt, empty, error, error, filter, firstEmitting, firstEmitting, firstEmittingWith, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, from, fromArray, fromIterable, fromStream, generate, generate, generate, groupBy, groupBy, groupJoin, handle, hasElement, hasElements, hide, ignoreElements, interval, interval, intervalMillis, intervalMillis, intervalMillis, intervalMillis, join, just, just, last, last, log, log, log, log, map, mapError, mapError, mapError, materialize, merge, merge, merge, merge, merge, merge, mergeWith, never, next, ofType, onAssembly, onAssembly, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureError, onBackpressureLatest, onErrorResumeWith, onErrorResumeWith, onErrorResumeWith, onErrorReturn, onErrorReturn, onErrorReturn, onTerminateDetach, parallel, parallel, parallel, publish, publish, publish, publish, publishNext, publishOn, publishOn, range, reduce, reduce, reduceWith, repeat, repeat, repeat, repeat, repeatWhen, replay, replay, replay, replay, replayMillis, replayMillis, retry, retry, retry, retry, retryWhen, sample, sample, sampleFirst, sampleFirst, sampleFirstMillis, sampleMillis, sampleTimeout, sampleTimeout, scan, scan, scanWith, share, single, single, singleOrEmpty, skip, skip, skipLast, skipMillis, skipMillis, skipUntil, skipUntilOther, skipWhile, sort, sort, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, switchIfEmpty, switchMap, switchMap, switchOnError, switchOnError, switchOnError, switchOnNext, switchOnNext, take, take, takeLast, takeMillis, takeMillis, takeUntil, takeUntilOther, takeWhile, then, then, then, thenMany, thenMany, timeout, timeout, timeout, timeout, timeout, timeoutMillis, timeoutMillis, timeoutMillis, timeoutMillis, timestamp, timestamp, toIterable, toIterable, toIterable, toStream, toStream, toString, transform, using, using, window, window, window, window, window, window, window, window, windowMillis, windowMillis, windowMillis, windowMillis, windowMillis, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith, zipWith, zipWith, zipWithIterable, zipWithIterable

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.Fuseable.QueueSubscription

add, addAll, contains, containsAll, element, iterator, offer, peek, remove, remove, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface reactor.core.Trackable

expectedFromUpstream, getPending, limit

Constructor Detail

UnicastProcessor

public UnicastProcessor(java.util.Queue<T> queue)

UnicastProcessor

public UnicastProcessor(java.util.Queue<T> queue,
                        Cancellation onTerminate)

UnicastProcessor

public UnicastProcessor(java.util.Queue<T> queue,
                        java.util.function.Consumer<? super T> onOverflow,
                        Cancellation onTerminate)

Method Detail

create

public static <T> UnicastProcessor<T> create()

Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.

Type Parameters:

T - the relayed type

Returns:

a unicast FluxProcessor

create

public static <T> UnicastProcessor<T> create(java.util.Queue<T> queue)

Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.

Type Parameters:

T - the relayed type

Parameters:

queue - the buffering queue

Returns:

a unicast FluxProcessor

create

public static <T> UnicastProcessor<T> create(java.util.Queue<T> queue,
                                             Cancellation endcallback)

Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.

Type Parameters:

T - the relayed type

Parameters:

queue - the buffering queue

endcallback - called on any terminal signal

Returns:

a unicast FluxProcessor

create

public static <T> UnicastProcessor<T> create(java.util.Queue<T> queue,
                                             java.util.function.Consumer<? super T> onOverflow,
                                             Cancellation endcallback)

Create a unicast FluxProcessor that will buffer on a given queue in an unbounded fashion.

Type Parameters:

T - the relayed type

Parameters:

queue - the buffering queue

endcallback - called on any terminal signal

onOverflow - called when queue.offer return false and unicastProcessor is about to emit onError.

Returns:

a unicast FluxProcessor

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription s)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<T>

getPrefetch

public long getPrefetch()

Description copied from class: Flux

The prefetch configuration of the Flux

Overrides:

getPrefetch in class Flux<T>

Returns:

the prefetch configuration of the Flux, -1L if unspecified

onNext

public void onNext(T t)

Specified by:

onNext in interface org.reactivestreams.Subscriber<T>

onError

public void onError(java.lang.Throwable t)

Specified by:

onError in interface org.reactivestreams.Subscriber<T>

onComplete

public void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<T>

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> s)

Specified by:

subscribe in interface org.reactivestreams.Publisher<T>

Overrides:

subscribe in class FluxProcessor<T,T>

request

public void request(long n)

Specified by:

request in interface org.reactivestreams.Subscription

cancel

public void cancel()

Specified by:

cancel in interface org.reactivestreams.Subscription

poll

public T poll()

Specified by:

poll in interface java.util.Queue<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

requestFusion

public int requestFusion(int requestedMode)

Description copied from interface: Fuseable.QueueSubscription

Request a specific fusion mode from this QueueSubscription.

One should request either SYNC, ASYNC or ANY modes (never NONE) and the implementor should return NONE, SYNC or ASYNC (never ANY).

For example, if a source supports only ASYNC fusion but the intermediate operator supports only SYNC fuseable sources, the operator may request SYNC fusion and the source can reject it via NONE, thus the operator can return NONE as well to dowstream and the fusion doesn't happen.

Specified by:

requestFusion in interface Fuseable.QueueSubscription<T>

Parameters:

requestedMode - the mode to request

Returns:

the fusion mode activated

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Trackable

Returns:

has the downstream "cancelled" and interrupted its consuming ?

isStarted

public boolean isStarted()

Description copied from interface: Trackable

Has this upstream started or "onSubscribed" ?

Specified by:

isStarted in interface Trackable

Returns:

has this upstream started or "onSubscribed" ?

isTerminated

public boolean isTerminated()

Description copied from interface: Trackable

Has this upstream finished or "completed" / "failed" ?

Specified by:

isTerminated in interface Trackable

Returns:

has this upstream finished or "completed" / "failed" ?

getError

public java.lang.Throwable getError()

Description copied from interface: Trackable

Current error if any, default to null

Specified by:

getError in interface Trackable

Returns:

Current error if any, default to null

downstream

public java.lang.Object downstream()

Description copied from interface: Producer

Return the direct data receiver.

Specified by:

downstream in interface Producer

Returns:

the direct data receiver

upstream

public java.lang.Object upstream()

Description copied from interface: Receiver

Return the direct source of data, Supports reference.

Specified by:

upstream in interface Receiver

Returns:

the direct source of data, Supports reference.

getCapacity

public long getCapacity()

Description copied from interface: Trackable

Return defined element capacity

Specified by:

getCapacity in interface Trackable

Overrides:

getCapacity in class FluxProcessor<T,T>

Returns:

long capacity

requestedFromDownstream

public long requestedFromDownstream()

Description copied from interface: Trackable

Return defined element capacity, used to drive new Subscription request needs. This is the maximum in-flight data allowed to transit to this elements.

Specified by:

requestedFromDownstream in interface Trackable

Returns:

long capacity