Package io.servicetalk.concurrent.api

Class TestCompletable

java.lang.Object

io.servicetalk.concurrent.api.Completable

io.servicetalk.concurrent.api.TestCompletable

All Implemented Interfaces:

CompletableSource

public final class TestCompletable
extends Completable
implements CompletableSource

A Completable & CompletableSource whose outgoing signals to its CompletableSource.Subscribers can be controlled.

Behavior beyond simply delegating signals to the CompletableSource.Subscriber is accomplished by a Function<Subscriber<? super T>, Subscriber<? super T>>. This Function is invoked for every subscribe(Subscriber) invocation, and the result is used as the delegate for subsequent onSubscribe(Cancellable), onComplete(), and onError(Throwable) calls. See TestCompletable.Builder for more information.

Defaults

• Allows sequential but not concurrent subscribers.
• Sends onSubscribe(Cancellable) automatically when subscribed to.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestCompletable.Builder	Allows for creating TestCompletables with non-default settings.

Nested classes/interfaces inherited from interface io.servicetalk.concurrent.CompletableSource

CompletableSource.Processor, CompletableSource.Subscriber

Constructor Summary

Constructors

Constructor	Description
TestCompletable()	Create a TestCompletable with the defaults.

Method Summary

Modifier and Type	Method	Description
protected void	handleSubscribe(CompletableSource.Subscriber subscriber)	Handles a subscriber to this Completable.
boolean	isSubscribed()	Returns true if this TestCompletable has been subscribed to, false otherwise.
void	onComplete()	Completes the CompletableSource.Subscriber.
void	onError(java.lang.Throwable t)	Delivers the Throwable t to the CompletableSource.Subscriber.
void	onSubscribe(Cancellable cancellable)	Delivers the Cancellable to the CompletableSource.Subscriber's CompletableSource.Subscriber.onSubscribe(Cancellable).
void	subscribe(CompletableSource.Subscriber subscriber)	Subscribes to the outcome of this CompletableSource.

Methods inherited from class io.servicetalk.concurrent.api.Completable

afterCancel, afterFinally, afterFinally, afterOnComplete, afterOnError, afterOnSubscribe, afterSubscriber, amb, amb, ambWith, anyOf, anyOf, beforeCancel, beforeFinally, beforeFinally, beforeOnComplete, beforeOnError, beforeOnSubscribe, beforeSubscriber, completed, concat, concat, concat, defer, failed, fromFuture, fromRunnable, fromStage, idleTimeout, idleTimeout, idleTimeout, idleTimeout, liftAsync, liftSync, merge, merge, merge, merge, mergeAll, mergeAll, mergeAll, mergeAll, mergeAllDelayError, mergeAllDelayError, mergeAllDelayError, mergeAllDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, never, onErrorResume, publishAndSubscribeOn, publishAndSubscribeOnOverride, publishOn, publishOnOverride, repeat, repeatWhen, retry, retryWhen, subscribe, subscribe, subscribeInternal, subscribeOn, subscribeOnOverride, subscribeShareContext, toCompletionStage, toFuture, toPublisher, toSingle, whenCancel, whenFinally, whenFinally, whenOnComplete, whenOnError, whenOnSubscribe, whenSubscriber

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCompletable

public TestCompletable()

Create a TestCompletable with the defaults. See Defaults section of class javadoc.

Method Detail

isSubscribed

public boolean isSubscribed()

Returns true if this TestCompletable has been subscribed to, false otherwise.

Returns:

true if this TestCompletable has been subscribed to, false otherwise.

handleSubscribe

protected void handleSubscribe(CompletableSource.Subscriber subscriber)

Description copied from class: Completable

Handles a subscriber to this Completable.

This method is invoked internally by Completable for every call to the Completable.subscribeInternal(CompletableSource.Subscriber) method.

Specified by:

handleSubscribe in class Completable

Parameters:

subscriber - the subscriber.

subscribe

public void subscribe(CompletableSource.Subscriber subscriber)

Description copied from interface: CompletableSource

Subscribes to the outcome of this CompletableSource.

Specified by:

subscribe in interface CompletableSource

Parameters:

subscriber - of the outcome.

See Also:

PublisherSource.subscribe(PublisherSource.Subscriber)

onSubscribe

public void onSubscribe(Cancellable cancellable)

Delivers the Cancellable to the CompletableSource.Subscriber's CompletableSource.Subscriber.onSubscribe(Cancellable).

In the case of auto-on-subscribe, the delegating Cancellable sent to the CompletableSource.Subscriber by the auto-on-subscribe will switch to cancellable.

Parameters:

cancellable - the Cancellable

onComplete

public void onComplete()

Completes the CompletableSource.Subscriber.

See Also:

CompletableSource.Subscriber.onComplete()

onError

public void onError(java.lang.Throwable t)

Delivers the Throwable t to the CompletableSource.Subscriber.

Parameters:

t - the error to deliver.

See Also:

CompletableSource.Subscriber.onError(Throwable)