io.servicetalk.grpc.api

Interface GrpcClientCallFactory

All Superinterfaces:

AsyncCloseable, ListenableAsyncCloseable

public interface GrpcClientCallFactory
extends ListenableAsyncCloseable

A factory to create gRPC client call objects for different programming models.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GrpcClientCallFactory.BlockingClientCall<Req,Resp> An abstraction to make blocking client calls.
static interface	GrpcClientCallFactory.BlockingRequestStreamingClientCall<Req,Resp> An abstraction to make blocking client calls where request is streaming.
static interface	GrpcClientCallFactory.BlockingResponseStreamingClientCall<Req,Resp> An abstraction to make blocking client calls where response is streaming.
static interface	GrpcClientCallFactory.BlockingStreamingClientCall<Req,Resp> An abstraction to make blocking bi-directional streaming client calls.
static interface	GrpcClientCallFactory.ClientCall<Req,Resp> An abstraction to make asynchronous client calls.
static interface	GrpcClientCallFactory.RequestStreamingClientCall<Req,Resp> An abstraction to make asynchronous client calls where request is streaming.
static interface	GrpcClientCallFactory.ResponseStreamingClientCall<Req,Resp> An abstraction to make asynchronous client calls where response is streaming.
static interface	GrpcClientCallFactory.StreamingClientCall<Req,Resp> An abstraction to make asynchronous bi-directional streaming client calls.

Method Summary

Modifier and Type	Method and Description
GrpcExecutionContext	executionContext() Get the GrpcExecutionContext used during construction of this object.
static GrpcClientCallFactory	from(StreamingHttpClient httpClient, Duration defaultTimeout) Creates a new GrpcClientCallFactory using the passed StreamingHttpClient.
<Req,Resp> GrpcClientCallFactory.BlockingClientCall<Req,Resp>	newBlockingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. use newBlockingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.BlockingClientCall<Req,Resp>	newBlockingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.BlockingClientCall.
<Req,Resp> GrpcClientCallFactory.BlockingRequestStreamingClientCall<Req,Resp>	newBlockingRequestStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newBlockingRequestStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.BlockingRequestStreamingClientCall<Req,Resp>	newBlockingRequestStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.BlockingRequestStreamingClientCall.
<Req,Resp> GrpcClientCallFactory.BlockingResponseStreamingClientCall<Req,Resp>	newBlockingResponseStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newBlockingResponseStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.BlockingResponseStreamingClientCall<Req,Resp>	newBlockingResponseStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.BlockingResponseStreamingClientCall.
<Req,Resp> GrpcClientCallFactory.BlockingStreamingClientCall<Req,Resp>	newBlockingStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newBlockingStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.BlockingStreamingClientCall<Req,Resp>	newBlockingStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.BlockingStreamingClientCall.
<Req,Resp> GrpcClientCallFactory.ClientCall<Req,Resp>	newCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.ClientCall<Req,Resp>	newCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.ClientCall.
<Req,Resp> GrpcClientCallFactory.RequestStreamingClientCall<Req,Resp>	newRequestStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newRequestStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.RequestStreamingClientCall<Req,Resp>	newRequestStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.RequestStreamingClientCall.
<Req,Resp> GrpcClientCallFactory.ResponseStreamingClientCall<Req,Resp>	newResponseStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newResponseStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.ResponseStreamingClientCall<Req,Resp>	newResponseStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.ResponseStreamingClientCall.
<Req,Resp> GrpcClientCallFactory.StreamingClientCall<Req,Resp>	newStreamingCall(GrpcSerializationProvider serializationProvider, Class<Req> requestClass, Class<Resp> responseClass) Deprecated. Use newStreamingCall(MethodDescriptor, BufferDecoderGroup).
<Req,Resp> GrpcClientCallFactory.StreamingClientCall<Req,Resp>	newStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor, BufferDecoderGroup decompressors) Create a new GrpcClientCallFactory.StreamingClientCall.

Methods inherited from interface ListenableAsyncCloseable

onClose, onClosing

Methods inherited from interface AsyncCloseable

closeAsync, closeAsyncGracefully

Method Detail

newCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.ClientCall<Req,Resp> newCall(GrpcSerializationProvider serializationProvider,
                                                                          Class<Req> requestClass,
                                                                          Class<Resp> responseClass)

Deprecated. Use newCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.ClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.ClientCall.

newCall

<Req,Resp> GrpcClientCallFactory.ClientCall<Req,Resp> newCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                              BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.ClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.ClientCall.

newStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.StreamingClientCall<Req,Resp> newStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                            Class<Req> requestClass,
                                                                                            Class<Resp> responseClass)

Deprecated. Use newStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.StreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.StreamingClientCall.

newStreamingCall

<Req,Resp> GrpcClientCallFactory.StreamingClientCall<Req,Resp> newStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.StreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.StreamingClientCall.

newRequestStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.RequestStreamingClientCall<Req,Resp> newRequestStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                                          Class<Req> requestClass,
                                                                                                          Class<Resp> responseClass)

Deprecated. Use newRequestStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.RequestStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.RequestStreamingClientCall.

newRequestStreamingCall

<Req,Resp> GrpcClientCallFactory.RequestStreamingClientCall<Req,Resp> newRequestStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                              BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.RequestStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.RequestStreamingClientCall.

newResponseStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.ResponseStreamingClientCall<Req,Resp> newResponseStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                                            Class<Req> requestClass,
                                                                                                            Class<Resp> responseClass)

Deprecated. Use newResponseStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.ResponseStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.ResponseStreamingClientCall.

newResponseStreamingCall

<Req,Resp> GrpcClientCallFactory.ResponseStreamingClientCall<Req,Resp> newResponseStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                                BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.ResponseStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.ResponseStreamingClientCall.

newBlockingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.BlockingClientCall<Req,Resp> newBlockingCall(GrpcSerializationProvider serializationProvider,
                                                                                          Class<Req> requestClass,
                                                                                          Class<Resp> responseClass)

Deprecated. use newBlockingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.BlockingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.BlockingClientCall.

newBlockingCall

<Req,Resp> GrpcClientCallFactory.BlockingClientCall<Req,Resp> newBlockingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                              BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.BlockingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.BlockingClientCall.

newBlockingStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.BlockingStreamingClientCall<Req,Resp> newBlockingStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                                            Class<Req> requestClass,
                                                                                                            Class<Resp> responseClass)

Deprecated. Use newBlockingStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.BlockingStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.BlockingStreamingClientCall.

newBlockingStreamingCall

<Req,Resp> GrpcClientCallFactory.BlockingStreamingClientCall<Req,Resp> newBlockingStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                                BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.BlockingStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.BlockingStreamingClientCall.

newBlockingRequestStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.BlockingRequestStreamingClientCall<Req,Resp> newBlockingRequestStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                                                          Class<Req> requestClass,
                                                                                                                          Class<Resp> responseClass)

Deprecated. Use newBlockingRequestStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.BlockingRequestStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.BlockingRequestStreamingClientCall.

newBlockingRequestStreamingCall

<Req,Resp> GrpcClientCallFactory.BlockingRequestStreamingClientCall<Req,Resp> newBlockingRequestStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                                              BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.BlockingRequestStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.BlockingRequestStreamingClientCall.

newBlockingResponseStreamingCall

@Deprecated
<Req,Resp> GrpcClientCallFactory.BlockingResponseStreamingClientCall<Req,Resp> newBlockingResponseStreamingCall(GrpcSerializationProvider serializationProvider,
                                                                                                                            Class<Req> requestClass,
                                                                                                                            Class<Resp> responseClass)

Deprecated. Use newBlockingResponseStreamingCall(MethodDescriptor, BufferDecoderGroup).

Creates a new GrpcClientCallFactory.BlockingResponseStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

serializationProvider - GrpcSerializationProvider to use.

requestClass - Class object for the request.

responseClass - Class object for the response.

Returns:

GrpcClientCallFactory.BlockingResponseStreamingClientCall.

newBlockingResponseStreamingCall

<Req,Resp> GrpcClientCallFactory.BlockingResponseStreamingClientCall<Req,Resp> newBlockingResponseStreamingCall(MethodDescriptor<Req,Resp> methodDescriptor,
                                                                                                                BufferDecoderGroup decompressors)

Create a new GrpcClientCallFactory.BlockingResponseStreamingClientCall.

Type Parameters:

Req - Type of request.

Resp - Type of response.

Parameters:

methodDescriptor - describes the method characteristics and how to do serialization of individual objects.

decompressors - describes the decompression that is supported for this call.

Returns:

GrpcClientCallFactory.BlockingResponseStreamingClientCall.

executionContext

GrpcExecutionContext executionContext()

Get the GrpcExecutionContext used during construction of this object.

Note that the ExecutionContext.ioExecutor() will not necessarily be associated with a specific thread unless that was how this object was built.

Returns:

the GrpcExecutionContext used during construction of this object.

from

static GrpcClientCallFactory from(StreamingHttpClient httpClient,
                                  @Nullable
                                  Duration defaultTimeout)

Creates a new GrpcClientCallFactory using the passed StreamingHttpClient.

Parameters:

httpClient - StreamingHttpClient to use. The returned GrpcClientCallFactory will own the lifecycle of this StreamingHttpClient.

defaultTimeout - Duration of default timeout or null for no timeout

Returns:

A new GrpcClientCallFactory.