io.servicetalk.grpc.api

Class DelegatingGrpcClientBuilder<U,R>

Object

DelegatingGrpcClientBuilder<U,R>

Type Parameters:

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

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

All Implemented Interfaces:

GrpcClientBuilder<U,R>

public class DelegatingGrpcClientBuilder<U,R>
extends Object
implements GrpcClientBuilder<U,R>

A GrpcClientBuilder that delegates all methods to another GrpcClientBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface GrpcClientBuilder

GrpcClientBuilder.HttpInitializer<U,R>, GrpcClientBuilder.MultiClientBuilder

Constructor Summary

Constructors

Constructor and Description
DelegatingGrpcClientBuilder(GrpcClientBuilder<U,R> delegate)

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.
GrpcClientBuilder<U,R>	defaultTimeout(Duration defaultTimeout, boolean appendTimeoutFilter) Set default timeout during which gRPC calls are expected to complete.
protected GrpcClientBuilder<U,R>	delegate() Returns the GrpcClientBuilder delegate.
GrpcClientBuilder<U,R>	initializeHttp(GrpcClientBuilder.HttpInitializer<U,R> initializer) Set a function which can configure the underlying SingleAddressHttpClientBuilder used for the transport layer.
String	toString()

Methods inherited from class Object

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

Constructor Detail

DelegatingGrpcClientBuilder

public DelegatingGrpcClientBuilder(GrpcClientBuilder<U,R> delegate)

Method Detail

delegate

protected final GrpcClientBuilder<U,R> delegate()

Returns the GrpcClientBuilder delegate.

Returns:

Delegate GrpcClientBuilder.

toString

public String toString()

Overrides:

toString in class Object

initializeHttp

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

Description copied from interface: GrpcClientBuilder

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

Specified by:

initializeHttp in interface GrpcClientBuilder<U,R>

Parameters:

initializer - Initializes the underlying HTTP transport builder.

Returns:

this.

defaultTimeout

public GrpcClientBuilder<U,R> defaultTimeout(Duration defaultTimeout)

Description copied from interface: GrpcClientBuilder

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.

Specified by:

defaultTimeout in interface GrpcClientBuilder<U,R>

Parameters:

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

Returns:

this.

See Also:

GrpcClientBuilder.defaultTimeout(Duration, boolean)

defaultTimeout

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

Description copied from interface: GrpcClientBuilder

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.

Specified by:

defaultTimeout in interface GrpcClientBuilder<U,R>

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 GrpcClientBuilder.initializeHttp(io.servicetalk.grpc.api.GrpcClientBuilder.HttpInitializer<U, R>) and SingleAddressHttpClientBuilder.appendClientFilter(StreamingHttpClientFilterFactory).

Returns:

this.

See Also:

GrpcFilters.newGrpcDeadlineClientFilterFactory()

build

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

Description copied from interface: GrpcClientBuilder

Builds a gRPC client.

Specified by:

build in interface GrpcClientBuilder<U,R>

Type Parameters:

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

Parameters:

clientFactory - GrpcClientFactory to use.

Returns:

A gRPC client.

buildBlocking

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

Description copied from interface: GrpcClientBuilder

Builds a blocking gRPC client.

Specified by:

buildBlocking in interface GrpcClientBuilder<U,R>

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

public GrpcClientBuilder.MultiClientBuilder buildMulti()

Description copied from interface: GrpcClientBuilder

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.

Specified by:

buildMulti in interface GrpcClientBuilder<U,R>

Returns:

A builder that allows reusing underlying transport between gRPC clients.