Package io.grpc.testing

Class StreamRecorder<T>

java.lang.Object

io.grpc.testing.StreamRecorder<T>

All Implemented Interfaces:

StreamObserver<T>

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

Deprecated.

Not for public use

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	Description
void	awaitCompletion()	Deprecated. Waits for the stream to terminate.
boolean	awaitCompletion(int timeout, TimeUnit unit)	Deprecated. Waits a fixed timeout for the stream to terminate.
static <T> StreamRecorder<T>	create()	Deprecated. Creates a new recorder.
com.google.common.util.concurrent.ListenableFuture<T>	firstValue()	Deprecated. Returns a ListenableFuture for the first value received from the stream.
Throwable	getError()	Deprecated. Returns the stream terminating error.
List<T>	getValues()	Deprecated. Returns the current set of received values.
void	onCompleted()	Deprecated. Receives a notification of successful stream completion.
void	onError(Throwable t)	Deprecated. Receives a terminating error from the stream.
void	onNext(T value)	Deprecated. 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()

Deprecated.

Creates a new recorder.

onNext

public void onNext(T value)

Deprecated.

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.

Unary calls must invoke onNext at most once. Clients may invoke onNext at most once for server streaming calls, but may receive many onNext callbacks. Servers may invoke onNext at most once for client streaming calls, but may receive many onNext callbacks.

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:

onNext in interface StreamObserver<T>

Parameters:

value - the value passed to the stream

onError

public void onError(Throwable t)

Deprecated.

Description copied from interface: StreamObserver

Receives a terminating error from the stream.

May only be called once and if called it must be the last method called. In particular if an exception is thrown by an implementation of onError no further calls to any method are allowed.

t should be a StatusException or StatusRuntimeException, but other Throwable types are possible. Callers should generally convert from a Status via Status.asException() or Status.asRuntimeException(). Implementations should generally convert to a Status via Status.fromThrowable(Throwable).

Specified by:

onError in interface StreamObserver<T>

Parameters:

t - the error occurred on the stream

onCompleted

public void onCompleted()

Deprecated.

Description copied from interface: StreamObserver

Receives a notification of successful stream completion.

May only be called once and if called it must be the last method called. 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

Deprecated.

Waits for the stream to terminate.

Throws:

Exception

awaitCompletion

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

Deprecated.

Waits a fixed timeout for the stream to terminate.

Throws:

Exception

getValues

public List<T> getValues()

Deprecated.

Returns the current set of received values.

getError

@Nullable
public Throwable getError()

Deprecated.

Returns the stream terminating error.

firstValue

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

Deprecated.

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