io.grpc.stub

Class ClientCallStreamObserver<V>

java.lang.Object

io.grpc.stub.CallStreamObserver<V>

io.grpc.stub.ClientCallStreamObserver<V>

All Implemented Interfaces:

StreamObserver<V>

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1788")
 @DoNotMock
public abstract class ClientCallStreamObserver<V>
extends CallStreamObserver<V>

A refinement of CallStreamObserver that allows for lower-level interaction with client calls.

Like StreamObserver, implementations are not required to be thread-safe; if multiple threads will be writing to an instance concurrently, the application must synchronize its calls.

Constructor Summary

Constructors

Constructor and Description
ClientCallStreamObserver()

Method Summary

Modifier and Type	Method and Description
abstract void	cancel(String message, Throwable cause) Prevent any further processing for this ClientCallStreamObserver.

Methods inherited from class io.grpc.stub.CallStreamObserver

disableAutoInboundFlowControl, isReady, request, setMessageCompression, setOnReadyHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.stub.StreamObserver

onCompleted, onError, onNext

Constructor Detail

ClientCallStreamObserver

public ClientCallStreamObserver()

Method Detail

cancel

public abstract void cancel(@Nullable
                            String message,
                            @Nullable
                            Throwable cause)

Prevent any further processing for this ClientCallStreamObserver. No further messages will be received. The server is informed of cancellations, but may not stop processing the call. Cancelling an already cancel()ed ClientCallStreamObserver has no effect.

No other methods on this class can be called after this method has been called.

It is recommended that at least one of the arguments to be non-null, to provide useful debug information. Both argument being null may log warnings and result in suboptimal performance. Also note that the provided information will not be sent to the server.

Parameters:

message - if not null, will appear as the description of the CANCELLED status

cause - if not null, will appear as the cause of the CANCELLED status