Package reactor.core.publisher

Interface MonoSink<T>

Type Parameters:

T - the value type emitted

public interface MonoSink<T>

Wrapper API around an actual downstream Subscriber for emitting nothing, a single value or an error (mutually exclusive).

Method Summary

Modifier and Type	Method	Description
default ContextView	contextView()	Return the current subscriber's context as a ContextView for inspection.
Context	currentContext()	Deprecated. To be removed in 3.6.0 at the earliest.
void	error(Throwable e)	Terminate with the given exception
MonoSink<T>	onCancel(Disposable d)	Attach a Disposable as a callback for when this MonoSink is cancelled.
MonoSink<T>	onDispose(Disposable d)	Attach a Disposable as a callback for when this MonoSink is effectively disposed, that is it cannot be used anymore.
MonoSink<T>	onRequest(LongConsumer consumer)	Attaches a LongConsumer to this MonoSink that will be notified of any request to this sink.
void	success()	Complete without any value.
void	success(@Nullable T value)	Complete this Mono with the given value.

Method Details

success

void success()

Complete without any value.

Calling this method multiple times or after the other terminating methods has no effect.

success

void success(@Nullable T value)

Complete this Mono with the given value.

Calling this method multiple times or after the other terminating methods has no effect (the value is dropped). Calling this method with a null value will be silently accepted as a call to success() by standard implementations.

Parameters:

value - the value to complete with

error

void error(Throwable e)

Terminate with the given exception

Calling this method multiple times or after the other terminating methods is an unsupported operation. It will discard the exception through the Hooks.onErrorDropped(Consumer) hook. This is to avoid complete and silent swallowing of the exception.

Parameters:

e - the exception to complete with

currentContext

@Deprecated
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 Mono.contextWrite(Function) operator or directly by a child subscriber overriding CoreSubscriber.currentContext()

contextView

default ContextView contextView()

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

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

Returns:

the current subscriber ContextView.

onRequest

MonoSink<T> onRequest(LongConsumer consumer)

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

Parameters:

consumer - the consumer to invoke on request

Returns:

MonoSink with a consumer that is notified of requests

onCancel

MonoSink<T> onCancel(Disposable d)

Attach a Disposable as a callback for when this MonoSink 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 - the Disposable to use as a callback

Returns:

the MonoSink with a cancellation callback

See Also:

• onDispose(Disposable) for a callback that covers cancellation AND terminal signals

onDispose

MonoSink<T> onDispose(Disposable d)

Attach a Disposable as a callback for when this MonoSink 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 Mono.subscribe()'s Disposable.dispose() method, which maps to disposing the Subscription (effectively, a Subscription.cancel() signal).

Parameters:

d - the Disposable to use as a callback

Returns:

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

See Also:

• onCancel(Disposable) for a cancellation-only callback