Module methanol

Package com.github.mizosoft.methanol.internal.flow

Class AbstractQueueSubscription<T>

java.lang.Object

com.github.mizosoft.methanol.internal.flow.AbstractSubscription<T>

com.github.mizosoft.methanol.internal.flow.AbstractPollableSubscription<T>

com.github.mizosoft.methanol.internal.flow.AbstractQueueSubscription<T>

All Implemented Interfaces:

java.util.concurrent.Flow.Subscription

public class AbstractQueueSubscription<T>
extends AbstractPollableSubscription<T>

A subscription that emits items from a queue and completes downstream as soon as a sentinel value is observed.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream, java.util.concurrent.Executor executor)
protected	AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream, java.util.concurrent.Executor executor, java.util.Queue<T> queue)
protected	AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream, java.util.concurrent.Executor executor, java.util.Queue<T> queue, T sentinel)

Method Summary

Modifier and Type	Method	Description
protected void	abort(boolean flowInterrupted)	Releases resources held by this subscription.
protected void	complete()
protected boolean	isComplete()	Returns true if downstream is to be completed.
protected @Nullable T	poll()	Returns the next item, or null if no items are available.
protected void	submit(T item)
protected void	submitAndComplete(T lastItem)
protected void	submitSilently(T item)

Methods inherited from class com.github.mizosoft.methanol.internal.flow.AbstractPollableSubscription

emit

Methods inherited from class com.github.mizosoft.methanol.internal.flow.AbstractSubscription

cancel, cancelOnComplete, cancelOnError, currentDemand, fireOrKeepAlive, fireOrKeepAliveOnError, fireOrKeepAliveOnNext, hasPendingErrors, isCancelled, request, submitOnNext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQueueSubscription

protected AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream,
                                    java.util.concurrent.Executor executor)

AbstractQueueSubscription

protected AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream,
                                    java.util.concurrent.Executor executor,
                                    java.util.Queue<T> queue)

AbstractQueueSubscription

protected AbstractQueueSubscription(java.util.concurrent.Flow.Subscriber<? super T> downstream,
                                    java.util.concurrent.Executor executor,
                                    java.util.Queue<T> queue,
                                    T sentinel)

Method Detail

submit

protected void submit(T item)

submitSilently

protected void submitSilently(T item)

submitAndComplete

protected void submitAndComplete(T lastItem)

poll

protected @Nullable T poll()

Description copied from class: AbstractPollableSubscription

Returns the next item, or null if no items are available.

Specified by:

poll in class AbstractPollableSubscription<T>

isComplete

protected boolean isComplete()

Description copied from class: AbstractPollableSubscription

Returns true if downstream is to be completed. Implementation must ensure true isn't returned unless the subscription knows it won't produce any more items AND there aren't any present items expected to be polled.

Specified by:

isComplete in class AbstractPollableSubscription<T>

abort

protected void abort(boolean flowInterrupted)

Description copied from class: AbstractSubscription

Releases resources held by this subscription. flowInterrupted tells whether cancellation was due to flow interruption by downstream (e.g. calling cancel() or throwing from onNext or onSubscribe), or due to ending the normal flow of signals (onSubscribe -> onNext* -> (onError | onComplete)).

Overrides:

abort in class AbstractSubscription<T>

complete

protected void complete()