Reactor Core 3.6.0 · reactor.core.publisher.InternalOneSink

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public default void	emitValue(T the value to emit and complete with, a `null` is actually acceptable to only trigger an onComplete value, Sinks.EmitFailureHandler the failure handler that allows retrying failed `EmitResult`. failureHandler) Implements reactor.core.publisher.Sinks.One.emitValue. A simplified attempt at emitting a non-null element via the `tryEmitValue(Object)` API, generating an `onNext` signal immediately followed by an `Subscriber#onComplete()` signal.

public default void

emitValue(T

the value to emit and complete with, a null is actually acceptable to only trigger an onComplete

value, Sinks.EmitFailureHandler

the failure handler that allows retrying failed EmitResult.

failureHandler)

Implements reactor.core.publisher.Sinks.One.emitValue.

A simplified attempt at emitting a non-null element via the tryEmitValue(Object) API, generating an onNext signal immediately followed by an Subscriber#onComplete() signal.

Inherited from reactor.core.publisher.InternalEmptySink:: emitEmpty emitError
Inherited from reactor.core.publisher.Sinks.One:: tryEmitValue

Method Detail

emitValue back to summary

emitValue	back to summary
public default void emitValue(T value, Sinks.EmitFailureHandler failureHandler) Implements reactor.core.publisher.Sinks.One.emitValue. Doc from reactor.core.publisher.Sinks.One.emitValue. A simplified attempt at emitting a non-null element via the `tryEmitValue(Object)` API, generating an `onNext` signal immediately followed by an `Subscriber#onComplete()` signal. If the result of the attempt is not a `success`, implementations SHOULD retry the `tryEmitValue(Object)` call IF the provided `EmitFailureHandler` returns `true`. Otherwise, failures are dealt with in a predefined way that might depend on the actual sink implementation (see below for the vanilla reactor-core behavior). Generally, `tryEmitValue(Object)` is preferable since it allows a custom handling of error cases, although this implies checking the returned `EmitResult` and correctly acting on it. This API is intended as a good default for convenience. When the `EmitResult` is not a success, vanilla reactor-core operators have the following behavior: `EmitResult#FAIL_ZERO_SUBSCRIBER`: no particular handling. should ideally discard the value but at that point there's no `Subscriber` from which to get a contextual discard handler. `EmitResult#FAIL_OVERFLOW`: discard the value (`Operators#onDiscard(Object, Context)`) then call `emitError(Throwable, Sinks.EmitFailureHandler)` with a `Exceptions#failWithOverflow(String)` exception. `EmitResult#FAIL_CANCELLED`: discard the value (`Operators#onDiscard(Object, Context)`). `EmitResult#FAIL_TERMINATED`: drop the value (`Operators#onNextDropped(Object, Context)`). `EmitResult#FAIL_NON_SERIALIZED`: throw an `EmissionException` mentioning RS spec rule 1.3. Note that `Sinks#unsafe()` never trigger this result. It would be possible for an `EmitFailureHandler` to busy-loop and optimistically wait for the contention to disappear to avoid this case for safe sinks... Might throw an unchecked exception as a last resort (eg. in case of a fatal error downstream which cannot be propagated to any asynchronous handler, a bubbling exception, a `EmitResult#FAIL_NON_SERIALIZED` as described above, ...). Parameters value:T the value to emit and complete with, a `null` is actually acceptable to only trigger an onComplete failureHandler:Sinks.EmitFailureHandler the failure handler that allows retrying failed `EmitResult`. Annotations @Override

public default void emitValue(T value, Sinks.EmitFailureHandler failureHandler)

Implements reactor.core.publisher.Sinks.One.emitValue.

Doc from reactor.core.publisher.Sinks.One.emitValue.

A simplified attempt at emitting a non-null element via the tryEmitValue(Object) API, generating an onNext signal immediately followed by an Subscriber#onComplete() signal. If the result of the attempt is not a success, implementations SHOULD retry the tryEmitValue(Object) call IF the provided EmitFailureHandler returns true. Otherwise, failures are dealt with in a predefined way that might depend on the actual sink implementation (see below for the vanilla reactor-core behavior).

Generally, tryEmitValue(Object) is preferable since it allows a custom handling of error cases, although this implies checking the returned EmitResult and correctly acting on it. This API is intended as a good default for convenience.

When the EmitResult is not a success, vanilla reactor-core operators have the following behavior:

EmitResult#FAIL_ZERO_SUBSCRIBER: no particular handling. should ideally discard the value but at that point there's no Subscriber from which to get a contextual discard handler.
EmitResult#FAIL_OVERFLOW: discard the value (Operators#onDiscard(Object, Context)) then call emitError(Throwable, Sinks.EmitFailureHandler) with a Exceptions#failWithOverflow(String) exception.
EmitResult#FAIL_CANCELLED: discard the value (Operators#onDiscard(Object, Context)).
EmitResult#FAIL_TERMINATED: drop the value (Operators#onNextDropped(Object, Context)).
EmitResult#FAIL_NON_SERIALIZED: throw an EmissionException mentioning RS spec rule 1.3. Note that Sinks#unsafe() never trigger this result. It would be possible for an EmitFailureHandler to busy-loop and optimistically wait for the contention to disappear to avoid this case for safe sinks...

Might throw an unchecked exception as a last resort (eg. in case of a fatal error downstream which cannot be propagated to any asynchronous handler, a bubbling exception, a EmitResult#FAIL_NON_SERIALIZED as described above, ...).

Parameters

value:T: the value to emit and complete with, a null is actually acceptable to only trigger an onComplete
failureHandler:Sinks.EmitFailureHandler: the failure handler that allows retrying failed EmitResult.

Annotations

@Override

pack-priv Interface InternalOneSink<T>

Method Summary

Method Detail