Package io.servicetalk.concurrent.test.internal

Class TestPublisherSubscriber<T>

java.lang.Object

io.servicetalk.concurrent.test.internal.TestPublisherSubscriber<T>

Type Parameters:

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

All Implemented Interfaces:

PublisherSource.Subscriber<T>

public final class TestPublisherSubscriber<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:

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

     // 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	Description
TestPublisherSubscriber()	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	awaitOnComplete()	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).
PublisherSource.Subscription	awaitSubscription()	Block until PublisherSource.Subscriber.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.
java.util.function.Supplier<T>	pollOnNext(long timeout, java.util.concurrent.TimeUnit unit)	Blocks for at most timeout time until the next onNext(Object) method invocation.
java.util.function.Supplier<java.lang.Throwable>	pollTerminal(long timeout, java.util.concurrent.TimeUnit unit)	Block for a terminal event.
T	takeOnNext()	Blocks until the next onNext(Object) method invocation.
java.util.List<T>	takeOnNext(int n)	Blocks until n onNext(Object) method invocations.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestPublisherSubscriber

public TestPublisherSubscriber()

Create a new instance.

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()

Block until PublisherSource.Subscriber.onSubscribe(Subscription).

Returns:

The PublisherSource.Subscription from PublisherSource.Subscriber.onSubscribe(Subscription).

takeOnNext

@Nullable
public T takeOnNext()

Blocks until the next onNext(Object) method invocation.

Returns:

item delivered to onNext(Object).

takeOnNext

public java.util.List<T> takeOnNext(int n)

Blocks until n onNext(Object) method invocations.

Parameters:

n - The number of onNext(Object) to consume.

Returns:

A List containing n onNext(Object) signals.

pollAllOnNext

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

Consume all currently available onNext(Object) signals.

Returns:

List containing all currently available onNext(Object) signals.

pollOnNext

@Nullable
public java.util.function.Supplier<T> pollOnNext(long timeout,
                                                 java.util.concurrent.TimeUnit unit)

Blocks for at most timeout time until the next onNext(Object) method invocation.

Parameters:

timeout - The amount of time to wait.

unit - The units of timeout.

Returns:

A Supplier that returns the signal delivered to onNext(Object), or null if a timeout occurred or a terminal signal has been received.

awaitOnError

public java.lang.Throwable awaitOnError()

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).

awaitOnComplete

public void awaitOnComplete()

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.

pollTerminal

@Nullable
public java.util.function.Supplier<java.lang.Throwable> pollTerminal(long timeout,
                                                                     java.util.concurrent.TimeUnit unit)

Block for a terminal event.

Parameters:

timeout - The duration of time to wait.

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

Returns:

null if a the timeout expires before a terminal event is received. A non-null Supplier that returns null if onComplete(), or the Throwable from onError(Throwable).