reactor.core.publisher

Class MonoProcessor<O>

java.lang.Object

reactor.core.publisher.Mono<O>

reactor.core.publisher.MonoProcessor<O>

Type Parameters:

O - the type of the value that will be made available

All Implemented Interfaces:

java.util.function.LongSupplier, org.reactivestreams.Processor<O,O>, org.reactivestreams.Publisher<O>, org.reactivestreams.Subscriber<O>, org.reactivestreams.Subscription, Cancellation, Producer, Receiver, Trackable

public final class MonoProcessor<O>
extends Mono<O>
implements org.reactivestreams.Processor<O,O>, Cancellation, org.reactivestreams.Subscription, Trackable, Receiver, Producer, java.util.function.LongSupplier

A MonoProcessor is a Mono extension that implements stateful semantics. Multi-subscribe is allowed.

Once a MonoProcessor has been resolved, newer subscribers will benefit from the cached result.

Field Summary

Fields inherited from interface reactor.core.Trackable

UNSPECIFIED

Method Summary

Modifier and Type	Method and Description
O	block() Block until a next signal is received, will return null if onComplete, T if onNext, throw a Exceptions.DownstreamException if checked error or origin RuntimeException if unchecked.
O	blockMillis(long timeout) Block the calling thread for the specified time, waiting for the completion of this MonoProcessor.
void	cancel()
static <T> MonoProcessor<T>	create() Create a MonoProcessor that will eagerly request 1 on onSubscribe(Subscription), cache and emit the eventual result for 1 or N subscribers.
static <T> MonoProcessor<T>	create(WaitStrategy waitStrategy) Create a MonoProcessor that will eagerly request 1 on onSubscribe(Subscription), cache and emit the eventual result for 1 or N subscribers.
void	dispose() Cancel or dispose the underlying task or resource.
org.reactivestreams.Subscriber<O>	downstream() Return the direct data receiver.
long	expectedFromUpstream()
long	getAsLong() Returns the internal state from -1 Cancelled to 5 errored, beyond 3 included is fulfilled.
java.lang.Throwable	getError() Current error if any, default to null
long	getPending() Return current used space in buffer
boolean	isCancelled()
boolean	isError() Indicates whether this MonoProcessor has been completed with an error.
boolean	isStarted() Has this upstream started or "onSubscribed" ?
boolean	isSuccess() Indicates whether this MonoProcessor has been successfully completed a value.
boolean	isTerminated() Has this upstream finished or "completed" / "failed" ?
long	limit()
void	onComplete()
void	onError(java.lang.Throwable cause)
void	onNext(O value)
void	onSubscribe(org.reactivestreams.Subscription subscription)
O	peek() Returns the value that completed this MonoProcessor.
void	request(long n)
void	subscribe(org.reactivestreams.Subscriber<? super O> subscriber)
java.lang.Object	upstream() Return the direct source of data, Supports reference.

Methods inherited from class reactor.core.publisher.Mono

and, as, awaitOnSubscribe, block, cache, cancelOn, cast, compose, concatWith, create, defaultIfEmpty, defer, delay, delayMillis, delayMillis, delaySubscription, delaySubscription, delaySubscriptionMillis, delaySubscriptionMillis, dematerialize, doAfterTerminate, doOnCancel, doOnError, doOnError, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnSuccess, doOnTerminate, elapsed, elapsed, empty, empty, error, filter, first, first, flatMap, flatMap, flatMapIterable, flux, from, fromCallable, fromFuture, fromRunnable, fromSupplier, handle, hasElement, hide, ignoreElement, ignoreElements, just, justOrEmpty, justOrEmpty, log, log, log, log, map, mapError, mapError, mapError, materialize, mergeWith, never, ofType, onAssembly, onTerminateDetach, or, otherwise, otherwise, otherwise, otherwiseIfEmpty, otherwiseReturn, otherwiseReturn, otherwiseReturn, publish, publishOn, repeat, repeat, repeat, repeat, repeatWhen, repeatWhenEmpty, repeatWhenEmpty, retry, retry, retry, retry, retryWhen, sequenceEqual, sequenceEqual, sequenceEqual, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, then, then, then, then, thenMany, thenMany, timeout, timeout, timeout, timeout, timeoutMillis, timeoutMillis, timeoutMillis, timeoutMillis, timestamp, timestamp, toFuture, toString, transform, using, using, when, when, when, when, when, when, when, when, when, whenDelayError, whenDelayError, whenDelayError, whenDelayError, whenDelayError, whenDelayError, whenDelayError, zip, zip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.core.Trackable

getCapacity, requestedFromDownstream

Method Detail

create

public static <T> MonoProcessor<T> create()

Create a MonoProcessor that will eagerly request 1 on onSubscribe(Subscription), cache and emit the eventual result for 1 or N subscribers.

Type Parameters:

T - type of the expected value

Returns:

A MonoProcessor.

create

public static <T> MonoProcessor<T> create(WaitStrategy waitStrategy)

Create a MonoProcessor that will eagerly request 1 on onSubscribe(Subscription), cache and emit the eventual result for 1 or N subscribers.

Type Parameters:

T - type of the expected value

Parameters:

waitStrategy - a WaitStrategy for blocking block() strategy

Returns:

A MonoProcessor.

cancel

public final void cancel()

Specified by:

cancel in interface org.reactivestreams.Subscription

dispose

public void dispose()

Description copied from interface: Cancellation

Cancel or dispose the underlying task or resource.

Call to this method is/should be idempotent.

Specified by:

dispose in interface Cancellation

downstream

public final org.reactivestreams.Subscriber<O> downstream()

Description copied from interface: Producer

Return the direct data receiver.

Specified by:

downstream in interface Producer

Returns:

the direct data receiver

expectedFromUpstream

public long expectedFromUpstream()

Specified by:

expectedFromUpstream in interface Trackable

Returns:

expected number of events to be produced to this component

block

public O block()

Description copied from class: Mono

Block until a next signal is received, will return null if onComplete, T if onNext, throw a Exceptions.DownstreamException if checked error or origin RuntimeException if unchecked.

Overrides:

block in class Mono<O>

Returns:

T the result

blockMillis

public O blockMillis(long timeout)

Block the calling thread for the specified time, waiting for the completion of this MonoProcessor. If the MonoProcessor is completed with an error a RuntimeException that wraps the error is thrown.

Overrides:

blockMillis in class Mono<O>

Parameters:

timeout - the timeout value in milliseconds

Returns:

the value of this MonoProcessor or null if the timeout is reached and the MonoProcessor has not completed

getError

public final java.lang.Throwable getError()

Description copied from interface: Trackable

Current error if any, default to null

Specified by:

getError in interface Trackable

Returns:

Current error if any, default to null

getPending

public long getPending()

Description copied from interface: Trackable

Return current used space in buffer

Specified by:

getPending in interface Trackable

Returns:

long capacity

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Trackable

Returns:

has the downstream "cancelled" and interrupted its consuming ?

isError

public final boolean isError()

Indicates whether this MonoProcessor has been completed with an error.

Returns:

true if this MonoProcessor was completed with an error, false otherwise.

isStarted

public final boolean isStarted()

Description copied from interface: Trackable

Has this upstream started or "onSubscribed" ?

Specified by:

isStarted in interface Trackable

Returns:

has this upstream started or "onSubscribed" ?

isSuccess

public final boolean isSuccess()

Indicates whether this MonoProcessor has been successfully completed a value.

Returns:

true if this MonoProcessor is successful, false otherwise.

isTerminated

public final boolean isTerminated()

Description copied from interface: Trackable

Has this upstream finished or "completed" / "failed" ?

Specified by:

isTerminated in interface Trackable

Returns:

has this upstream finished or "completed" / "failed" ?

limit

public long limit()

Specified by:

limit in interface Trackable

Returns:

a given limit threshold to replenish outstanding upstream request

onComplete

public final void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<O>

onError

public final void onError(java.lang.Throwable cause)

Specified by:

onError in interface org.reactivestreams.Subscriber<O>

onNext

public final void onNext(O value)

Specified by:

onNext in interface org.reactivestreams.Subscriber<O>

onSubscribe

public final void onSubscribe(org.reactivestreams.Subscription subscription)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<O>

getAsLong

public long getAsLong()

Returns the internal state from -1 Cancelled to 5 errored, beyond 3 included is fulfilled.

Specified by:

getAsLong in interface java.util.function.LongSupplier

Returns:

the internal state from -1 Cancelled to 5 errored, beyond 3 included is fulfilled.

peek

public O peek()

Returns the value that completed this MonoProcessor. Returns null if the MonoProcessor has not been completed. If the MonoProcessor is completed with an error a RuntimeException that wraps the error is thrown.

Returns:

the value that completed the MonoProcessor, or null if it has not been completed

Throws:

java.lang.RuntimeException - if the MonoProcessor was completed with an error

request

public final void request(long n)

Specified by:

request in interface org.reactivestreams.Subscription

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super O> subscriber)

Specified by:

subscribe in interface org.reactivestreams.Publisher<O>

upstream

public final java.lang.Object upstream()

Description copied from interface: Receiver

Return the direct source of data, Supports reference.

Specified by:

upstream in interface Receiver

Returns:

the direct source of data, Supports reference.