Top Description Inners Fields Constructors Methods
reactor.core.publisher

pack-priv final Class FluxTapRestoringThreadLocals<T, STATE>

extends FluxOperator<T, T>
Class Inheritance
Imports
io.micrometer.context.ContextSnapshot, org.reactivestreams.Subscription, reactor.core.CoreSubscriber, .Exceptions, .Fuseable.ConditionalSubscriber, reactor.core.observability.SignalListener, .SignalListenerFactory, reactor.util.annotation.Nullable, reactor.util.context.Context

A generic per-Subscription side effect Flux that notifies a SignalListener of most events.
Author
Simon Baslé

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv final STATE
pack-priv final SignalListenerFactory<T, STATE>
Inherited from reactor.core.publisher.FluxOperator:
source

Constructor Summary

AccessConstructor and Description
pack-priv
FluxTapRestoringThreadLocals(Flux<? extends T> source, SignalListenerFactory<T, STATE> tapFactory)

Method Summary

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

Overrides reactor.core.publisher.FluxOperator.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.
public void
subscribe(CoreSubscriber<? super T>
the Subscriber interested into the published sequence
actual
)

Implements abstract reactor.core.publisher.Flux.subscribe.

Implements reactor.core.CorePublisher.subscribe.

An internal Publisher#subscribe(Subscriber) that will bypass Hooks#onLastOperator(Function) pointcut.

Field Detail

commonTapStateback to summary
pack-priv final STATE commonTapState
tapFactoryback to summary
pack-priv final SignalListenerFactory<T, STATE> tapFactory

Constructor Detail

FluxTapRestoringThreadLocalsback to summary
pack-priv FluxTapRestoringThreadLocals(Flux<? extends T> source, SignalListenerFactory<T, STATE> tapFactory)

Method Detail

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

Overrides reactor.core.publisher.FluxOperator.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
@Nullable
@Override
subscribeback to summary
public void subscribe(CoreSubscriber<? super T> actual)

Implements abstract reactor.core.publisher.Flux.subscribe.

Implements reactor.core.CorePublisher.subscribe.

Doc from reactor.core.publisher.Flux.subscribe.

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.

Parameters
actual:CoreSubscriber<? super T>

the Subscriber interested into the published sequence

Annotations
@Override
reactor.core.publisher back to summary

pack-priv Class FluxTapRestoringThreadLocals.TapSubscriber<T>

extends Object
implements Fuseable.ConditionalSubscriber<T>, InnerOperator<T, T>
Class Inheritance
  • java.lang.Object
  • reactor.core.publisher.FluxTapRestoringThreadLocals.TapSubscriber
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, reactor.core.Fuseable.ConditionalSubscriber

Field Summary

Modifier and TypeField and Description
pack-priv final CoreSubscriber<? super T>
pack-priv final Fuseable.ConditionalSubscriber<? super T>
pack-priv final Context
pack-priv boolean
pack-priv final SignalListener<T>
pack-priv Subscription
s

Constructor Summary

AccessConstructor and Description
pack-priv
TapSubscriber(CoreSubscriber<? super T> actual, SignalListener<T> signalListener, Context ctx)

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 Context
currentContext()

Overrides default reactor.core.CoreSubscriber.currentContext, reactor.core.publisher.InnerOperator.currentContext.

Request a Context from dependent components which can include downstream operators during subscribing or a terminal org.reactivestreams.Subscriber.
protected void
handleListenerErrorAndTerminate(Throwable
the exception thrown from a handler method
listenerError
)

Cancel the active subscription, pass the listener error to SignalListener#handleListenerError(Throwable) and then terminate the downstream directly with same error (without invoking any other handler).

protected void
handleListenerErrorMultipleAndTerminate(Throwable
the exception thrown from a handler method
listenerError
,
Throwable
the exception that was about to occur when handler was invoked
originalError
)

Cancel the active subscription, pass the listener error to SignalListener#handleListenerError(Throwable), combine it with the original error and then terminate the downstream directly this combined exception (without invoking any other handler).

protected void
handleListenerErrorPostTermination(Throwable
the exception thrown from a handler method happening after sequence termination
listenerError
)

After the downstream is considered terminated (or cancelled), pass the listener error to SignalListener#handleListenerError(Throwable) then drop that error.

protected void
handleListenerErrorPreSubscription(Throwable
the exception thrown from a handler method before the subscription was set
listenerError
,
Subscription
the Subscription that was prepared but not sent downstream
toCancel
)

Cancel the prepared subscription, pass the listener error to SignalListener#handleListenerError(Throwable) and then terminate the downstream directly with same error (without invoking any other handler).

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.
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.
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 java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actualback to summary
pack-priv final CoreSubscriber<? super T> actual
actualConditionalback to summary
pack-priv final Fuseable.ConditionalSubscriber<? super T> actualConditional
contextback to summary
pack-priv final Context context
doneback to summary
pack-priv boolean done
listenerback to summary
pack-priv final SignalListener<T> listener
sback to summary
pack-priv Subscription s

Constructor Detail

TapSubscriberback to summary
pack-priv TapSubscriber(CoreSubscriber<? super T> actual, SignalListener<T> signalListener, Context ctx)

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
currentContextback to summary
public Context currentContext()

Overrides default reactor.core.CoreSubscriber.currentContext, reactor.core.publisher.InnerOperator.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
handleListenerErrorAndTerminateback to summary
protected void handleListenerErrorAndTerminate(Throwable listenerError)

Cancel the active subscription, pass the listener error to SignalListener#handleListenerError(Throwable) and then terminate the downstream directly with same error (without invoking any other handler).

Parameters
listenerError:Throwable

the exception thrown from a handler method

handleListenerErrorMultipleAndTerminateback to summary
protected void handleListenerErrorMultipleAndTerminate(Throwable listenerError, Throwable originalError)

Cancel the active subscription, pass the listener error to SignalListener#handleListenerError(Throwable), combine it with the original error and then terminate the downstream directly this combined exception (without invoking any other handler).

Parameters
listenerError:Throwable

the exception thrown from a handler method

originalError:Throwable

the exception that was about to occur when handler was invoked

handleListenerErrorPostTerminationback to summary
protected void handleListenerErrorPostTermination(Throwable listenerError)

After the downstream is considered terminated (or cancelled), pass the listener error to SignalListener#handleListenerError(Throwable) then drop that error.

Parameters
listenerError:Throwable

the exception thrown from a handler method happening after sequence termination

handleListenerErrorPreSubscriptionback to summary
protected void handleListenerErrorPreSubscription(Throwable listenerError, Subscription toCancel)

Cancel the prepared subscription, pass the listener error to SignalListener#handleListenerError(Throwable) and then terminate the downstream directly with same error (without invoking any other handler).

Parameters
listenerError:Throwable

the exception thrown from a handler method before the subscription was set

toCancel:Subscription

the Subscription that was prepared but not sent downstream

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
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
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