Top Description Inners Fields Constructors Methods
reactor.core.publisher

pack-priv final Class FluxDoFinally<T>

extends InternalFluxOperator<T, T>
Class Inheritance
Type Parameters
<T>
the value type
Imports
java.util.concurrent.atomic.AtomicIntegerFieldUpdater, java.util.function.Consumer, org.reactivestreams.Subscription, reactor.core.CoreSubscriber, .Exceptions, .Fuseable, .Fuseable.ConditionalSubscriber, .Fuseable.QueueSubscription, reactor.util.annotation.Nullable

Hook into the lifecycle events and signals of a Flux and execute a provided callback after any of onComplete, onError and cancel events. The hook is executed only once and receives the event type that triggered it (SignalType#ON_COMPLETE, SignalType#ON_ERROR or SignalType#CANCEL).

Note that any exception thrown by the hook are caught and bubbled up using Operators#onErrorDropped(Throwable, reactor.util.context.Context).

Author
Simon Baslé

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv final Consumer<SignalType>
Inherited from reactor.core.publisher.InternalFluxOperator:
optimizableOperator

Constructor Summary

AccessConstructor and Description
pack-priv
FluxDoFinally(Flux<? extends T> source, Consumer<SignalType> onFinally)

Method Summary

Modifier and TypeMethod and Description
pack-priv static <T> CoreSubscriber<T>
public Object
scanUnsafe(Scannable.Attr<T>
a Attr to resolve for the component.
key
)

Overrides reactor.core.publisher.InternalFluxOperator.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.
public CoreSubscriber<? super T>
subscribeOrReturn(CoreSubscriber<? super T> actual)

Implements abstract reactor.core.publisher.InternalFluxOperator.subscribeOrReturn.

Implements reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Allow delegation of the subscription by returning a CoreSubscriber, or force subscription encapsulation by returning null.
Inherited from reactor.core.publisher.InternalFluxOperator:
nextOptimizableSourcesourcesubscribe

Field Detail

onFinallyback to summary
pack-priv final Consumer<SignalType> onFinally

Constructor Detail

FluxDoFinallyback to summary
pack-priv FluxDoFinally(Flux<? extends T> source, Consumer<SignalType> onFinally)

Method Detail

createSubscriberback to summary
pack-priv static <T> CoreSubscriber<T> createSubscriber(CoreSubscriber<? super T> s, Consumer<SignalType> onFinally)
Annotations
@SuppressWarnings:unchecked
scanUnsafeback to summary
public Object scanUnsafe(Scannable.Attr<T> key)

Overrides reactor.core.publisher.InternalFluxOperator.scanUnsafe.

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
subscribeOrReturnback to summary
public CoreSubscriber<? super T> subscribeOrReturn(CoreSubscriber<? super T> actual)

Implements abstract reactor.core.publisher.InternalFluxOperator.subscribeOrReturn.

Implements reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Doc from reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Allow delegation of the subscription by returning a CoreSubscriber, or force subscription encapsulation by returning null. This can be used in conjunction with nextOptimizableSource() to perform subscription in a loop instead of by recursion.

Returns:CoreSubscriber<? super T>

next CoreSubscriber or "null" if the subscription was already done inside the method

Annotations
@Override
reactor.core.publisher back to summary

pack-priv final Class FluxDoFinally.DoFinallyConditionalSubscriber<T>

extends FluxDoFinally.DoFinallySubscriber<T>
implements Fuseable.ConditionalSubscriber<T>
Class Inheritance
All Implemented Interfaces
reactor.core.Fuseable.ConditionalSubscriber, reactor.core.CoreSubscriber, org.reactivestreams.Subscriber

Field Summary

Inherited from reactor.core.publisher.FluxDoFinally.DoFinallySubscriber:
actualonceONCEonFinallys

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
tryOnNext(T
the value to consume, not null
t
)

Implements reactor.core.Fuseable.ConditionalSubscriber.tryOnNext.

Try consuming the value and return true if successful.
Inherited from reactor.core.publisher.FluxDoFinally.DoFinallySubscriber:
actualcancelonCompleteonErroronNextonSubscriberequestrunFinallyscanUnsafe

Constructor Detail

DoFinallyConditionalSubscriberback to summary
pack-priv DoFinallyConditionalSubscriber(Fuseable.ConditionalSubscriber<? super T> actual, Consumer<SignalType> onFinally)

Method Detail

tryOnNextback to summary
public boolean tryOnNext(T t)

Implements reactor.core.Fuseable.ConditionalSubscriber.tryOnNext.

Doc from reactor.core.Fuseable.ConditionalSubscriber.tryOnNext.

Try consuming the value and return true if successful.

Parameters
t:T

the value to consume, not null

Returns:boolean

true if consumed, false if dropped and a new value can be immediately sent

Annotations
@Override
@SuppressWarnings:unchecked
reactor.core.publisher back to summary

pack-priv Class FluxDoFinally.DoFinallySubscriber<T>

extends Object
implements InnerOperator<T, T>
Class Inheritance
All Implemented Interfaces
reactor.core.publisher.InnerOperator, reactor.core.publisher.InnerProducer, org.reactivestreams.Subscription, reactor.core.Scannable, reactor.core.publisher.InnerConsumer, reactor.core.CoreSubscriber, org.reactivestreams.Subscriber
Known Direct Subclasses
reactor.core.publisher.FluxDoFinally.DoFinallyConditionalSubscriber

Field Summary

Modifier and TypeField and Description
pack-priv final CoreSubscriber<? super T>
pack-priv volatile int
pack-priv static final AtomicIntegerFieldUpdater<FluxDoFinally.DoFinallySubscriber<T>>
pack-priv final Consumer<SignalType>
pack-priv Subscription
s

Constructor Summary

AccessConstructor and Description
pack-priv
DoFinallySubscriber(CoreSubscriber<? super T> actual, Consumer<SignalType> onFinally)

Method Summary

Modifier and TypeMethod and Description
public CoreSubscriber<? super T>
public void
cancel()

Implements org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.
public void
onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Successful terminal state.
public void
onError(Throwable
the throwable signaled
t
)

Implements org.reactivestreams.Subscriber.onError.

Failed terminal state.
public void
onNext(T
the element signaled
t
)

Implements org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).
public void
onSubscribe(Subscription
the Subscription that allows requesting data via Subscription#request(long)
s
)

Implements reactor.core.CoreSubscriber.onSubscribe.

Implementors should initialize any state used by onNext(Object) before calling Subscription#request(long).
public void
request(long
the strictly positive number of elements to requests to the upstream Publisher
n
)

Implements org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.
pack-priv void
runFinally(SignalType signalType)

public Object
scanUnsafe(Scannable.Attr<T>
a Attr to resolve for the component.
key
)

Overrides default reactor.core.publisher.InnerProducer.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actualback to summary
pack-priv final CoreSubscriber<? super T> actual
onceback to summary
pack-priv volatile int once
ONCEback to summary
pack-priv static final AtomicIntegerFieldUpdater<FluxDoFinally.DoFinallySubscriber<T>> ONCE
Annotations
@SuppressWarnings:rawtypes
onFinallyback to summary
pack-priv final Consumer<SignalType> onFinally
sback to summary
pack-priv Subscription s

Constructor Detail

DoFinallySubscriberback to summary
pack-priv DoFinallySubscriber(CoreSubscriber<? super T> actual, Consumer<SignalType> onFinally)

Method Detail

actualback to summary
public CoreSubscriber<? super T> actual()

Implements reactor.core.publisher.InnerProducer.actual.

Annotations
@Override
cancelback to summary
public void cancel()

Implements org.reactivestreams.Subscription.cancel.

Doc from org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.

Data may still be sent to meet previously signalled demand after calling cancel.

Annotations
@Override
onCompleteback to summary
public void onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Doc from org.reactivestreams.Subscriber.onComplete.

Successful terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Annotations
@Override
onErrorback to summary
public void onError(Throwable t)

Implements org.reactivestreams.Subscriber.onError.

Doc from org.reactivestreams.Subscriber.onError.

Failed terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Parameters
t:Throwable

the throwable signaled

Annotations
@Override
onNextback to summary
public void onNext(T t)

Implements org.reactivestreams.Subscriber.onNext.

Doc from org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).

Parameters
t:T

the element signaled

Annotations
@Override
onSubscribeback to summary
public void onSubscribe(Subscription s)

Implements reactor.core.CoreSubscriber.onSubscribe.

Doc from reactor.core.CoreSubscriber.onSubscribe.

Implementors should initialize any state used by 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 reactor.util.Logger. Invoked after calling Publisher#subscribe(Subscriber).

No data will start flowing until Subscription#request(long) is invoked.

It is the responsibility of this Subscriber instance to call Subscription#request(long) whenever more data is wanted.

The Publisher will send notifications only in response to Subscription#request(long).

Parameters
s:Subscription

Doc from org.reactivestreams.Subscriber.onSubscribe.

the Subscription that allows requesting data via Subscription#request(long)

Annotations
@Override
requestback to summary
public void request(long n)

Implements org.reactivestreams.Subscription.request.

Doc from org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.

It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the Publisher as "effectively unbounded".

Whatever has been requested can be sent by the Publisher so only signal demand for what can be safely handled.

A Publisher can send less than is requested if the stream ends but then must emit either Subscriber#onError(Throwable) or Subscriber#onComplete().

Parameters
n:long

the strictly positive number of elements to requests to the upstream Publisher

Annotations
@Override
runFinallyback to summary
pack-priv void runFinally(SignalType signalType)
scanUnsafeback to summary
public Object scanUnsafe(Scannable.Attr<T> key)

Overrides default reactor.core.publisher.InnerProducer.scanUnsafe.

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