reactor.core.publisher

Interface FluxSink<T>

Type Parameters:

T - the value type

public interface FluxSink<T>

Wrapper API around a downstream Subscriber for emitting any number of next signals followed by zero or one onError/onComplete.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FluxSink.OverflowStrategy Enumeration for backpressure handling.

Method Summary

Modifier and Type	Method and Description
void	complete()
void	error(Throwable e)
boolean	isCancelled() Returns true if the downstream cancelled the sequence.
void	next(T t) Try emitting, might throw an unchecked exception.
FluxSink<T>	onCancel(Disposable d) Associates a disposable resource with this FluxSink that will be disposed in case the downstream cancels the sequence via Subscription.cancel().
FluxSink<T>	onDispose(Disposable d) Associates a disposable resource with this FluxSink that will be disposed on the first terminate signal which may be a cancel, complete or error signal.
FluxSink<T>	onRequest(LongConsumer consumer) Attaches a LongConsumer to this FluxSink that will be notified of any request to this sink.
long	requestedFromDownstream() The current outstanding request amount.
FluxSink<T>	serialize() Deprecated. Use Flux.create(java.util.function.Consumer) or Flux.create(java.util.function.Consumer, FluxSink.OverflowStrategy) to create a serialized FluxSink.
void	setCancellation(Cancellation c) Deprecated. use onDispose(Disposable) for resources to be disposed on any cancel signal or onCancel(Disposable) for resources to be disposed on cancel.

Method Detail

complete

void complete()

See Also:

Subscriber.onComplete()

error

void error(Throwable e)

Parameters:

e - the exception to signal, not null

See Also:

Subscriber.onError(Throwable)

next

void next(T t)

Try emitting, might throw an unchecked exception.

Parameters:

t - the value to emit, not null Will return this sink from 3.1 (now void)

See Also:

Subscriber.onNext(Object)

requestedFromDownstream

long requestedFromDownstream()

The current outstanding request amount.

Returns:

the current outstanding request amount

isCancelled

boolean isCancelled()

Returns true if the downstream cancelled the sequence.

Returns:

true if the downstream cancelled the sequence

serialize

@Deprecated
FluxSink<T> serialize()

Deprecated. Use Flux.create(java.util.function.Consumer) or Flux.create(java.util.function.Consumer, FluxSink.OverflowStrategy) to create a serialized FluxSink.

Ensures that calls to next, error and complete are properly serialized.

Returns:

a new serialized FluxSink

onRequest

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. 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, FluxSink.OverflowStrategy), the consumer is invoked with an initial request of Long.MAX_VALUE when this method is invoked.

Parameters:

consumer - the consumer to invoke on each request

Returns:

FluxSink with a consumer that is notified of requests

onCancel

FluxSink<T> onCancel(Disposable d)

Associates a disposable resource with this FluxSink that will be disposed in case the downstream cancels the sequence via Subscription.cancel().

Parameters:

d - the disposable callback to use

Returns:

the FluxSink with resource to be disposed on cancel signal

onDispose

FluxSink<T> onDispose(Disposable d)

Associates a disposable resource with this FluxSink that will be disposed on the first terminate signal which may be a cancel, complete or error signal.

Parameters:

d - the disposable callback to use

Returns:

the FluxSink with resource to be disposed on first terminate signal

setCancellation

@Deprecated
void setCancellation(Cancellation c)

Deprecated. use onDispose(Disposable) for resources to be disposed on any cancel signal or onCancel(Disposable) for resources to be disposed on cancel.

Associate a cancellation-based resource with this FluxSink that will be disposed in case the downstream cancels the sequence via Subscription.cancel().

Parameters:

c - the cancellation callback to use