Modifier and Type	Class and Description
public static enum	FluxSink.OverflowStrategy Enumeration for backpressure handling.

Method Summary

Modifier and Type	Method and Description
public void	complete() Terminate the sequence successfully, generating an `onComplete` signal.
public default ContextView	Returns: the current subscriber `ContextView`. contextView() Return the current subscriber's context as a `ContextView` for inspection.
public Context	currentContext() Deprecated To be removed in 3.6.0 at the earliest. Prefer using #contextView() instead. Return the current subscriber `Context`.
public void	error(Throwable the exception to signal, not null e) Fail the sequence, generating an `onError` signal.
public boolean	Returns: true if the downstream cancelled the sequence isCancelled() Returns true if the downstream cancelled the sequence.
public FluxSink<T>	Returns: this sink for chaining further signals next(T the value to emit, not null t) Emit a non-null element, generating an `onNext` signal.
public FluxSink<T>	Returns: the `FluxSink` with a cancellation callback onCancel(Disposable the `Disposable` to use as a callback d) Attach a `Disposable` as a callback for when this `FluxSink` is cancelled.
public FluxSink<T>	Returns: the `FluxSink` with a callback invoked on any terminal signal or on cancellation onDispose(Disposable the `Disposable` to use as a callback d) Attach a `Disposable` as a callback for when this `FluxSink` is effectively disposed, that is it cannot be used anymore.
public FluxSink<T>	Returns: `FluxSink` with a consumer that is notified of requests onRequest(LongConsumer the consumer to invoke on each request consumer) Attaches a `LongConsumer` to this `FluxSink` that will be notified of any request to this sink.
public long	Returns: the current outstanding request amount requestedFromDownstream() The current outstanding request amount.

Method Detail

complete back to summary

complete	back to summary
public void complete() Terminate the sequence successfully, generating an `onComplete` signal. See Also `Subscriber#onComplete()`

public void complete()

Terminate the sequence successfully, generating an onComplete signal.

See Also: Subscriber#onComplete()

contextView back to summary

contextView	back to summary
public default ContextView contextView() Return the current subscriber's context as a `ContextView` for inspection. `Context` can be enriched downstream via `Flux#contextWrite(Function)` operator or directly by a child subscriber overriding `CoreSubscriber#currentContext()`. Returns:ContextView the current subscriber `ContextView`.

public default ContextView contextView()

Return the current subscriber's context as a ContextView for inspection.

Context can be enriched downstream via Flux#contextWrite(Function) operator or directly by a child subscriber overriding CoreSubscriber#currentContext().

Returns:ContextView: the current subscriber ContextView.

currentContext back to summary

currentContext	back to summary
public Context currentContext() Deprecated To be removed in 3.6.0 at the earliest. Prefer using #contextView() instead. Return the current subscriber `Context`. `Context` can be enriched via `Flux#contextWrite(Function)` operator or directly by a child subscriber overriding `CoreSubscriber#currentContext()` Annotations @Deprecated

public Context currentContext()

Deprecated

To be removed in 3.6.0 at the earliest. Prefer using #contextView() instead.

Return the current subscriber Context.

Context can be enriched via Flux#contextWrite(Function) operator or directly by a child subscriber overriding CoreSubscriber#currentContext()

Annotations

@Deprecated

error back to summary

error	back to summary
public void error(Throwable e) Fail the sequence, generating an `onError` signal. Parameters e:Throwable the exception to signal, not null See Also `Subscriber#onError(Throwable)`

public void error(Throwable e)

Fail the sequence, generating an onError signal.

Parameters

e:Throwable: the exception to signal, not null

See Also

Subscriber#onError(Throwable)

isCancelled	back to summary
public boolean isCancelled() Returns true if the downstream cancelled the sequence. Returns:boolean true if the downstream cancelled the sequence

isCancelled

back to summary

public boolean isCancelled()

Returns true if the downstream cancelled the sequence.

Returns:boolean: true if the downstream cancelled the sequence

next back to summary

next	back to summary
public FluxSink<T> next(T t) Emit a non-null element, generating an `onNext` signal. Might throw an unchecked exception in case of a fatal error downstream which cannot be propagated to any asynchronous handler (aka a bubbling exception). Parameters t:T the value to emit, not null Returns:FluxSink<T> this sink for chaining further signals

public FluxSink<T> next(T t)

Emit a non-null element, generating an onNext signal.

Might throw an unchecked exception in case of a fatal error downstream which cannot be propagated to any asynchronous handler (aka a bubbling exception).

Parameters

t:T: the value to emit, not null

Returns:FluxSink<T>

this sink for chaining further signals

onCancel back to summary

onCancel	back to summary
public FluxSink<T> onCancel(Disposable d) Attach a `Disposable` as a callback for when this `FluxSink` is cancelled. At most one callback can be registered, and subsequent calls to this method will result in the immediate disposal of the extraneous `Disposable`. The callback is only relevant when the downstream `Subscription` is `cancelled`. Parameters d:Disposable the `Disposable` to use as a callback Returns:FluxSink<T> the `FluxSink` with a cancellation callback See Also `onDispose(Disposable) for a callback that covers cancellation AND terminal signals`

public FluxSink<T> onCancel(Disposable d)

Attach a Disposable as a callback for when this FluxSink is cancelled. At most one callback can be registered, and subsequent calls to this method will result in the immediate disposal of the extraneous Disposable.

The callback is only relevant when the downstream Subscription is cancelled.

Parameters

d:Disposable: the Disposable to use as a callback

Returns:FluxSink<T>

the FluxSink with a cancellation callback

onDispose back to summary

onDispose	back to summary
public FluxSink<T> onDispose(Disposable d) Attach a `Disposable` as a callback for when this `FluxSink` is effectively disposed, that is it cannot be used anymore. This includes both having played terminal signals (onComplete, onError) and having been cancelled (see `onCancel(Disposable)`). At most one callback can be registered, and subsequent calls to this method will result in the immediate disposal of the extraneous `Disposable`. Note that the "dispose" term is used from the perspective of the sink. Not to be confused with `Flux#subscribe()`'s `Disposable#dispose()` method, which maps to disposing the `Subscription` (effectively, a `Subscription#cancel()` signal). Parameters d:Disposable the `Disposable` to use as a callback Returns:FluxSink<T> the `FluxSink` with a callback invoked on any terminal signal or on cancellation See Also `onCancel(Disposable) for a cancellation-only callback`

public FluxSink<T> onDispose(Disposable d)

Attach a Disposable as a callback for when this FluxSink is effectively disposed, that is it cannot be used anymore. This includes both having played terminal signals (onComplete, onError) and having been cancelled (see onCancel(Disposable)). At most one callback can be registered, and subsequent calls to this method will result in the immediate disposal of the extraneous Disposable.

Note that the "dispose" term is used from the perspective of the sink. Not to be confused with Flux#subscribe()'s Disposable#dispose() method, which maps to disposing the Subscription (effectively, a Subscription#cancel() signal).

Parameters

d:Disposable: the Disposable to use as a callback

Returns:FluxSink<T>

the FluxSink with a callback invoked on any terminal signal or on cancellation

onRequest back to summary

onRequest	back to summary
public FluxSink<T> onRequest(LongConsumer consumer) Attaches a `LongConsumer` to this `FluxSink` that will be notified of any request to this sink. For push/pull sinks created using `Flux#create(java.util.function.Consumer)` or `Flux#create(java.util.function.Consumer, FluxSink.OverflowStrategy)`, the consumer is invoked for every request to enable a hybrid backpressure-enabled push/pull model. Note in case of multiple `Subscription#request` happening concurrently to this method, the first consumer invocation may process accumulated demand instead of being called multiple times. When bridging with asynchronous listener-based APIs, the `onRequest` callback may be used to request more data from source if required and to manage backpressure by delivering data to sink only when requests are pending. For push-only sinks created using `Flux#push(java.util.function.Consumer)` or `Flux#push(java.util.function.Consumer, FluxSink.OverflowStrategy)`, the consumer is invoked with an initial request of `Long.MAX_VALUE` when this method is invoked. Parameters consumer:LongConsumer the consumer to invoke on each request Returns:FluxSink<T> `FluxSink` with a consumer that is notified of requests

public FluxSink<T> onRequest(LongConsumer consumer)

Attaches a LongConsumer to this FluxSink that will be notified of any request to this sink.

For push/pull sinks created using Flux#create(java.util.function.Consumer) or Flux#create(java.util.function.Consumer, FluxSink.OverflowStrategy), the consumer is invoked for every request to enable a hybrid backpressure-enabled push/pull model.

Note

in case of multiple Subscription#request happening concurrently to this method, the first consumer invocation may process accumulated demand instead of being called multiple times.

When bridging with asynchronous listener-based APIs, the onRequest callback may be used to request more data from source if required and to manage backpressure by delivering data to sink only when requests are pending.

For push-only sinks created using Flux#push(java.util.function.Consumer) or Flux#push(java.util.function.Consumer, FluxSink.OverflowStrategy), the consumer is invoked with an initial request of Long.MAX_VALUE when this method is invoked.

Parameters

consumer:LongConsumer: the consumer to invoke on each request

Returns:FluxSink<T>

FluxSink with a consumer that is notified of requests

requestedFromDownstream	back to summary
public long requestedFromDownstream() The current outstanding request amount. Returns:long the current outstanding request amount

requestedFromDownstream

back to summary

public long requestedFromDownstream()

The current outstanding request amount.

Returns:long: the current outstanding request amount

reactor.core.publisher back to summary

public final Enum FluxSink.OverflowStrategy

Class Inheritance

extends Enum<FluxSink.OverflowStrategy>

java.lang.Object
java.lang.Enum
reactor.core.publisher.FluxSink.OverflowStrategy

Enumeration for backpressure handling.

Field Summary

Modifier and Type	Field and Description
public static final FluxSink.OverflowStrategy	BUFFER Buffer all signals if the downstream can't keep up.
public static final FluxSink.OverflowStrategy	DROP Drop the incoming signal if the downstream is not ready to receive it.
public static final FluxSink.OverflowStrategy	ERROR Signal an `IllegalStateException` when the downstream can't keep up
public static final FluxSink.OverflowStrategy	IGNORE Completely ignore downstream backpressure requests.
public static final FluxSink.OverflowStrategy	LATEST Downstream will get only the latest signals from upstream.

Constructor Summary

Access	Constructor and Description
private	OverflowStrategy()

Method Summary

Modifier and Type	Method and Description
public static FluxSink.OverflowStrategy	valueOf(String name)
public static FluxSink.OverflowStrategy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BUFFER	back to summary
public static final FluxSink.OverflowStrategy BUFFER Buffer all signals if the downstream can't keep up. Warning This does unbounded buffering and may lead to `OutOfMemoryError`.

DROP	back to summary
public static final FluxSink.OverflowStrategy DROP Drop the incoming signal if the downstream is not ready to receive it.

ERROR	back to summary
public static final FluxSink.OverflowStrategy ERROR Signal an `IllegalStateException` when the downstream can't keep up

IGNORE back to summary

IGNORE	back to summary
public static final FluxSink.OverflowStrategy IGNORE Completely ignore downstream backpressure requests. This may yield `IllegalStateException` when queues get full downstream.

public static final FluxSink.OverflowStrategy IGNORE

Completely ignore downstream backpressure requests.

This may yield IllegalStateException when queues get full downstream.

LATEST	back to summary
public static final FluxSink.OverflowStrategy LATEST Downstream will get only the latest signals from upstream.

Constructor Detail

OverflowStrategy	back to summary
private OverflowStrategy()

Method Detail

valueOf	back to summary
public static FluxSink.OverflowStrategy valueOf(String name)

values	back to summary
public static FluxSink.OverflowStrategy[] values()

public Interface FluxSink<T>

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum FluxSink.OverflowStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail