io.servicetalk.concurrent.api

Class TestCollectingPublisherSubscriber<T>

java.lang.Object

io.servicetalk.concurrent.api.TestCollectingPublisherSubscriber<T>

Type Parameters:

T - The type of data in onNext(Object).

All Implemented Interfaces:

PublisherSource.Subscriber<T>

public final class TestCollectingPublisherSubscriber<T>
extends java.lang.Object
implements PublisherSource.Subscriber<T>

A PublisherSource.Subscriber that enqueues onNext(Object) and terminal signals while providing blocking methods to consume these events. There are two approaches to using this class:

     TestCollectingPublisherSubscriber<String> sub = new TestCollectingPublisherSubscriber<>();

     // Approach 1 - verify individual items sequentially.
     String s = sub.takeOnNext();
     // verify s
     sub.awaitOnComplete(); // this will verify that all onNext signals have been consumed

     // Approach 2 - wait for terminal, verify items in bulk.
     sub.awaitOnComplete(false); // wait for the terminal signal, ignore if there are unconsumed onNext signals.
     List<String> onNextSignals = sub.pollAllOnNext();
     // verify all onNextSignals occurred in the expected order
 

Constructor Summary

Constructors

Constructor and Description
TestCollectingPublisherSubscriber()

Method Summary

Modifier and Type	Method and Description
void	awaitOnComplete() Block until a terminal signal is received, throws if onError(Throwable) and returns normally if onComplete().
void	awaitOnComplete(boolean verifyOnNextConsumed) Block until a terminal signal is received, throws if onError(Throwable) and returns normally if onComplete().
java.lang.Throwable	awaitOnError() Block until a terminal signal is received, throws if onComplete() and returns normally if onError(Throwable).
java.lang.Throwable	awaitOnError(boolean verifyOnNextConsumed) Block until a terminal signal is received, throws if onComplete() and returns normally if onError(Throwable).
PublisherSource.Subscription	awaitSubscription() Block until #onSubscribe(Subscription).
void	onComplete() Callback to signal completion of the PublisherSource for this Subscriber.
void	onError(java.lang.Throwable t) Callback to receive an error for this Subscriber.
void	onNext(T t) Callback to receive a data element for this Subscriber.
void	onSubscribe(PublisherSource.Subscription subscription) Callback to receive a PublisherSource.Subscription for this Subscriber.
java.util.List<T>	pollAllOnNext() Consume all currently available onNext(Object) signals.
boolean	pollTerminal(long timeout, java.util.concurrent.TimeUnit unit) Block for a terminal event.
T	takeOnNext() Blocks until the next onNext(Object) method invocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCollectingPublisherSubscriber

public TestCollectingPublisherSubscriber()

Method Detail

onSubscribe

public void onSubscribe(PublisherSource.Subscription subscription)

Description copied from interface: PublisherSource.Subscriber

Callback to receive a PublisherSource.Subscription for this Subscriber.

See Reactive Streams specifications for the rules about how and when this method will be invoked.

Specified by:

onSubscribe in interface PublisherSource.Subscriber<T>

Parameters:

subscription - PublisherSource.Subscription for this Subscriber.

onNext

public void onNext(@Nullable
                   T t)

Description copied from interface: PublisherSource.Subscriber

Callback to receive a data element for this Subscriber.

See Reactive Streams specifications for the rules about how and when this method will be invoked.

Specified by:

onNext in interface PublisherSource.Subscriber<T>

Parameters:

t - A data element.

onError

public void onError(java.lang.Throwable t)

Description copied from interface: PublisherSource.Subscriber

Callback to receive an error for this Subscriber.

See Reactive Streams specifications for the rules about how and when this method will be invoked.

Specified by:

onError in interface PublisherSource.Subscriber<T>

Parameters:

t - error for this Subscriber.

onComplete

public void onComplete()

Description copied from interface: PublisherSource.Subscriber

Callback to signal completion of the PublisherSource for this Subscriber.

See Reactive Streams specifications for the rules about how and when this method will be invoked.

Specified by:

onComplete in interface PublisherSource.Subscriber<T>

awaitSubscription

public PublisherSource.Subscription awaitSubscription()
                                               throws java.lang.InterruptedException

Block until #onSubscribe(Subscription).

Returns:

The PublisherSource.Subscription from #onSubscribe(Subscription).

Throws:

java.lang.InterruptedException - if an interrupt occurs while blocking for waiting for #onSubscribe(Subscription).

takeOnNext

@Nullable
public T takeOnNext()
                       throws java.lang.InterruptedException

Blocks until the next onNext(Object) method invocation.

Returns:

item delivered to onNext(Object).

Throws:

java.lang.InterruptedException - if an interrupt occurs while blocking for the next item.

pollAllOnNext

public java.util.List<T> pollAllOnNext()

Consume all currently available onNext(Object) signals.

Returns:

List containing all currently available onNext(Object) signals.

awaitOnError

public java.lang.Throwable awaitOnError()
                                 throws java.lang.InterruptedException

Block until a terminal signal is received, throws if onComplete() and returns normally if onError(Throwable). This method will verify that all onNext(Object) signals have been consumed.

Returns:

the exception received by onError(Throwable).

Throws:

java.lang.InterruptedException - If an interrupt occurs while blocking for the terminal event.

awaitOnError

public java.lang.Throwable awaitOnError(boolean verifyOnNextConsumed)
                                 throws java.lang.InterruptedException

Block until a terminal signal is received, throws if onComplete() and returns normally if onError(Throwable).

Parameters:

verifyOnNextConsumed - true to verify that all onNext(Object) signals have been consumed and throw if not. false to ignore if onNext(Object) signals have been consumed or not.

Returns:

the exception received by onError(Throwable).

Throws:

java.lang.InterruptedException - If an interrupt occurs while blocking for the terminal event.

awaitOnComplete

public void awaitOnComplete()
                     throws java.lang.InterruptedException

Block until a terminal signal is received, throws if onError(Throwable) and returns normally if onComplete(). This method will verify that all onNext(Object) signals have been consumed.

Throws:

java.lang.InterruptedException - If an interrupt occurs while blocking for the terminal event.

awaitOnComplete

public void awaitOnComplete(boolean verifyOnNextConsumed)
                     throws java.lang.InterruptedException

Block until a terminal signal is received, throws if onError(Throwable) and returns normally if onComplete().

Parameters:

verifyOnNextConsumed - true to verify that all onNext(Object) signals have been consumed and throw if not. false to ignore if onNext(Object) signals have been consumed or not.

Throws:

java.lang.InterruptedException - If an interrupt occurs while blocking for the terminal event.

pollTerminal

public boolean pollTerminal(long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException

Block for a terminal event.

Parameters:

timeout - The duration of time to wait.

unit - The unit of time to apply to the duration.

Returns:

true if a terminal event has been received before the timeout duration.

Throws:

java.lang.InterruptedException - If an interrupt occurs while blocking for the terminal event.