io.micronaut.core.async.subscriber

Class SingleThreadedBufferingSubscriber<T>

java.lang.Object

io.micronaut.core.async.subscriber.SingleThreadedBufferingSubscriber<T>

Type Parameters:

T - The type

All Implemented Interfaces:

Completable, Emitter<T>, Subscriber<T>

Direct Known Subclasses:

SingleThreadedBufferingProcessor

public abstract class SingleThreadedBufferingSubscriber<T>
extends Object
implements Subscriber<T>, Emitter<T>

A Subscriber designed to be used by a single thread that buffers incoming data for the purposes of managing back pressure.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SingleThreadedBufferingSubscriber.BackPressureState Back pressure state.
protected class	SingleThreadedBufferingSubscriber.DownstreamSubscription A downstream subscription.

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<T>	upstreamBuffer
protected long	upstreamDemand
protected SingleThreadedBufferingSubscriber.BackPressureState	upstreamState
protected Subscription	upstreamSubscription

Constructor Summary

Constructors

Constructor and Description
SingleThreadedBufferingSubscriber()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doOnComplete() Implement Subscriber.onComplete().
protected abstract void	doOnError(Throwable t) Implement Subscriber.onError(Throwable).
protected abstract void	doOnNext(T message) Implement Subscriber.onNext(Object).
protected abstract void	doOnSubscribe(Subscription subscription) Implement Subscriber.onSubscribe(Subscription).
protected Subscription	newDownstreamSubscription()
void	onComplete() * Successful terminal state.
void	onError(Throwable t) Failed terminal state.
void	onNext(T message) Data notification sent by the Publisher in response to requests to Subscription.request(long).
void	onSubscribe(Subscription subscription)
protected void	provideDownstreamSubscription(Subscriber subscriber)

Methods inherited from class java.lang.Object

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

Field Detail

upstreamBuffer

protected final Queue<T> upstreamBuffer

upstreamState

protected SingleThreadedBufferingSubscriber.BackPressureState upstreamState

upstreamDemand

protected long upstreamDemand

upstreamSubscription

protected Subscription upstreamSubscription

Constructor Detail

SingleThreadedBufferingSubscriber

public SingleThreadedBufferingSubscriber()

Method Detail

onSubscribe

public final void onSubscribe(Subscription subscription)

Specified by:

onSubscribe in interface Subscriber<T>

onComplete

public final void onComplete()

Description copied from interface: Completable

* Successful terminal state. To be called when the operation is complete.

Specified by:

onComplete in interface Completable

Specified by:

onComplete in interface Subscriber<T>

See Also:

Subscriber.onComplete()

onNext

public final void onNext(T message)

Description copied from interface: Emitter

Data notification sent by the Publisher in response to requests to Subscription.request(long).

Specified by:

onNext in interface Emitter<T>

Specified by:

onNext in interface Subscriber<T>

Parameters:

message - the element signaled

onError

public final void onError(Throwable t)

Description copied from interface: Emitter

Failed terminal state.

No further events will be sent even if Subscription.request(long) is invoked again.

Specified by:

onError in interface Emitter<T>

Specified by:

onError in interface Subscriber<T>

Parameters:

t - the throwable signaled

doOnSubscribe

protected abstract void doOnSubscribe(Subscription subscription)

Implement Subscriber.onSubscribe(Subscription).

Parameters:

subscription - The subscription

doOnNext

protected abstract void doOnNext(T message)

Implement Subscriber.onNext(Object).

Parameters:

message - The message

doOnError

protected abstract void doOnError(Throwable t)

Implement Subscriber.onError(Throwable).

Parameters:

t - The throwable

doOnComplete

protected abstract void doOnComplete()

Implement Subscriber.onComplete().

provideDownstreamSubscription

protected void provideDownstreamSubscription(Subscriber subscriber)

Parameters:

subscriber - The subscriber

newDownstreamSubscription

protected Subscription newDownstreamSubscription()

Returns:

The subscription