Reactor Core 3.6.0 · reactor.core.publisher.FluxProcessor

Access	Constructor and Description
public	FluxProcessor()

Access

Constructor and Description

public

FluxProcessor()

Method Summary

Modifier and Type	Method and Description
public Context	currentContext() Overrides default reactor.core.CoreSubscriber.currentContext. Implements reactor.core.publisher.ContextHolder.currentContext. Request a `Context` from dependent components which can include downstream operators during subscribing or a terminal `org.reactivestreams.Subscriber`.
public void	dispose() Implements reactor.core.Disposable.dispose. Cancel or dispose the underlying task or resource.
public long	Returns: the number of active `Subscriber` or -1 if untracked downstreamCount() Return the number of active `Subscriber` or -1 if untracked.
public int	Returns: processor buffer capacity if any or `Integer#MAX_VALUE` getBufferSize() Return the processor buffer capacity if any or `Integer#MAX_VALUE`
public Throwable	Returns: Current error if any, default to null getError() Current error if any, default to null
public final boolean	Returns: true if terminated with onComplete hasCompleted() Return true if terminated with onComplete
public boolean	Returns: true if any `Subscriber` is actively subscribed hasDownstreams() Return true if any `Subscriber` is actively subscribed
public final boolean	Returns: true if terminated with onError hasError() Return true if terminated with onError
public Stream<? extends Scannable>	inners() Overrides default reactor.core.Scannable.inners. Return a `Stream` of referenced inners (flatmap, multicast etc)
protected boolean	Returns: true if `FluxProcessor<T, T>` isIdentityProcessor() Return true if `FluxProcessor<T, T>`
public boolean	Returns: true if this `FluxProcessor` supports multithread producing isSerialized() Return true if this `FluxProcessor` supports multithread producing
public boolean	Returns: has this upstream finished or "completed" / "failed" ? isTerminated() Has this upstream finished or "completed" / "failed" ?
public Object	scanUnsafe(Scannable.Attr<T> a `Attr` to resolve for the component. key) Implements reactor.core.Scannable.scanUnsafe. This method is used internally by components to define their key-value mappings in a single place.
public final FluxProcessor<IN, OUT>	Returns: a serializing `FluxProcessor` serialize() Deprecated as a consequence of `FluxProcessor` being deprecated. Create a `FluxProcessor` that safely gates multi-threaded producer `Subscriber#onNext(Object)`.
protected boolean	Returns: true to serialize any sink, false to delay serialization till onRequest serializeAlways() Returns serialization strategy.
public final FluxSink<IN>	Returns: a serializing `FluxSink` sink() Deprecated To be removed in 3.5, prefer clear cut usage of `Sinks` through the `Sinks#many()` spec. Create a `FluxSink` that safely gates multi-threaded producer `Subscriber#onNext(Object)`.
public final FluxSink<IN>	Returns: a serializing `FluxSink` sink(FluxSink.OverflowStrategy the overflow strategy, see `FluxSink.OverflowStrategy` for the available strategies strategy) Deprecated To be removed in 3.5, prefer clear cut usage of `Sinks` through the `Sinks#many()` spec. Create a `FluxSink` that safely gates multi-threaded producer `Subscriber#onNext(Object)`.
public static < the produced type T> FluxProcessor<Publisher<? extends T>, T>	Returns: a `FluxProcessor` accepting publishers and producing T switchOnNext() Deprecated should use `Sinks`, `Many#asFlux()` and `Flux#switchOnNext(Publisher)`. Build a `FluxProcessor` whose data are emitted by the most recent emitted `Publisher`.
public static < the receiving type IN, the producing type OUT> FluxProcessor<IN, OUT>	Returns: a new blackboxed `FluxProcessor` wrap(final Subscriber<IN> the upstream subscriber upstream, final Publisher<OUT> the downstream publisher downstream) Deprecated as a consequence of `FluxProcessor` being deprecated. Transform a receiving `Subscriber` and a producing `Publisher` in a logical `FluxProcessor`.

Modifier and Type

Method and Description

public Context

currentContext()

Overrides default reactor.core.CoreSubscriber.currentContext.

Implements reactor.core.publisher.ContextHolder.currentContext.

Request a Context from dependent components which can include downstream operators during subscribing or a terminal org.reactivestreams.Subscriber.

public void

dispose()

Implements reactor.core.Disposable.dispose.

Cancel or dispose the underlying task or resource.

public long

Returns:

the number of active Subscriber or -1 if untracked

downstreamCount()

Return the number of active Subscriber or -1 if untracked.

public int

Returns:

processor buffer capacity if any or Integer#MAX_VALUE

getBufferSize()

Return the processor buffer capacity if any or Integer#MAX_VALUE

public Throwable

Returns:

Current error if any, default to null

getError()

Current error if any, default to null

public final boolean

Returns:

true if terminated with onComplete

hasCompleted()

Return true if terminated with onComplete

public boolean

Returns:

true if any Subscriber is actively subscribed

hasDownstreams()

Return true if any Subscriber is actively subscribed

public final boolean

Returns:

true if terminated with onError

hasError()

Return true if terminated with onError

public Stream<? extends Scannable>

inners()

Overrides default reactor.core.Scannable.inners.

Return a Stream of referenced inners (flatmap, multicast etc)

protected boolean

Returns:

true if FluxProcessor<T, T>

isIdentityProcessor()

Return true if FluxProcessor<T, T>

public boolean

Returns:

true if this FluxProcessor supports multithread producing

isSerialized()

Return true if this FluxProcessor supports multithread producing

public boolean

Returns:

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

isTerminated()

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

public Object

scanUnsafe(Scannable.Attr<T>

a Attr to resolve for the component.

key)

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.

public final FluxProcessor<IN, OUT>

Returns:

a serializing FluxProcessor

serialize()

Deprecated as a consequence of FluxProcessor being deprecated.

Create a FluxProcessor that safely gates multi-threaded producer Subscriber#onNext(Object).

protected boolean

Returns:

true to serialize any sink, false to delay serialization till onRequest

serializeAlways()

Returns serialization strategy.

public final FluxSink<IN>

Returns:

a serializing FluxSink

sink()

Deprecated To be removed in 3.5, prefer clear cut usage of Sinks through the Sinks#many() spec.

Create a FluxSink that safely gates multi-threaded producer Subscriber#onNext(Object).

public final FluxSink<IN>

Returns:

a serializing FluxSink

sink(FluxSink.OverflowStrategy

the overflow strategy, see FluxSink.OverflowStrategy for the available strategies

strategy)

Deprecated To be removed in 3.5, prefer clear cut usage of Sinks through the Sinks#many() spec.

Create a FluxSink that safely gates multi-threaded producer Subscriber#onNext(Object).

public static <

the produced type

T> FluxProcessor<Publisher<? extends T>, T>

Returns:

a FluxProcessor accepting publishers and producing T

switchOnNext()

Deprecated should use Sinks, Many#asFlux() and Flux#switchOnNext(Publisher).

Build a FluxProcessor whose data are emitted by the most recent emitted Publisher.

public static <

the receiving type

IN,

the producing type

OUT> FluxProcessor<IN, OUT>

Returns:

a new blackboxed FluxProcessor

wrap(final Subscriber<IN>

the upstream subscriber

upstream, final Publisher<OUT>

the downstream publisher

downstream)

Deprecated as a consequence of FluxProcessor being deprecated.

Transform a receiving Subscriber and a producing Publisher in a logical FluxProcessor.

FluxProcessor	back to summary
public FluxProcessor()

FluxProcessor

back to summary

public FluxProcessor()

Method Detail

currentContext back to summary

currentContext	back to summary
public Context currentContext() Overrides default reactor.core.CoreSubscriber.currentContext. Implements reactor.core.publisher.ContextHolder.currentContext. Doc from reactor.core.CoreSubscriber.currentContext. Request a `Context` from dependent components which can include downstream operators during subscribing or a terminal `org.reactivestreams.Subscriber`. Returns:Context a resolved context or `Context#empty()` Annotations @Override

public Context currentContext()

Overrides default reactor.core.CoreSubscriber.currentContext.

Implements reactor.core.publisher.ContextHolder.currentContext.

Doc from reactor.core.CoreSubscriber.currentContext.

Request a Context from dependent components which can include downstream operators during subscribing or a terminal org.reactivestreams.Subscriber.

Returns:Context

a resolved context or Context#empty()

Annotations

@Override

dispose	back to summary
public void dispose() Implements reactor.core.Disposable.dispose. Doc from reactor.core.Disposable.dispose. Cancel or dispose the underlying task or resource. Implementations are required to make this method idempotent. Annotations @Override

dispose

back to summary

public void dispose()

Implements reactor.core.Disposable.dispose.

Doc from reactor.core.Disposable.dispose.

Cancel or dispose the underlying task or resource.

Implementations are required to make this method idempotent.

Annotations

@Override

downstreamCount back to summary

downstreamCount	back to summary
public long downstreamCount() Return the number of active `Subscriber` or -1 if untracked. Returns:long the number of active `Subscriber` or -1 if untracked

public long downstreamCount()

Return the number of active Subscriber or -1 if untracked.

Returns:long: the number of active Subscriber or -1 if untracked

getBufferSize back to summary

getBufferSize	back to summary
public int getBufferSize() Return the processor buffer capacity if any or `Integer#MAX_VALUE` Returns:int processor buffer capacity if any or `Integer#MAX_VALUE`

public int getBufferSize()

Return the processor buffer capacity if any or Integer#MAX_VALUE

Returns:int: processor buffer capacity if any or Integer#MAX_VALUE

getError	back to summary
public Throwable getError() Current error if any, default to null Returns:Throwable Current error if any, default to null Annotations @Nullable

getError

back to summary

public Throwable getError()

Current error if any, default to null

Returns:Throwable

Current error if any, default to null

Annotations

@Nullable

hasCompleted	back to summary
public final boolean hasCompleted() Return true if terminated with onComplete Returns:boolean true if terminated with onComplete

hasCompleted

back to summary

public final boolean hasCompleted()

Return true if terminated with onComplete

Returns:boolean: true if terminated with onComplete

hasDownstreams back to summary

hasDownstreams	back to summary
public boolean hasDownstreams() Return true if any `Subscriber` is actively subscribed Returns:boolean true if any `Subscriber` is actively subscribed

public boolean hasDownstreams()

Return true if any Subscriber is actively subscribed

Returns:boolean: true if any Subscriber is actively subscribed

hasError	back to summary
public final boolean hasError() Return true if terminated with onError Returns:boolean true if terminated with onError

hasError

back to summary

public final boolean hasError()

Return true if terminated with onError

Returns:boolean: true if terminated with onError

inners back to summary

inners	back to summary
public Stream<? extends Scannable> inners() Overrides default reactor.core.Scannable.inners. Doc from reactor.core.Scannable.inners. Return a `Stream` of referenced inners (flatmap, multicast etc) Returns:Stream<? extends Scannable> a `Stream` of referenced inners (flatmap, multicast etc) Annotations @Override

public Stream<? extends Scannable> inners()

Overrides default reactor.core.Scannable.inners.

Doc from reactor.core.Scannable.inners.

Return a Stream of referenced inners (flatmap, multicast etc)

Returns:Stream<? extends Scannable>

a Stream of referenced inners (flatmap, multicast etc)

Annotations

@Override

isIdentityProcessor back to summary

isIdentityProcessor	back to summary
protected boolean isIdentityProcessor() Return true if `FluxProcessor<T, T>` Returns:boolean true if `FluxProcessor<T, T>`

protected boolean isIdentityProcessor()

Return true if FluxProcessor<T, T>

Returns:boolean: true if FluxProcessor<T, T>

isSerialized back to summary

isSerialized	back to summary
public boolean isSerialized() Return true if this `FluxProcessor` supports multithread producing Returns:boolean true if this `FluxProcessor` supports multithread producing

public boolean isSerialized()

Return true if this FluxProcessor supports multithread producing

Returns:boolean: true if this FluxProcessor supports multithread producing

isTerminated	back to summary
public boolean isTerminated() Has this upstream finished or "completed" / "failed" ? Returns:boolean has this upstream finished or "completed" / "failed" ?

isTerminated

back to summary

public boolean isTerminated()

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

Returns:boolean: has this upstream finished or "completed" / "failed" ?

scanUnsafe back to summary

scanUnsafe	back to summary
public Object scanUnsafe(Scannable.Attr<T> key) Implements reactor.core.Scannable.scanUnsafe. Doc from reactor.core.Scannable.scanUnsafe. 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 `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 `scan(Attr)`, which will return a typed value and fall back to the key's default if the component didn't define any mapping. Parameters key:Scannable.Attr<T> a `Attr` to resolve for the component. Returns:Object the value associated to the key for that specific component, or null if none. Annotations @Override @Nullable

public Object scanUnsafe(Scannable.Attr<T> key)

Implements reactor.core.Scannable.scanUnsafe.

Doc from reactor.core.Scannable.scanUnsafe.

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 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 scan(Attr), which will return a typed value and fall back to the key's default if the component didn't define any mapping.

Parameters

key:Scannable.Attr<T>: a Attr to resolve for the component.

Returns:Object

the value associated to the key for that specific component, or null if none.

Annotations

@Override
@Nullable

serialize back to summary

serialize	back to summary
public final FluxProcessor<IN, OUT> serialize() Deprecated as a consequence of `FluxProcessor` being deprecated. See corresponding docs for further information. Create a `FluxProcessor` that safely gates multi-threaded producer `Subscriber#onNext(Object)`. Discard Support: The resulting processor discards elements received from the source `Publisher` (if any) when it cancels subscription to said source. Returns:FluxProcessor<IN, OUT> a serializing `FluxProcessor`

public final FluxProcessor<IN, OUT> serialize()

Deprecated

as a consequence of FluxProcessor being deprecated. See corresponding docs for further information.

Create a FluxProcessor that safely gates multi-threaded producer Subscriber#onNext(Object).

Discard Support: The resulting processor discards elements received from the source Publisher (if any) when it cancels subscription to said source.

Returns:FluxProcessor<IN, OUT>: a serializing FluxProcessor

serializeAlways back to summary

serializeAlways	back to summary
protected boolean serializeAlways() Returns serialization strategy. If true, `FluxProcessor#sink()` will always be serialized. Otherwise sink is serialized only if `FluxSink#onRequest(java.util.function.LongConsumer)` is invoked. Returns:boolean true to serialize any sink, false to delay serialization till onRequest

protected boolean serializeAlways()

Returns serialization strategy. If true, FluxProcessor#sink() will always be serialized. Otherwise sink is serialized only if FluxSink#onRequest(java.util.function.LongConsumer) is invoked.

Returns:boolean: true to serialize any sink, false to delay serialization till onRequest

sink back to summary

sink	back to summary
public final FluxSink<IN> sink() Deprecated To be removed in 3.5, prefer clear cut usage of `Sinks` through the `Sinks#many()` spec. Create a `FluxSink` that safely gates multi-threaded producer `Subscriber#onNext(Object)`. This processor will be subscribed to that `FluxSink`, and any previous subscribers will be unsubscribed. The returned `FluxSink` will not apply any `FluxSink.OverflowStrategy` and overflowing `FluxSink#next(Object)` will behave in two possible ways depending on the Processor: an unbounded processor will handle the overflow itself by dropping or buffering a bounded processor will block/spin Returns:FluxSink<IN> a serializing `FluxSink` Annotations @Deprecated

public final FluxSink<IN> sink()

Deprecated

To be removed in 3.5, prefer clear cut usage of Sinks through the Sinks#many() spec.

Create a FluxSink that safely gates multi-threaded producer Subscriber#onNext(Object). This processor will be subscribed to that FluxSink, and any previous subscribers will be unsubscribed.

The returned FluxSink will not apply any FluxSink.OverflowStrategy and overflowing FluxSink#next(Object) will behave in two possible ways depending on the Processor:

an unbounded processor will handle the overflow itself by dropping or buffering
a bounded processor will block/spin

Returns:FluxSink<IN>

a serializing FluxSink

Annotations

@Deprecated

sink back to summary

sink	back to summary
public final FluxSink<IN> sink(FluxSink.OverflowStrategy strategy) Deprecated To be removed in 3.5, prefer clear cut usage of `Sinks` through the `Sinks#many()` spec. Create a `FluxSink` that safely gates multi-threaded producer `Subscriber#onNext(Object)`. This processor will be subscribed to that `FluxSink`, and any previous subscribers will be unsubscribed. The returned `FluxSink` will not apply any `FluxSink.OverflowStrategy` and overflowing `FluxSink#next(Object)` will behave in two possible ways depending on the Processor: an unbounded processor will handle the overflow itself by dropping or buffering a bounded processor will block/spin on IGNORE strategy, or apply the strategy behavior Parameters strategy:FluxSink.OverflowStrategy the overflow strategy, see `FluxSink.OverflowStrategy` for the available strategies Returns:FluxSink<IN> a serializing `FluxSink` Annotations @Deprecated

public final FluxSink<IN> sink(FluxSink.OverflowStrategy strategy)

Deprecated

To be removed in 3.5, prefer clear cut usage of Sinks through the Sinks#many() spec.

Create a FluxSink that safely gates multi-threaded producer Subscriber#onNext(Object). This processor will be subscribed to that FluxSink, and any previous subscribers will be unsubscribed.

The returned FluxSink will not apply any FluxSink.OverflowStrategy and overflowing FluxSink#next(Object) will behave in two possible ways depending on the Processor:

an unbounded processor will handle the overflow itself by dropping or buffering
a bounded processor will block/spin on IGNORE strategy, or apply the strategy behavior

Parameters

strategy:FluxSink.OverflowStrategy: the overflow strategy, see FluxSink.OverflowStrategy for the available strategies

Returns:FluxSink<IN>

a serializing FluxSink

Annotations

@Deprecated

switchOnNext back to summary

switchOnNext	back to summary
public static <T> FluxProcessor<Publisher<? extends T>, T> switchOnNext() Deprecated should use `Sinks`, `Many#asFlux()` and `Flux#switchOnNext(Publisher)`. To be removed in 3.5.0. Build a `FluxProcessor` whose data are emitted by the most recent emitted `Publisher`. The `Flux` will complete once both the publishers source and the last switched to `Publisher` have completed. Parameters <T> the produced type Returns:FluxProcessor<Publisher<? extends T>, T> a `FluxProcessor` accepting publishers and producing T Annotations @Deprecated

public static <T> FluxProcessor<Publisher<? extends T>, T> switchOnNext()

Deprecated

should use Sinks, Many#asFlux() and Flux#switchOnNext(Publisher). To be removed in 3.5.0.

Build a FluxProcessor whose data are emitted by the most recent emitted Publisher. The Flux will complete once both the publishers source and the last switched to Publisher have completed.

Parameters

<T>: the produced type

Returns:FluxProcessor<Publisher<? extends T>, T>

a FluxProcessor accepting publishers and producing T

Annotations

@Deprecated

wrap back to summary

wrap	back to summary
public static <IN, OUT> FluxProcessor<IN, OUT> wrap(final Subscriber<IN> upstream, final Publisher<OUT> downstream) Deprecated as a consequence of `FluxProcessor` being deprecated. See corresponding docs for further information. Transform a receiving `Subscriber` and a producing `Publisher` in a logical `FluxProcessor`. The link between the passed upstream and returned downstream will not be created automatically, e.g. not subscribed together. A `Processor` might choose to have orthogonal sequence input and output. Parameters <IN> the receiving type <OUT> the producing type upstream:Subscriber<IN> the upstream subscriber downstream:Publisher<OUT> the downstream publisher Returns:FluxProcessor<IN, OUT> a new blackboxed `FluxProcessor`

public static <IN, OUT> FluxProcessor<IN, OUT> wrap(final Subscriber<IN> upstream, final Publisher<OUT> downstream)

Deprecated

as a consequence of FluxProcessor being deprecated. See corresponding docs for further information.

Transform a receiving Subscriber and a producing Publisher in a logical FluxProcessor. The link between the passed upstream and returned downstream will not be created automatically, e.g. not subscribed together. A Processor might choose to have orthogonal sequence input and output.

Parameters

<IN>: the receiving type
<OUT>: the producing type
upstream:Subscriber<IN>: the upstream subscriber
downstream:Publisher<OUT>: the downstream publisher

Returns:FluxProcessor<IN, OUT>

a new blackboxed FluxProcessor

public abstract Class FluxProcessor<IN, OUT>

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail