reactor.core.subscriber

Enum Subscribers

java.lang.Object

java.lang.Enum<Subscribers>

reactor.core.subscriber.Subscribers

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Subscribers>

public enum Subscribers
extends java.lang.Enum<Subscribers>

A Reactive Streams Subscriber factory which callbacks on start, onNext, onError and shutdown

The Publisher will directly forward all the signals passed to the subscribers and complete when onComplete is called.

Create such publisher with the provided factory, E.g.:

 
 Flux.just("hello")
     .subscribe( Subscribers.unbounded(System.out::println) );
 
 

Since:

2.0.3, 2.5

Method Summary

Modifier and Type	Method and Description
static <T> LambdaSubscriber<T>	bounded(int prefetch, java.util.function.Consumer<? super T> callback) Create a bounded LambdaSubscriber that will keep a maximum in-flight items running.
static <T> LambdaSubscriber<T>	bounded(int prefetch, java.util.function.Consumer<? super T> callback, java.util.function.Consumer<? super java.lang.Throwable> errorCallback, java.lang.Runnable completeCallback) Create a bounded LambdaSubscriber that will keep a maximum in-flight items running.
static <T> org.reactivestreams.Subscriber<T>	consumer(java.util.function.Consumer<? super T> dataConsumer) Create a Subscriber reacting onNext.
static <T> org.reactivestreams.Subscriber<T>	consumer(java.util.function.Consumer<? super T> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer) Create a Subscriber reacting onNext and onError.
static <T> org.reactivestreams.Subscriber<T>	consumer(java.util.function.Consumer<? super T> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer, java.lang.Runnable completeConsumer) Create a Subscriber reacting onNext, onError and onComplete.
static <T> org.reactivestreams.Subscriber<T>	create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler) Create a Subscriber reacting onSubscribe with the passed Consumer
static <T> org.reactivestreams.Subscriber<T>	create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler, java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer) Create a Subscriber reacting onSubscribe and onNext
static <T> org.reactivestreams.Subscriber<T>	create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler, java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer) Create a Subscriber reacting onNext, onError.
static <T> org.reactivestreams.Subscriber<T>	create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler, java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer, java.lang.Runnable completeConsumer) Create a Subscriber reacting onNext, onSubscribe, onError, onComplete with the passed BiConsumer.
static <T> org.reactivestreams.Subscriber<T>	serialize(org.reactivestreams.Subscriber<? super T> subscriber) Safely gate a Subscriber by a serializing Subscriber.
static <T> org.reactivestreams.Subscriber<T>	unbounded() Create a Subscriber that will automatically request Long.MAX_VALUE onSubscribe.
static <T> org.reactivestreams.Subscriber<T>	unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer) Create a Subscriber reacting onNext.
static <T> org.reactivestreams.Subscriber<T>	unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer) Create a Subscriber reacting onNext and onError.
static <T> org.reactivestreams.Subscriber<T>	unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer, java.util.function.Consumer<? super java.lang.Throwable> errorConsumer, java.lang.Runnable completeConsumer) Create a Subscriber reacting onNext, onError and onComplete.
static Subscribers	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Subscribers[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static Subscribers[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Subscribers c : Subscribers.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Subscribers valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

bounded

public static <T> LambdaSubscriber<T> bounded(int prefetch,
                                              java.util.function.Consumer<? super T> callback)

Create a bounded LambdaSubscriber that will keep a maximum in-flight items running. The prefetch strategy works with a first request N, then when 25% of N is left to be received on onNext, request N x 0.75.

Type Parameters:

T - the consumed sequence type

Parameters:

prefetch - the in-flight capacity used to request source Publisher

callback - an onNext Consumer callback

Returns:

a bounded LambdaSubscriber

bounded

public static <T> LambdaSubscriber<T> bounded(int prefetch,
                                              java.util.function.Consumer<? super T> callback,
                                              java.util.function.Consumer<? super java.lang.Throwable> errorCallback,
                                              java.lang.Runnable completeCallback)

Create a bounded LambdaSubscriber that will keep a maximum in-flight items running. The prefetch strategy works with a first request N, then when 25% of N is left to be received on onNext, request N x 0.75.

Type Parameters:

T - the consumed sequence type

Parameters:

prefetch - the in-flight capacity used to request source Publisher

callback - an onNext Consumer callback

errorCallback - an onError Consumer callback

completeCallback - an onComplete Consumer callback

Returns:

a bounded LambdaSubscriber

consumer

public static <T> org.reactivestreams.Subscriber<T> consumer(java.util.function.Consumer<? super T> dataConsumer)

Create a Subscriber reacting onNext. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A Consumer with argument onNext data

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

consumer

public static <T> org.reactivestreams.Subscriber<T> consumer(java.util.function.Consumer<? super T> dataConsumer,
                                                             java.util.function.Consumer<? super java.lang.Throwable> errorConsumer)

Create a Subscriber reacting onNext and onError. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A Consumer with argument onNext data

errorConsumer - A Consumer called onError

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

consumer

public static <T> org.reactivestreams.Subscriber<T> consumer(java.util.function.Consumer<? super T> dataConsumer,
                                                             java.util.function.Consumer<? super java.lang.Throwable> errorConsumer,
                                                             java.lang.Runnable completeConsumer)

Create a Subscriber reacting onNext, onError and onComplete. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A Consumer with argument onNext data

errorConsumer - A Consumer called onError

completeConsumer - A Runnable called onComplete with the actual context if any

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

create

public static <T> org.reactivestreams.Subscriber<T> create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler)

Create a Subscriber reacting onSubscribe with the passed Consumer

Type Parameters:

T - The type of the data sequence

Parameters:

subscriptionHandler - A Consumer called once for every new subscription returning (IO connection...)

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

create

public static <T> org.reactivestreams.Subscriber<T> create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler,
                                                           java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer)

Create a Subscriber reacting onSubscribe and onNext

Type Parameters:

T - The type of the data sequence

Parameters:

subscriptionHandler - A Consumer called once for every new subscription context

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

create

public static <T> org.reactivestreams.Subscriber<T> create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler,
                                                           java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer,
                                                           java.util.function.Consumer<? super java.lang.Throwable> errorConsumer)

Create a Subscriber reacting onNext, onError.

Type Parameters:

T - The type of the data sequence

Parameters:

subscriptionHandler - A Consumer called once for every new subscription context

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

errorConsumer - A Consumer called onError

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

create

public static <T> org.reactivestreams.Subscriber<T> create(java.util.function.Consumer<? super org.reactivestreams.Subscription> subscriptionHandler,
                                                           java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer,
                                                           java.util.function.Consumer<? super java.lang.Throwable> errorConsumer,
                                                           java.lang.Runnable completeConsumer)

Create a Subscriber reacting onNext, onSubscribe, onError, onComplete with the passed BiConsumer. The argument subscriptionHandler is executed once by new subscriber to generate a context shared by every request calls. The argument shutdownConsumer is executed once by subscriber termination event (cancel, onComplete, onError).

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

subscriptionHandler - A Function called once for every new subscription returning an immutable context (IO connection...)

errorConsumer - A BiConsumer called onError with the actual error

completeConsumer - A Runnable called onComplete with the actual

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

serialize

public static <T> org.reactivestreams.Subscriber<T> serialize(org.reactivestreams.Subscriber<? super T> subscriber)

Safely gate a Subscriber by a serializing Subscriber. Serialization uses thread-stealing and a potentially unbounded queue that might starve a calling thread if races are too important and Subscriber is slower.

Type Parameters:

T - the relayed type

Parameters:

subscriber - the subscriber to wrap

Returns:

a serializing Subscriber

unbounded

public static <T> org.reactivestreams.Subscriber<T> unbounded()

Create a Subscriber that will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

unbounded

public static <T> org.reactivestreams.Subscriber<T> unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer)

Create a Subscriber reacting onNext. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

unbounded

public static <T> org.reactivestreams.Subscriber<T> unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer,
                                                              java.util.function.Consumer<? super java.lang.Throwable> errorConsumer)

Create a Subscriber reacting onNext and onError. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

errorConsumer - A Consumer called onError

Returns:

a fresh Reactive Streams subscriber ready to be subscribed

unbounded

public static <T> org.reactivestreams.Subscriber<T> unbounded(java.util.function.BiConsumer<? super T,? super org.reactivestreams.Subscription> dataConsumer,
                                                              java.util.function.Consumer<? super java.lang.Throwable> errorConsumer,
                                                              java.lang.Runnable completeConsumer)

Create a Subscriber reacting onNext, onError and onComplete. The subscriber will automatically request Long.MAX_VALUE onSubscribe.

The argument subscriptionHandler is executed once by new subscriber to generate a context shared by every request calls.

Type Parameters:

T - The type of the data sequence

Parameters:

dataConsumer - A BiConsumer with left argument onNext data and right argument upstream subscription

errorConsumer - A Consumer called onError

completeConsumer - A Runnable called onComplete

Returns:

a fresh Reactive Streams subscriber ready to be subscribed