io.servicetalk.grpc.api

Interface GrpcClientBuilder<U,R>

Type Parameters:

U - the type of address before resolution (unresolved address)

R - the type of address after resolution (resolved address)

All Known Implementing Classes:

DelegatingGrpcClientBuilder

public interface GrpcClientBuilder<U,R>

A builder for building a gRPC client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GrpcClientBuilder.HttpInitializer<U,R> Initializes the underlying SingleAddressHttpClientBuilder used for the transport layer.
static interface	GrpcClientBuilder.MultiClientBuilder An interface to create multiple gRPC clients that share the underlying transport.

Method Summary

Modifier and Type	Method and Description
<Client extends GrpcClient<?>> Client	build(GrpcClientFactory<Client,?> clientFactory) Builds a gRPC client.
<BlockingClient extends BlockingGrpcClient<?>> BlockingClient	buildBlocking(GrpcClientFactory<?,BlockingClient> clientFactory) Builds a blocking gRPC client.
GrpcClientBuilder.MultiClientBuilder	buildMulti() Returns a GrpcClientBuilder.MultiClientBuilder to be used to create multiple clients that share the underlying transport.
GrpcClientBuilder<U,R>	defaultTimeout(Duration defaultTimeout) Set default timeout during which gRPC calls are expected to complete.
default GrpcClientBuilder<U,R>	defaultTimeout(Duration defaultTimeout, boolean appendTimeoutFilter) Set default timeout during which gRPC calls are expected to complete.
GrpcClientBuilder<U,R>	initializeHttp(GrpcClientBuilder.HttpInitializer<U,R> initializer) Set a function which can configure the underlying SingleAddressHttpClientBuilder used for the transport layer.

Method Detail

initializeHttp

GrpcClientBuilder<U,R> initializeHttp(GrpcClientBuilder.HttpInitializer<U,R> initializer)

Set a function which can configure the underlying SingleAddressHttpClientBuilder used for the transport layer.

Parameters:

initializer - Initializes the underlying HTTP transport builder.

Returns:

this.

defaultTimeout

GrpcClientBuilder<U,R> defaultTimeout(Duration defaultTimeout)

Set default timeout during which gRPC calls are expected to complete. This default will be used only if the request metadata includes no timeout; any value specified in client request will supersede this default.

Parameters:

defaultTimeout - Duration of default timeout which must be positive non-zero.

Returns:

this.

See Also:

defaultTimeout(Duration, boolean)

defaultTimeout

default GrpcClientBuilder<U,R> defaultTimeout(@Nullable
                                              Duration defaultTimeout,
                                              boolean appendTimeoutFilter)

Set default timeout during which gRPC calls are expected to complete. This default will be used only if the request metadata includes no timeout; any value specified in client request will supersede this default.

Parameters:

defaultTimeout - Duration of default timeout which must be positive non-zero, or null if a default shouldn't be applied.

appendTimeoutFilter - true to append the filter that enforces deadline propagation. false to not append the filter and therefore not enforce deadlines. If false you can manually insert GrpcFilters.newGrpcDeadlineClientFilterFactory() in your preferred order use initializeHttp(io.servicetalk.grpc.api.GrpcClientBuilder.HttpInitializer<U, R>) and SingleAddressHttpClientBuilder.appendClientFilter(StreamingHttpClientFilterFactory).

Returns:

this.

See Also:

GrpcFilters.newGrpcDeadlineClientFilterFactory()

build

<Client extends GrpcClient<?>> Client build(GrpcClientFactory<Client,?> clientFactory)

Builds a gRPC client.

Type Parameters:

Client - gRPC service that any client built from this factory represents.

Parameters:

clientFactory - GrpcClientFactory to use.

Returns:

A gRPC client.

buildBlocking

<BlockingClient extends BlockingGrpcClient<?>> BlockingClient buildBlocking(GrpcClientFactory<?,BlockingClient> clientFactory)

Builds a blocking gRPC client.

Type Parameters:

BlockingClient - Blocking gRPC service that any client built from this builder represents.

Parameters:

clientFactory - GrpcClientFactory to use.

Returns:

A blocking gRPC client.

buildMulti

GrpcClientBuilder.MultiClientBuilder buildMulti()

Returns a GrpcClientBuilder.MultiClientBuilder to be used to create multiple clients that share the underlying transport. It is meant for a single backend that hosts different service APIs.

Returns:

A builder that allows reusing underlying transport between gRPC clients.