reactor.core.publisher

Class BlockingSink<E>

java.lang.Object

reactor.core.publisher.BlockingSink<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<E>, Subscription, Cancellation, Disposable, Producer, Trackable

Deprecated.

Will be removed in 3.1.0. There is no general replacement for BlockingSink in 3.1 but its major user FluxProcessor now offers FluxProcessor.sink() that directly exposes FluxSink. In general the blocking publishing methods here can be directly addressed via the behavior of FluxProcessor.sink() in a safer way. There is also FluxSink.onRequest(LongConsumer) available to now proactively deal with backpressure even in the context of producing to an arbitrary processor.

@Deprecated
public final class BlockingSink<E>
extends Object
implements Subscription, Consumer<E>, Disposable, Producer, Trackable, Closeable

A "hot" sequence source to decorate any Subscriber or Processor. The BlockingSink keeps track of the decorated Subscriber demand. Therefore any emission can be safely sent to the delegate Subscriber by using submit(E) to block on backpressure (missing demand) or emit(E) to never block and return instead an BlockingSink.Emission status. The emitter is itself a Subscriber that will request an unbounded value if subscribed.

Author:

Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockingSink.Emission Deprecated. An acknowledgement signal returned by emit(E).

Field Summary

Fields inherited from interface reactor.core.Trackable

UNSPECIFIED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockingSink(Subscriber<? super E> actual) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	accept(E e) Deprecated.
void	cancel() Deprecated.
void	close() Deprecated.
void	complete() Deprecated.
static <E> BlockingSink<E>	create(Subscriber<? super E> subscriber) Deprecated. Create a BlockingSink to safely signal a target Subscriber or Processor.
static <E> BlockingSink<E>	create(Subscriber<? super E> subscriber, boolean autostart) Deprecated. Create a BlockingSink to safely signal a target Subscriber or Processor.
void	dispose() Deprecated. Cancel or dispose the underlying task or resource.
Subscriber<? super E>	downstream() Deprecated. Return the direct data receiver.
BlockingSink.Emission	emit(E data) Deprecated. A non-blocking Subscriber.onNext(Object) that will return a status BlockingSink.Emission.
void	error(Throwable error) Deprecated. Try calling Subscriber.onError(Throwable) on the delegate Subscriber.
BlockingSink.Emission	finish() Deprecated. Try emitting complete() to the decorated Subscriber.
long	getCapacity() Deprecated. Return defined element capacity
Throwable	getError() Deprecated. Current error if any, default to null
boolean	hasFailed() Deprecated.
boolean	hasRequested() Deprecated.
boolean	isCancelled() Deprecated.
boolean	isDisposed() Deprecated. Optionally return true when the resource or task is disposed.
void	next(E t) Deprecated. Try emitting, might throw an unchecked exception.
void	request(long n) Deprecated.
long	requestedFromDownstream() Deprecated. Return defined element capacity, used to drive new Subscription request needs.
void	start() Deprecated. Subscribe the decorated actual Subscriber.onSubscribe(Subscription).
void	stop() Deprecated. Marks the emitter as terminated without completing downstream
long	submit(E data) Deprecated. Blocking Subscriber.onNext(Object) call with an infinite wait on backpressure.
long	submit(E data, long timeout) Deprecated. Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.
long	submit(E data, long timeout, Predicate<E> dropPredicate) Deprecated. Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.
long	submit(E data, long timeout, TimeUnit unit) Deprecated. Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.
long	submit(E data, long timeout, TimeUnit unit, Predicate<E> dropPredicate) Deprecated. Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface reactor.core.Trackable

expectedFromUpstream, getPending, isStarted, isTerminated, limit

Constructor Detail

BlockingSink

protected BlockingSink(Subscriber<? super E> actual)

Deprecated.

Method Detail

create

public static <E> BlockingSink<E> create(Subscriber<? super E> subscriber,
                                         boolean autostart)

Deprecated.

Create a BlockingSink to safely signal a target Subscriber or Processor. The subscriber will be immediately started only if the autostart property is true. via Subscriber.onSubscribe(Subscription) as the result of this call.

Type Parameters:

E - the reified Subscriber type

Parameters:

subscriber - the decorated Subscriber

autostart - true if Subscriber.onSubscribe(Subscription) is invoked during this call

Returns:

a new BlockingSink

create

public static <E> BlockingSink<E> create(Subscriber<? super E> subscriber)

Deprecated.

Create a BlockingSink to safely signal a target Subscriber or Processor. The actual will be immediately started via Subscriber.onSubscribe(Subscription) as the result of this call.

Type Parameters:

E - the reified Subscriber type

Parameters:

subscriber - the decorated Subscriber

Returns:

a new pre-subscribed BlockingSink

accept

public void accept(E e)

Deprecated.

Specified by:

accept in interface Consumer<E>

cancel

public void cancel()

Deprecated.

Specified by:

cancel in interface Subscription

close

public void close()
           throws IOException

Deprecated.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

downstream

public Subscriber<? super E> downstream()

Deprecated.

Description copied from interface: Producer

Return the direct data receiver.

Specified by:

downstream in interface Producer

Returns:

the direct data receiver

next

public void next(E t)

Deprecated.

Try emitting, might throw an unchecked exception.

Parameters:

t - the value to emit, not null

Throws:

RuntimeException - the unchecked exception in case of error (eg. IllegalStateException if emission has failed)

See Also:

Subscriber.onNext(Object)

emit

public BlockingSink.Emission emit(E data)

Deprecated.

A non-blocking Subscriber.onNext(Object) that will return a status BlockingSink.Emission. The status will indicate if the decorated actual is backpressuring this BlockingSink and if it has previously been terminated successfully or not.

Parameters:

data - the data to signal

Returns:

an BlockingSink.Emission status

error

public void error(Throwable error)

Deprecated.

Try calling Subscriber.onError(Throwable) on the delegate Subscriber. This method might fail itself with an unchecked exception if an error has already been recorded or it has previously been terminated via cancel(), finish() or complete().

Parameters:

error - the exception to signal

finish

public BlockingSink.Emission finish()

Deprecated.

Try emitting complete() to the decorated Subscriber. The completion might not return a successful BlockingSink.Emission.isOk() if this BlockingSink was previously terminated or the delegate failed consuming the signal.

Returns:

an BlockingSink.Emission status

getCapacity

public long getCapacity()

Deprecated.

Description copied from interface: Trackable

Return defined element capacity

Specified by:

getCapacity in interface Trackable

Returns:

long capacity

getError

public Throwable getError()

Deprecated.

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

hasFailed

public boolean hasFailed()

Deprecated.

Returns:

true if the BlockingSink has observed any error

hasRequested

public boolean hasRequested()

Deprecated.

Returns:

true if the decorated Subscriber is actively demanding

isCancelled

public boolean isCancelled()

Deprecated.

Specified by:

isCancelled in interface Trackable

Returns:

has the downstream "cancelled" and interrupted its consuming ?

dispose

public void dispose()

Deprecated.

Description copied from interface: Disposable

Cancel or dispose the underlying task or resource.

Call to this method is/should be idempotent.

Specified by:

dispose in interface Cancellation

Specified by:

dispose in interface Disposable

isDisposed

public boolean isDisposed()

Deprecated.

Description copied from interface: Disposable

Optionally return true when the resource or task is disposed. The implementor does not require to track disposition and may never return true even when disposed.

Specified by:

isDisposed in interface Disposable

Returns:

true when there's a guarantee the resource or task is disposed.

complete

public void complete()

Deprecated.

See Also:

Subscriber.onComplete()

request

public void request(long n)

Deprecated.

Specified by:

request in interface Subscription

requestedFromDownstream

public long requestedFromDownstream()

Deprecated.

Description copied from interface: Trackable

Return defined element capacity, used to drive new Subscription request needs. This is the maximum in-flight data allowed to transit to this elements.

Specified by:

requestedFromDownstream in interface Trackable

Returns:

long capacity

start

public void start()

Deprecated.

Subscribe the decorated actual Subscriber.onSubscribe(Subscription). If called twice, the current BlockingSink might be cancelled as per Reactive Streams Specification enforce.

stop

public void stop()

Deprecated.

Marks the emitter as terminated without completing downstream

submit

public long submit(E data)

Deprecated.

Blocking Subscriber.onNext(Object) call with an infinite wait on backpressure.

Parameters:

data - the data to signal

Returns:

the emission latency in milliseconds or -1 if emission failed.

submit

public long submit(E data,
                   long timeout)

Deprecated.

Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.

Parameters:

data - the data to signal

timeout - the maximum waiting time in milliseconds before giving up

Returns:

the emission latency in milliseconds or -1 if emission failed.

submit

public long submit(E data,
                   long timeout,
                   Predicate<E> dropPredicate)

Deprecated.

Blocking Subscriber.onNext(Object) call with a timed wait on backpressure. A retry predicate will evaluate when a timeout occurs, returning true will re-schedule an emission while false will drop the signal.

Parameters:

data - the data to signal

timeout - the maximum waiting time in milliseconds before giving up

dropPredicate - the dropped signal callback evaluating if retry should occur or not

Returns:

the emission latency in milliseconds or -1 if emission failed.

submit

public long submit(E data,
                   long timeout,
                   TimeUnit unit)

Deprecated.

Blocking Subscriber.onNext(Object) call with a timed wait on backpressure.

Parameters:

data - the data to signal

timeout - the maximum waiting time in given unit before giving up

unit - the waiting time unit

Returns:

the emission latency in milliseconds or -1 if emission failed.

submit

public long submit(E data,
                   long timeout,
                   TimeUnit unit,
                   Predicate<E> dropPredicate)

Deprecated.

Blocking Subscriber.onNext(Object) call with a timed wait on backpressure. A retry predicate will evaluate when a timeout occurs, returning true will re-schedule an emission while false will drop the signal.

Parameters:

data - the data to signal

timeout - the maximum waiting time in given unit before giving up

unit - the waiting time unit

dropPredicate - the dropped signal callback evaluating if retry should occur or not

Returns:

the emission latency in milliseconds or -1 if emission failed.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object