io.grpc.stub

Class StreamRecorder<T>

java.lang.Object

io.grpc.stub.StreamRecorder<T>

All Implemented Interfaces:

StreamObserver<T>

public class StreamRecorder<T>
extends Object
implements 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.
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() Receives a notification of successful stream completion.
void	onError(Throwable t) Receives a terminating error from the stream.
void	onValue(T value) Receives a value from the stream.

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.

onValue

public void onValue(T value)

Description copied from interface: StreamObserver

Receives a value from the stream.

Can be called many times but is never called after StreamObserver.onError(Throwable) or StreamObserver.onCompleted() are called.

If an exception is thrown by an implementation the caller is expected to terminate the stream by calling StreamObserver.onError(Throwable) with the caught exception prior to propagating it.

Specified by:

onValue in interface StreamObserver<T>

Parameters:

value - the value passed to the stream

onError

public void onError(Throwable t)

Description copied from interface: StreamObserver

Receives a terminating error from the stream.

May only be called once and is never called after StreamObserver.onCompleted(). In particular if an exception is thrown by an implementation of onError no further calls to any method are allowed.

Specified by:

onError in interface StreamObserver<T>

Parameters:

t - the error occurred on the stream

onCompleted

public void onCompleted()

Description copied from interface: StreamObserver

Receives a notification of successful stream completion.

May only be called once and is never called after StreamObserver.onError(Throwable). In particular if an exception is thrown by an implementation of onCompleted no further calls to any method are allowed.

Specified by:

onCompleted in interface 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 ListenableFuture<T> firstValue()

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