EmitterProcessor (reactor-core 3.4.0-RC2)

java.lang.Object
- reactor.core.publisher.Flux<OUT>
- - reactor.core.publisher.FluxProcessor<T,T>
  - - reactor.core.publisher.EmitterProcessor<T>

Type Parameters:

T - the input and output value type

All Implemented Interfaces:

Processor<T,T>, Publisher<T>, Subscriber<T>, CorePublisher<T>, CoreSubscriber<T>, Disposable, Scannable
Deprecated.
To be removed in 3.5. Prefer clear cut usage of Sinks through variations of Sinks.many().multicast().onBackpressureBuffer(). This processor was blocking in onNext(Object). This behaviour can be implemented with the Sinks API by calling Sinks.Many.tryEmitNext(Object) and retrying, e.g.:
```
 while (sink.tryEmitNext(v).hasFailed()) {
     LockSupport.parkNanos(10);
 }
 
```
```
@Deprecated
public final class EmitterProcessor<T>
extends FluxProcessor<T,T>
```
An implementation of a message-passing Processor implementing publish-subscribe with synchronous (thread-stealing and happen-before interactions) drain loops.
The default create() factories will only produce the new elements observed in the parent sequence after a given Subscriber is subscribed.

Author:

Stephane Maldini

Nested Class Summary
- Nested classes/interfaces inherited from interface reactor.core.Scannable
  Scannable.Attr<T>
- Nested classes/interfaces inherited from interface reactor.core.Disposable
  Disposable.Composite, Disposable.Swap

Field Summary
- Fields inherited from interface reactor.core.Scannable
  OPERATOR_NAME_UNRELATED_WORDS_PATTERN

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Flux<T>`	`asFlux()` Deprecated. Return a `Flux` view of this sink.
`static <E> EmitterProcessor<E>`	`create()` Deprecated. Create a new `EmitterProcessor` using `Queues.SMALL_BUFFER_SIZE` backlog size and auto-cancel.
`static <E> EmitterProcessor<E>`	`create(boolean autoCancel)` Deprecated. Create a new `EmitterProcessor` using `Queues.SMALL_BUFFER_SIZE` backlog size and the provided auto-cancel.
`static <E> EmitterProcessor<E>`	`create(int bufferSize)` Deprecated. Create a new `EmitterProcessor` using the provided backlog size, with auto-cancel.
`static <E> EmitterProcessor<E>`	`create(int bufferSize, boolean autoCancel)` Deprecated. Create a new `EmitterProcessor` using the provided backlog size and auto-cancellation.
`Context`	`currentContext()` Deprecated. Request a `Context` from dependent components which can include downstream operators during subscribing or a terminal `Subscriber`.
`int`	`currentSubscriberCount()` Deprecated. Get how many `Subscribers` are currently subscribed to the sink.
`long`	`downstreamCount()` Deprecated. Return the number of active `Subscriber` or -1 if untracked.
`default void`	`emitComplete(Sinks.EmitFailureHandler failureHandler)` Terminate the sequence successfully, generating an `onComplete` signal.
`default void`	`emitError(Throwable error, Sinks.EmitFailureHandler failureHandler)` Fail the sequence, generating an `onError` signal.
`default void`	`emitNext(T value, Sinks.EmitFailureHandler failureHandler)` Emit a non-null element, generating an `onNext` signal, or notifies the downstream subscriber(s) of a failure to do so via `Sinks.Many.emitError(Throwable, Sinks.EmitFailureHandler)` (with an `overflow exception`).
`int`	`getBufferSize()` Deprecated. Return the processor buffer capacity if any or `Integer.MAX_VALUE`
`Throwable`	`getError()` Deprecated. Current error if any, default to null
`int`	`getPending()` Deprecated. Return the number of parked elements in the emitter backlog.
`int`	`getPrefetch()` Deprecated. The prefetch configuration of the `Flux`
`Stream<? extends Scannable>`	`inners()` Deprecated. Return a `Stream` of referenced inners (flatmap, multicast etc)
`boolean`	`isCancelled()` Deprecated.
`boolean`	`isDisposed()` Deprecated. Optionally return true when the resource or task is disposed.
`protected boolean`	`isIdentityProcessor()` Deprecated. Return true if `FluxProcessor<T, T>`
`boolean`	`isTerminated()` Deprecated. Has this upstream finished or "completed" / "failed" ?
`void`	`onComplete()` Deprecated.
`void`	`onError(Throwable throwable)` Deprecated.
`void`	`onNext(T t)` Deprecated.
`void`	`onSubscribe(Subscription s)` Deprecated. Implementors should initialize any state used by `Subscriber.onNext(Object)` before calling `Subscription.request(long)`.
`Object`	`scanUnsafe(Scannable.Attr key)` Deprecated. This method is used internally by components to define their key-value mappings in a single place.
`void`	`subscribe(CoreSubscriber<? super T> actual)` Deprecated. An internal `Publisher.subscribe(Subscriber)` that will bypass `Hooks.onLastOperator(Function)` pointcut.
`Sinks.EmitResult`	`tryEmitComplete()` Deprecated. Try to terminate the sequence successfully, generating an `onComplete` signal.
`Sinks.EmitResult`	`tryEmitError(Throwable t)` Deprecated. Try to fail the sequence, generating an `onError` signal.
`Sinks.EmitResult`	`tryEmitNext(T t)` Deprecated. Try emitting a non-null element, generating an `onNext` signal.

Methods inherited from class reactor.core.publisher.FluxProcessor
dispose, hasCompleted, hasDownstreams, hasError, isSerialized, serialize, serializeAlways, sink, sink, switchOnNext, wrap

Methods inherited from class reactor.core.publisher.Flux
all, any, as, blockFirst, blockFirst, blockLast, blockLast, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferTimeout, bufferTimeout, bufferTimeout, bufferTimeout, bufferUntil, bufferUntil, bufferUntilChanged, bufferUntilChanged, bufferUntilChanged, bufferWhen, bufferWhen, bufferWhile, cache, cache, cache, cache, cache, cache, cancelOn, cast, checkpoint, checkpoint, checkpoint, collect, collect, collectList, collectMap, collectMap, collectMap, collectMultimap, collectMultimap, collectMultimap, collectSortedList, collectSortedList, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapIterable, concatMapIterable, concatWith, concatWithValues, contextWrite, contextWrite, count, create, create, defaultIfEmpty, defer, deferContextual, deferWithContext, delayElements, delayElements, delaySequence, delaySequence, delaySubscription, delaySubscription, delaySubscription, delayUntil, dematerialize, distinct, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterTerminate, doFinally, doFirst, doOnCancel, doOnComplete, doOnDiscard, doOnEach, doOnError, doOnError, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elapsed, elapsed, elementAt, elementAt, empty, error, error, error, expand, expand, expandDeep, expandDeep, filter, filterWhen, filterWhen, first, first, firstWithSignal, firstWithSignal, firstWithValue, firstWithValue, flatMap, flatMap, flatMap, flatMap, flatMapDelayError, flatMapIterable, flatMapIterable, flatMapSequential, flatMapSequential, flatMapSequential, flatMapSequentialDelayError, from, fromArray, fromIterable, fromStream, fromStream, generate, generate, generate, groupBy, groupBy, groupBy, groupBy, groupJoin, handle, hasElement, hasElements, hide, ignoreElements, index, index, interval, interval, interval, interval, join, just, just, last, last, limitRate, limitRate, limitRequest, log, log, log, log, log, log, map, materialize, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeOrdered, mergeOrdered, mergeOrdered, mergeOrderedWith, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequentialDelayError, mergeSequentialDelayError, mergeSequentialDelayError, mergeWith, metrics, name, never, next, ofType, onAssembly, onAssembly, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureError, onBackpressureLatest, onErrorContinue, onErrorContinue, onErrorContinue, onErrorMap, onErrorMap, onErrorMap, onErrorResume, onErrorResume, onErrorResume, onErrorReturn, onErrorReturn, onErrorReturn, onErrorStop, onTerminateDetach, or, parallel, parallel, parallel, publish, publish, publish, publish, publishNext, publishOn, publishOn, publishOn, push, push, range, reduce, reduce, reduceWith, repeat, repeat, repeat, repeat, repeatWhen, replay, replay, replay, replay, replay, replay, retry, retry, retryWhen, sample, sample, sampleFirst, sampleFirst, sampleTimeout, sampleTimeout, scan, scan, scanWith, share, shareNext, single, single, singleOrEmpty, skip, skip, skip, skipLast, skipUntil, skipUntilOther, skipWhile, sort, sort, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeOn, subscriberContext, subscriberContext, subscribeWith, switchIfEmpty, switchMap, switchMap, switchOnFirst, switchOnFirst, switchOnNext, switchOnNext, tag, take, take, take, takeLast, takeUntil, takeUntilOther, takeWhile, then, then, thenEmpty, thenMany, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timestamp, timestamp, toIterable, toIterable, toIterable, toStream, toStream, toString, transform, transformDeferred, transformDeferredContextual, using, using, usingWhen, usingWhen, window, window, window, window, window, window, window, windowTimeout, windowTimeout, windowUntil, windowUntil, windowUntil, windowUntilChanged, windowUntilChanged, windowUntilChanged, windowWhen, windowWhile, windowWhile, withLatestFrom, zip, 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.Scannable
actuals, from, isScanAvailable, name, parents, scan, scanOrDefault, stepName, steps, tags

Methods inherited from interface org.reactivestreams.Publisher
subscribe

- Method Detail
  - create
```
public static <E> EmitterProcessor<E> create()
```
    Deprecated.
    
    Create a new EmitterProcessor using Queues.SMALL_BUFFER_SIZE backlog size and auto-cancel.
    
    Type Parameters:
    
    E - Type of processed signals
    
    Returns:
    
    a fresh processor
  - create
```
public static <E> EmitterProcessor<E> create(boolean autoCancel)
```
    Deprecated.
    
    Create a new EmitterProcessor using Queues.SMALL_BUFFER_SIZE backlog size and the provided auto-cancel.
    
    Type Parameters:
    
    E - Type of processed signals
    
    Parameters:
    
    autoCancel - automatically cancel
    
    Returns:
    
    a fresh processor
  - create
```
public static <E> EmitterProcessor<E> create(int bufferSize)
```
    Deprecated.
    
    Create a new EmitterProcessor using the provided backlog size, with auto-cancel.
    
    Type Parameters:
    
    E - Type of processed signals
    
    Parameters:
    
    bufferSize - the internal buffer size to hold signals
    
    Returns:
    
    a fresh processor
  - create
```
public static <E> EmitterProcessor<E> create(int bufferSize,
                                             boolean autoCancel)
```
    Deprecated.
    
    Create a new EmitterProcessor using the provided backlog size and auto-cancellation.
    
    Type Parameters:
    
    E - Type of processed signals
    
    Parameters:
    
    bufferSize - the internal buffer size to hold signals
    
    autoCancel - automatically cancel
    
    Returns:
    
    a fresh processor
  - inners
```
public Stream<? extends Scannable> inners()
```
    Deprecated.
    
    Description copied from interface: Scannable
    
    Return a Stream of referenced inners (flatmap, multicast etc)
    
    Specified by:
    
    inners in interface Scannable
    
    Overrides:
    
    inners in class FluxProcessor<T,T>
    
    Returns:
    
    a Stream of referenced inners (flatmap, multicast etc)
  - currentContext
```
public Context currentContext()
```
    Deprecated.
    
    Description copied from interface: CoreSubscriber
    
    Request a Context from dependent components which can include downstream operators during subscribing or a terminal Subscriber.
    
    Specified by:
    
    currentContext in interface CoreSubscriber<T>
    
    Overrides:
    
    currentContext in class FluxProcessor<T,T>
    
    Returns:
    
    a resolved context or Context.empty()
  - subscribe
```
public void subscribe(CoreSubscriber<? super T> actual)
```
    Deprecated.
    
    Description copied from class: Flux
    
    An internal Publisher.subscribe(Subscriber) that will bypass Hooks.onLastOperator(Function) pointcut.
    In addition to behave as expected by Publisher.subscribe(Subscriber) in a controlled manner, it supports direct subscribe-time Context passing.
    
    Specified by:
    
    subscribe in interface CorePublisher<T>
    
    Specified by:
    
    subscribe in class Flux<T>
    
    Parameters:
    
    actual - the Subscriber interested into the published sequence
    
    See Also:
    
    Flux.subscribe(Subscriber)
  - onComplete
```
public void onComplete()
```
    Deprecated.
    
    Specified by:
    
    onComplete in interface Subscriber<T>
  - tryEmitComplete
```
public Sinks.EmitResult tryEmitComplete()
```
    Deprecated.
    
    Description copied from interface: Sinks.Many
    
    Try to terminate the sequence successfully, generating an onComplete signal. The result of the attempt is represented as an Sinks.EmitResult, which possibly indicates error cases.
    
    Returns:
    
    an Sinks.EmitResult, which should be checked to distinguish different possible failures
    
    See Also:
    
    Subscriber.onComplete()
  - onError
```
public void onError(Throwable throwable)
```
    Deprecated.
    
    Specified by:
    
    onError in interface Subscriber<T>
  - tryEmitError
```
public Sinks.EmitResult tryEmitError(Throwable t)
```
    Deprecated.
    
    Description copied from interface: Sinks.Many
    
    Try to fail the sequence, generating an onError signal. The result of the attempt is represented as an Sinks.EmitResult, which possibly indicates error cases.
    
    Parameters:
    
    t - the exception to signal, not null
    
    Returns:
    
    an Sinks.EmitResult, which should be checked to distinguish different possible failures
    
    See Also:
    
    Subscriber.onError(Throwable)
  - onNext
```
public void onNext(T t)
```
    Deprecated.
    
    Specified by:
    
    onNext in interface Subscriber<T>
  - tryEmitNext
```
public Sinks.EmitResult tryEmitNext(T t)
```
    Deprecated.
    
    Description copied from interface: Sinks.Many
    
    Try emitting a non-null element, generating an onNext signal. The result of the attempt is represented as an Sinks.EmitResult, which possibly indicates error cases.
    Might throw an unchecked exception in case of a fatal error downstream which cannot be propagated to any asynchronous handler (aka a bubbling exception).
    
    Parameters:
    
    t - the value to emit, not null
    
    Returns:
    
    an Sinks.EmitResult, which should be checked to distinguish different possible failures
    
    See Also:
    
    Subscriber.onNext(Object)
  - currentSubscriberCount
```
public int currentSubscriberCount()
```
    Deprecated.
    
    Description copied from interface: Sinks.Many
    
    Get how many Subscribers are currently subscribed to the sink.
    This is a best effort peek at the sink state, and a subsequent attempt at emitting to the sink might still return Sinks.EmitResult.FAIL_ZERO_SUBSCRIBER where relevant. (generally in Sinks.Many.tryEmitNext(Object)). Request (and lack thereof) isn't taken into account, all registered subscribers are counted.
    
    Returns:
    
    the number of subscribers at the time of invocation
  - asFlux
```
public Flux<T> asFlux()
```
    Deprecated.
    
    Description copied from interface: Sinks.Many
    
    Return a Flux view of this sink. Every call returns the same instance.
    
    Returns:
    
    the Flux view associated to this Sinks.Many
  - isIdentityProcessor
```
protected boolean isIdentityProcessor()
```
    Deprecated.
    
    Description copied from class: FluxProcessor
    
    Return true if FluxProcessor<T, T>
    
    Overrides:
    
    isIdentityProcessor in class FluxProcessor<T,T>
    
    Returns:
    
    true if FluxProcessor<T, T>
  - getPending
```
public int getPending()
```
    Deprecated.
    
    Return the number of parked elements in the emitter backlog.
    
    Returns:
    
    the number of parked elements in the emitter backlog.
  - isDisposed
```
public boolean isDisposed()
```
    Deprecated.
    
    Description copied from interface: Disposable
    
    Optionally return true when the resource or task is disposed.
    Implementations are not required to track disposition and as such may never return true even when disposed. However, they MUST only return true when there's a guarantee the resource or task is disposed.
    
    Specified by:
    
    isDisposed in interface Disposable
    
    Returns:
    
    true when there's a guarantee the resource or task is disposed.
  - onSubscribe
```
public void onSubscribe(Subscription s)
```
    Deprecated.
    
    Description copied from interface: CoreSubscriber
    
    Implementors should initialize any state used by Subscriber.onNext(Object) before calling Subscription.request(long). Should further onNext related state modification occur, thread-safety will be required.
    Note that an invalid request <= 0 will not produce an onError and will simply be ignored or reported through a debug-enabled Logger.
    
    Specified by:
    
    onSubscribe in interface Subscriber<T>
    
    Specified by:
    
    onSubscribe in interface CoreSubscriber<T>
  - getError
```
@Nullable
public Throwable getError()
```
    Deprecated.
    
    Description copied from class: FluxProcessor
    
    Current error if any, default to null
    
    Overrides:
    
    getError in class FluxProcessor<T,T>
    
    Returns:
    
    Current error if any, default to null
  - isCancelled
```
public boolean isCancelled()
```
    Deprecated.
    
    Returns:
    
    true if all subscribers have actually been cancelled and the processor auto shut down
  - getBufferSize
```
public final int getBufferSize()
```
    Deprecated.
    
    Description copied from class: FluxProcessor
    
    Return the processor buffer capacity if any or Integer.MAX_VALUE
    
    Overrides:
    
    getBufferSize in class FluxProcessor<T,T>
    
    Returns:
    
    processor buffer capacity if any or Integer.MAX_VALUE
  - isTerminated
```
public boolean isTerminated()
```
    Deprecated.
    
    Description copied from class: FluxProcessor
    
    Has this upstream finished or "completed" / "failed" ?
    
    Overrides:
    
    isTerminated in class FluxProcessor<T,T>
    
    Returns:
    
    has this upstream finished or "completed" / "failed" ?
  - getPrefetch
```
public int getPrefetch()
```
    Deprecated.
    
    Description copied from class: Flux
    
    The prefetch configuration of the Flux
    
    Overrides:
    
    getPrefetch in class Flux<T>
    
    Returns:
    
    the prefetch configuration of the Flux, -1 if unspecified
  - scanUnsafe
```
@Nullable
public Object scanUnsafe(Scannable.Attr key)
```
    Deprecated.
    
    Description copied from interface: Scannable
    
    This method is used internally by components to define their key-value mappings in a single place. Although it is ignoring the generic type of the Scannable.Attr key, implementors should take care to return values of the correct type, and return null if no specific value is available.
    For public consumption of attributes, prefer using Scannable.scan(Attr), which will return a typed value and fall back to the key's default if the component didn't define any mapping.
    
    Specified by:
    
    scanUnsafe in interface Scannable
    
    Overrides:
    
    scanUnsafe in class FluxProcessor<T,T>
    
    Parameters:
    
    key - a Scannable.Attr to resolve for the component.
    
    Returns:
    
    the value associated to the key for that specific component, or null if none.
  - downstreamCount
```
public long downstreamCount()
```
    Deprecated.
    
    Description copied from class: FluxProcessor
    
    Return the number of active Subscriber or -1 if untracked.
    
    Overrides:
    
    downstreamCount in class FluxProcessor<T,T>
    
    Returns:
    
    the number of active Subscriber or -1 if untracked
  - emitNext
```
public void emitNext(T value,
                     Sinks.EmitFailureHandler failureHandler)
```
    Description copied from interface: Sinks.Many
    
    Emit a non-null element, generating an onNext signal, or notifies the downstream subscriber(s) of a failure to do so via Sinks.Many.emitError(Throwable, Sinks.EmitFailureHandler) (with an overflow exception).
    Generally, Sinks.Many.tryEmitNext(Object) is preferable since it allows a custom handling of error cases, although this implies checking the returned Sinks.EmitResult and correctly acting on it (see implementation notes).
    Might throw an unchecked exception in case of a fatal error downstream which cannot be propagated to any asynchronous handler (aka a bubbling exception).
    
    Specified by:
    
    emitNext in interface Sinks.Many<T>
    
    Parameters:
    
    value - the value to emit, not null
    
    failureHandler - the failure handler that allows retrying failed Sinks.EmitResult.
    
    See Also:
    
    Sinks.Many.tryEmitNext(Object), Subscriber.onNext(Object)
  - emitComplete
```
public void emitComplete(Sinks.EmitFailureHandler failureHandler)
```
    Description copied from interface: Sinks.Many
    
    Terminate the sequence successfully, generating an onComplete signal.
    Generally, Sinks.Many.tryEmitComplete() is preferable, since it allows a custom handling of error cases.
    
    Specified by:
    
    emitComplete in interface Sinks.Many<T>
    
    Parameters:
    
    failureHandler - the failure handler that allows retrying failed Sinks.EmitResult.
    
    See Also:
    
    Sinks.Many.tryEmitComplete(), Subscriber.onComplete()
  - emitError
```
public void emitError(Throwable error,
                      Sinks.EmitFailureHandler failureHandler)
```
    Description copied from interface: Sinks.Many
    
    Fail the sequence, generating an onError signal.
    Generally, Sinks.Many.tryEmitError(Throwable) is preferable since it allows a custom handling of error cases, although this implies checking the returned Sinks.EmitResult and correctly acting on it (see implementation notes).
    
    Specified by:
    
    emitError in interface Sinks.Many<T>
    
    Parameters:
    
    error - the exception to signal, not null
    
    failureHandler - the failure handler that allows retrying failed Sinks.EmitResult.
    
    See Also:
    
    Sinks.Many.tryEmitError(Throwable), Subscriber.onError(Throwable)

Class EmitterProcessor<T>

Nested Class Summary

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

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

Field Summary

Fields inherited from interface reactor.core.Scannable

Method Summary

Methods inherited from class reactor.core.publisher.FluxProcessor

Methods inherited from class reactor.core.publisher.Flux

Methods inherited from class java.lang.Object

Methods inherited from interface reactor.core.Scannable

Methods inherited from interface org.reactivestreams.Publisher

Method Detail

create

create

create

create

inners

currentContext

subscribe

onComplete

tryEmitComplete

onError

tryEmitError

onNext

tryEmitNext

currentSubscriberCount

asFlux

isIdentityProcessor

getPending

isDisposed

onSubscribe

getError

isCancelled

getBufferSize

isTerminated

getPrefetch

scanUnsafe

downstreamCount

emitNext

emitComplete

emitError