Class DispatchStreamProcessor<T>

java.lang.Object

io.reactivex.rxjava4.processors.DispatchStreamProcessor<T>

Type Parameters:

T - the element type of the input and output values

All Implemented Interfaces:

Streamable<T>, StreamProcessor<T,T>, StreamSink<T>

public final class DispatchStreamProcessor<T>
extends Object
implements StreamProcessor<T,T>

Signals the various next(Object) and finish(Throwable) events to one or more downstream Streamers.

This is equivalent with to a PublishProcessor or MulticastProcessor, adapted to the Streamable world.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
DispatchStreamProcessor()

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	finish(@Nullable Throwable throwable)	Offer the final, terminal event.
@Nullable Throwable	getThrowable()	Returns the terminal Throwable if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).
boolean	hasComplete()	Returns true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).
boolean	hasStreamers()	Returns true if this StreamProcessor has Streamers.
boolean	hasThrowable()	Returns true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).
CompletionStage<Boolean>	next(T item)	Offer the next item.
@NonNull Streamer<@NonNull T>	stream(@NonNull StreamerCancellation cancellation)	Realizes the stream and returns an interface that lets one consume it.
int	streamerCount()	Returns the current number of Streamers subscribed to this StreamProcessor

Methods inherited from class Object

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

Methods inherited from interface Streamable

blockingFirst, blockingLast, collect, delay, doOnError, doOnNext, filter, flatMap, forEach, forEach, forEach, forEach, forEach, groupBy, hide, ignoreElements, intercept, last, lastOrError, lift, map, mapOptional, onErrorResumeNext, repeat, repeatWhen, retry, retry, retry, retryWhen, skip, subscribe, subscribe, subscribe, subscribe, take, takeUntil, takeWhile, test, test, timeout, to, toFlowable, toFlowable, toObservable, transform, transform

Modifier and Type	Method	Description
default T	blockingFirst()	Blocks the current thread until this Streamable produces one item, which is then returned.
default T	blockingLast()	Blocks the current thread until this Streamable produces all of its items and the very last is then returned.
default <A,R> @NonNull Streamable<R>	collect(@NonNull Collector<T,A,R> collector)	Collects all upstream values via the use of a Collector configuration and emits its resulting value as a single item of the returned Streamable.
default @NonNull Streamable<T>	delay(long time, @NonNull TimeUnit unit, @NonNull Scheduler scheduler)	Delays the delivery of each upstream item by the given time amount.
default @NonNull Streamable<T>	doOnError(@NonNull Consumer<? super Throwable> consumer)	Calls the specific Consumer if there is an error from the upstream.
default @NonNull Streamable<T>	doOnNext(@NonNull Consumer<? super T> consumer)	Calls the given consumer whenever an upstream item becomes available.
default @NonNull Streamable<T>	filter(@NonNull Predicate<? super T> predicate)	Filters out the upstream items that do not pass the given predicate.
default <R> @NonNull Streamable<R>	flatMap(@NonNull Function<? super T, ? extends Streamable<? extends R>> mapper, @NonNull StandardConcurrentConfig config)	Maps each upstream item onto a Streamable and runs them concurrently while relaying inner items as first-come-first-served manner.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull BiConsumer<? super T, ? super Disposable> consumer, @NonNull DisposableStreamerCancellation canceller, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super T> consumer)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super T> consumer, @NonNull DisposableStreamerCancellation canceller)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super T> consumer, @NonNull DisposableStreamerCancellation canceller, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default @NonNull CompletionStageDisposable<Void>	forEach(@NonNull Consumer<? super T> consumer, @NonNull ExecutorService executor)	Consumes elements from this Streamable via the provided executor service.
default <@Nullable K> @NonNull Streamable<GroupedStreamable<K,T>>	groupBy(@NonNull Function<? super T, ? extends @Nullable K> keySelector)	Maps each upstream item into a GroupedStreamable group, emits those groups and keeps relaying the upstream items into those groups.
default @NonNull Streamable<T>	hide()	Hides the identity of this Streamable and its Streamer.
default @NonNull Streamable<T>	ignoreElements()	Ignores all elements from the current Streamable and completes.
default @NonNull Streamable<T>	intercept(StreamableInterceptConfig<T> config)	Intercepts the lifecycle method calls of Streamable and Streamer and allows the modification of them via Function callbacks.
default @NonNull Single<T>	last(T defaultItem)	Signals the last item from the upstream Streamable or the provided defaultItem if the upstream is empty, as a Single instance.
default @NonNull Single<T>	lastOrError()	Signals the last item from the upstream Streamable or a NoSuchElementException if the upstream is empty, as a Single instance.
default <@NonNull R> @NonNull Streamable<R>	lift(@NonNull StreamableOperator<? super T, ? extends @NonNull R> lifter)	This method requires advanced knowledge about building operators, please consider other standard composition methods first; Returns a Streamable instance which when its Streamable.stream(StreamerCancellation) is invoked, applies the specified operator callback to the upstream Streamer to produce an actual Streamer instance to be handed downstream.
default <@NonNull R> @NonNull Streamable<R>	map(@NonNull Function<? super T, ? extends @NonNull R> mapper)	Maps each upstream item into another item via a mapper function.
default <@NonNull R> @NonNull Streamable<R>	mapOptional(@NonNull Function<? super T, ? extends Optional<? extends @NonNull R>> mapper)	Maps each upstream item into another, optional item via a mapper function that skips the empty optionals.
default @NonNull Streamable<T>	onErrorResumeNext(@NonNull Function<? super Throwable, ? extends Streamable<? extends T>> fallbackMapper)	When the upstream fails, the sequence is resumed by the Streamable that is returned for the failure Throwable.
default @NonNull Streamable<T>	repeat(long count)	Runs the upstream at most the given count times while it succeeds.
default @NonNull Streamable<T>	repeatWhen(Function<? super Long, ? extends CompletionStage<Boolean>> whenFunction)	Repeats the upstream when the given function signals true via the CompletionStage for the count how many times the upstream was streamed.
default @NonNull Streamable<T>	retry(long count)	Retries at most the given count times the upstream if it fails with any error.
default @NonNull Streamable<T>	retry(BiPredicate<? super Long, ? super Throwable> predicate)	Retries the upstream if the given predicate returns true for the failure count and Throwable of the last streaming of the upstream.
default @NonNull Streamable<T>	retry(Predicate<? super Throwable> predicate)	Retries the upstream if the given predicate returns true for the failure Throwable of the last streaming of the upstream.
default @NonNull Streamable<T>	retryWhen(BiFunction<? super Long, ? super Throwable, ? extends CompletionStage<Boolean>> whenFunction)	Retries the upstream when the given predicate signals true via the CompletionStage for the failure count and Throwable of the last streaming of the upstream.
default @NonNull Streamable<T>	skip(long count)	Skips the first count items and relays the rest to the downstream.
default @NonNull CompletionStage<Void>	subscribe(@NonNull StreamSink<? super T> consumer)	Relays the events of the upstream into a StreamSink consumer via the help of the standard Executors.newVirtualThreadPerTaskExecutor() as a mediator for pull-to-push.
default @NonNull CompletionStage<Void>	subscribe(@NonNull StreamSink<? super T> consumer, ExecutorService executor)	Relays the events of the upstream into a StreamSink consumer via the help of the given ExecutorService as a mediator for pull-to-push.
default void	subscribe(Flow.Subscriber<? super T> subscriber)	Consume this Streamable via the given flow-reactive-streams subscriber on a virtual thread backed executor service.
default void	subscribe(Flow.Subscriber<? super T> subscriber, @NonNull ExecutorService executor)	Consume this Streamable via the given flow-reactive-streams subscriber.
default @NonNull Streamable<T>	take(long count)	Takes at most the given number of items from the upstream and relays it to the downstream, then cancels the rest of the sequence.
default <U> @NonNull Streamable<T>	takeUntil(@NonNull Streamable<U> other)	Relays items from this Streamable until the other Streamable signals an item or completes.
default @NonNull Streamable<T>	takeWhile(@NonNull Predicate<? super T> predicate)	Relays items from this Streamable while the predicate returns true
default @NonNull TestSubscriber<T>	test()	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull TestSubscriber<T>	test(@NonNull ExecutorService executor)	Creates a new TestSubscriber and subscribes it to this Streamable.
default @NonNull Streamable<T>	timeout(long timeout, @NonNull TimeUnit unit, @NonNull Scheduler scheduler, @NonNull Streamable<T> fallback)	Applies a timeout to each upstream item and switches to the fallback Streamable if the upstream doesn't produce an item within the given timeout period.
default <@NonNull R> R	to(@NonNull StreamableConverter<T, ? extends @NonNull R> converter)	Calls the specified converter function during assembly time and returns its resulting value.
default @NonNull Flowable<T>	toFlowable()	Converts the streamable into a Flowable representation, running on the default Executors.newVirtualThreadPerTaskExecutor() virtual thread.
default @NonNull Flowable<T>	toFlowable(@NonNull ExecutorService executor)	Converts this Streamable into a Flowable representation, running on the provided executor service.
default @NonNull Observable<T>	toObservable()	Converts this Streamable into a Observable representation, emitting items on whatever thread produces items in the current Streamable.
default <@NonNull R> @NonNull Streamable<R>	transform(@NonNull VirtualTransformer<T, @NonNull R> transformer)	Transforms the upstream sequence into zero or more elements for the downstream.
default <@NonNull R> @NonNull Streamable<R>	transform(@NonNull VirtualTransformer<T, @NonNull R> transformer, @NonNull ExecutorService executor)	Transforms the upstream sequence into zero or more elements for the downstream.

Methods inherited from interface StreamSink

awaitFinish, awaitNext, cancellation, withCancellation

Modifier and Type	Method	Description
default void	awaitFinish(Throwable throwable)	Offer the final, terminal event and then awaits its consumption in a blocking fashion.
default boolean	awaitNext(T item)	Offers the given item and then awaits its consumption in a blocking fashion.
default @NonNull DisposableStreamerCancellation	cancellation()	Returns the DisposableContainer to use to detect if the consumer has indicated no more items it is willing to accept.
default @NonNull StreamSink<T>	withCancellation(DisposableStreamerCancellation cancellation)	Returns a new StreamSink that returns the given DisposableStreamerCancellation in its StreamSink.cancellation(), allowing overriding the cancellation management of this StreamSink

Constructor Details

DispatchStreamProcessor

public DispatchStreamProcessor()

Method Details

stream

@NonNull
public @NonNull Streamer<@NonNull T> stream(@NonNull
 @NonNull StreamerCancellation cancellation)

Description copied from interface: Streamable

Realizes the stream and returns an interface that lets one consume it.

Implementations are not meant to dispose the cancellation as it is the privilege of whatever calls the stream method. If you need to talk to other Streamables, use the StreamerCancellation.derive() to gain access to a fully fledged DisposableStreamerCancellation where you can dispose it without disposing the parent cancellation instance by accident.

It is recommened you StreamerCancellation.remove(Disposable) or StreamerCancellation.delete(Disposable) any extra resources you added via StreamerCancellation.add(Disposable) when your operator reaches the Streamer.finish() call.

Specified by:

stream in interface Streamable<T>

Parameters:

cancellation - where to register, check and listen for cancellation calls via its StreamerCancellation.isDisposed()

Returns:

the Streamer instance to consume.

next

public CompletionStage<Boolean> next(@NonNull
 T item)

Description copied from interface: StreamSink

Offer the next item.

Specified by:

next in interface StreamSink<T>

Parameters:

item - the item being offered

Returns:

a CompletionStage that completes with true if the value was successfully consumed, false if the value was rejected or exceptionally on error

finish

public CompletionStage<Void> finish(@Nullable
 @Nullable Throwable throwable)

Description copied from interface: StreamSink

Offer the final, terminal event.

Specified by:

finish in interface StreamSink<T>

Parameters:

throwable - the optional throwable to signal error, null to signal normal completion

Returns:

a CompletionStage that completes with null if the call succeeded or exceptionally on error

hasStreamers

public boolean hasStreamers()

Description copied from interface: StreamProcessor

Returns true if this StreamProcessor has Streamers.

Specified by:

hasStreamers in interface StreamProcessor<T,T>

Returns:

true if this StreamProcessor has Streamers.

streamerCount

public int streamerCount()

Description copied from interface: StreamProcessor

Returns the current number of Streamers subscribed to this StreamProcessor

Specified by:

streamerCount in interface StreamProcessor<T,T>

Returns:

the current number of Streamers subscribed to this StreamProcessor

hasComplete

public boolean hasComplete()

Description copied from interface: StreamProcessor

Returns true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).

Specified by:

hasComplete in interface StreamProcessor<T,T>

Returns:

true if this StreamProcessor was completed normally via StreamSink.finish(Throwable).

hasThrowable

public boolean hasThrowable()

Description copied from interface: StreamProcessor

Returns true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

Specified by:

hasThrowable in interface StreamProcessor<T,T>

Returns:

true if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

getThrowable

@Nullable
public @Nullable Throwable getThrowable()

Description copied from interface: StreamProcessor

Returns the terminal Throwable if this StreamProcessor was completed with a Throwable via StreamSink.finish(Throwable).

Specified by:

getThrowable in interface StreamProcessor<T,T>

Returns:

the Throwable if any