io.grpc.stub

Class ClientCalls

java.lang.Object

io.grpc.stub.ClientCalls

public final class ClientCalls
extends Object

Utility functions for processing different call idioms. We have one-to-one correspondence between utilities in this class and the potential signatures in a generated stub class so that the runtime can vary behavior without requiring regeneration of the stub.

Method Summary

Modifier and Type	Method and Description
static <ReqT,RespT> StreamObserver<ReqT>	asyncBidiStreamingCall(io.grpc.ClientCall<ReqT,RespT> call, StreamObserver<RespT> responseObserver) Executes a bidirectional-streaming call.
static <ReqT,RespT> StreamObserver<ReqT>	asyncClientStreamingCall(io.grpc.ClientCall<ReqT,RespT> call, StreamObserver<RespT> responseObserver) Executes a client-streaming call returning a StreamObserver for the request messages.
static <ReqT,RespT> void	asyncServerStreamingCall(io.grpc.ClientCall<ReqT,RespT> call, ReqT req, StreamObserver<RespT> responseObserver) Executes a server-streaming call with a response StreamObserver.
static <ReqT,RespT> void	asyncUnaryCall(io.grpc.ClientCall<ReqT,RespT> call, ReqT req, StreamObserver<RespT> responseObserver) Executes a unary call with a response StreamObserver.
static <ReqT,RespT> Iterator<RespT>	blockingServerStreamingCall(io.grpc.Channel channel, io.grpc.MethodDescriptor<ReqT,RespT> method, io.grpc.CallOptions callOptions, ReqT req) Executes a server-streaming call returning a blocking Iterator over the response stream.
static <ReqT,RespT> Iterator<RespT>	blockingServerStreamingCall(io.grpc.ClientCall<ReqT,RespT> call, ReqT req) Executes a server-streaming call returning a blocking Iterator over the response stream.
static <ReqT,RespT> RespT	blockingUnaryCall(io.grpc.Channel channel, io.grpc.MethodDescriptor<ReqT,RespT> method, io.grpc.CallOptions callOptions, ReqT req) Executes a unary call and blocks on the response.
static <ReqT,RespT> RespT	blockingUnaryCall(io.grpc.ClientCall<ReqT,RespT> call, ReqT req) Executes a unary call and blocks on the response.
static <ReqT,RespT> com.google.common.util.concurrent.ListenableFuture<RespT>	futureUnaryCall(io.grpc.ClientCall<ReqT,RespT> call, ReqT req) Executes a unary call and returns a ListenableFuture to the response.

Methods inherited from class java.lang.Object

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

Method Detail

asyncUnaryCall

public static <ReqT,RespT> void asyncUnaryCall(io.grpc.ClientCall<ReqT,RespT> call,
                                               ReqT req,
                                               StreamObserver<RespT> responseObserver)

Executes a unary call with a response StreamObserver. The call should not be already started. After calling this method, call should no longer be used.

If the provided responseObserver is an instance of ClientResponseObserver, beforeStart() will be called.

asyncServerStreamingCall

public static <ReqT,RespT> void asyncServerStreamingCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                         ReqT req,
                                                         StreamObserver<RespT> responseObserver)

Executes a server-streaming call with a response StreamObserver. The call should not be already started. After calling this method, call should no longer be used.

If the provided responseObserver is an instance of ClientResponseObserver, beforeStart() will be called.

asyncClientStreamingCall

public static <ReqT,RespT> StreamObserver<ReqT> asyncClientStreamingCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                                         StreamObserver<RespT> responseObserver)

Executes a client-streaming call returning a StreamObserver for the request messages. The call should not be already started. After calling this method, call should no longer be used.

If the provided responseObserver is an instance of ClientResponseObserver, beforeStart() will be called.

Returns:

request stream observer. It will extend ClientCallStreamObserver

asyncBidiStreamingCall

public static <ReqT,RespT> StreamObserver<ReqT> asyncBidiStreamingCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                                       StreamObserver<RespT> responseObserver)

Executes a bidirectional-streaming call. The call should not be already started. After calling this method, call should no longer be used.

If the provided responseObserver is an instance of ClientResponseObserver, beforeStart() will be called.

Returns:

request stream observer. It will extend ClientCallStreamObserver

blockingUnaryCall

public static <ReqT,RespT> RespT blockingUnaryCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                   ReqT req)

Executes a unary call and blocks on the response. The call should not be already started. After calling this method, call should no longer be used.

Returns:

the single response message.

Throws:

io.grpc.StatusRuntimeException - on error

blockingUnaryCall

public static <ReqT,RespT> RespT blockingUnaryCall(io.grpc.Channel channel,
                                                   io.grpc.MethodDescriptor<ReqT,RespT> method,
                                                   io.grpc.CallOptions callOptions,
                                                   ReqT req)

Executes a unary call and blocks on the response. The call should not be already started. After calling this method, call should no longer be used.

Returns:

the single response message.

Throws:

io.grpc.StatusRuntimeException - on error

blockingServerStreamingCall

public static <ReqT,RespT> Iterator<RespT> blockingServerStreamingCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                                       ReqT req)

Executes a server-streaming call returning a blocking Iterator over the response stream. The call should not be already started. After calling this method, call should no longer be used.

The returned iterator may throw StatusRuntimeException on error.

Returns:

an iterator over the response stream.

blockingServerStreamingCall

public static <ReqT,RespT> Iterator<RespT> blockingServerStreamingCall(io.grpc.Channel channel,
                                                                       io.grpc.MethodDescriptor<ReqT,RespT> method,
                                                                       io.grpc.CallOptions callOptions,
                                                                       ReqT req)

Executes a server-streaming call returning a blocking Iterator over the response stream. The call should not be already started. After calling this method, call should no longer be used.

The returned iterator may throw StatusRuntimeException on error.

Returns:

an iterator over the response stream.

futureUnaryCall

public static <ReqT,RespT> com.google.common.util.concurrent.ListenableFuture<RespT> futureUnaryCall(io.grpc.ClientCall<ReqT,RespT> call,
                                                                                                     ReqT req)

Executes a unary call and returns a ListenableFuture to the response. The call should not be already started. After calling this method, call should no longer be used.

Returns:

a future for the single response message.