io.grpc.testing

Class StreamRecorder<T>

java.lang.Object

io.grpc.testing.StreamRecorder<T>

All Implemented Interfaces:

io.grpc.stub.StreamObserver<T>

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1791")
public class StreamRecorder<T>
extends Object
implements io.grpc.stub.StreamObserver<T>

Utility implementation of StreamObserver used in testing. Records all the observed values produced by the stream as well as any errors.

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Waits for the stream to terminate.
boolean	awaitCompletion(int timeout, TimeUnit unit) Waits a fixed timeout for the stream to terminate.
static <T> StreamRecorder<T>	create() Creates a new recorder.
com.google.common.util.concurrent.ListenableFuture<T>	firstValue() Returns a ListenableFuture for the first value received from the stream.
Throwable	getError() Returns the stream terminating error.
List<T>	getValues() Returns the current set of received values.
void	onCompleted()
void	onError(Throwable t)
void	onNext(T value)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> StreamRecorder<T> create()

Creates a new recorder.

onNext

public void onNext(T value)

Specified by:

onNext in interface io.grpc.stub.StreamObserver<T>

onError

public void onError(Throwable t)

Specified by:

onError in interface io.grpc.stub.StreamObserver<T>

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<T>

awaitCompletion

public void awaitCompletion()
                     throws Exception

Waits for the stream to terminate.

Throws:

Exception

awaitCompletion

public boolean awaitCompletion(int timeout,
                               TimeUnit unit)
                        throws Exception

Waits a fixed timeout for the stream to terminate.

Throws:

Exception

getValues

public List<T> getValues()

Returns the current set of received values.

getError

@Nullable
public Throwable getError()

Returns the stream terminating error.

firstValue

public com.google.common.util.concurrent.ListenableFuture<T> firstValue()

Returns a ListenableFuture for the first value received from the stream. Useful for testing unary call patterns.