io.servicetalk.grpc.netty

Class GrpcClients

Object

GrpcClients

public final class GrpcClients
extends Object

A factory to create gRPC clients.

Method Summary

Modifier and Type	Method and Description
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forAddress(HostAndPort address) Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forAddress(HostAndPort address, HttpClients.DiscoveryStrategy discoveryStrategy) Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static <U,R> GrpcClientBuilder<U,R>	forAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer, U address) Creates a GrpcClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using background discovery strategy.
static <U,R> GrpcClientBuilder<U,R>	forAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer, U address, HttpClients.DiscoveryStrategy discoveryStrategy) Creates a GrpcClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forAddress(String host, int port) Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forAddress(String host, int port, HttpClients.DiscoveryStrategy discoveryStrategy) Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forResolvedAddress(HostAndPort address) Creates a GrpcClientBuilder for an address with default LoadBalancer.
static GrpcClientBuilder<InetSocketAddress,InetSocketAddress>	forResolvedAddress(InetSocketAddress address) Creates a GrpcClientBuilder for an address with default LoadBalancer.
static GrpcClientBuilder<HostAndPort,InetSocketAddress>	forResolvedAddress(String host, int port) Creates a GrpcClientBuilder for a resolved address with default LoadBalancer.
static <T extends SocketAddress> GrpcClientBuilder<T,T>	forResolvedAddress(T address) Creates a GrpcClientBuilder for an address with default LoadBalancer.
static GrpcClientBuilder<String,InetSocketAddress>	forServiceAddress(String serviceName) Creates a GrpcClientBuilder for the passed serviceName with default LoadBalancer and a DNS ServiceDiscoverer using SRV record lookups.

Methods inherited from class Object

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

Method Detail

forAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forAddress(String host,
                                                                          int port)

Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

host - host to connect to, resolved by default using a DNS ServiceDiscoverer.

port - port to connect to

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forAddress(HostAndPort address)

Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

address - the UnresolvedAddress to connect to, resolved by default using a DNS ServiceDiscoverer.

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forAddress(String host,
                                                                          int port,
                                                                          HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

host - host to connect to, resolved by default using a DNS ServiceDiscoverer.

port - port to connect to

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forAddress(HostAndPort address,
                                                                          HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a GrpcClientBuilder for an address with default LoadBalancer and DNS ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

address - the UnresolvedAddress to connect to, resolved by default using a DNS ServiceDiscoverer.

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forServiceAddress

public static GrpcClientBuilder<String,InetSocketAddress> forServiceAddress(String serviceName)

Creates a GrpcClientBuilder for the passed serviceName with default LoadBalancer and a DNS ServiceDiscoverer using SRV record lookups.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

serviceName - the service name to query via SRV DNS.

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forResolvedAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forResolvedAddress(String host,
                                                                                  int port)

Creates a GrpcClientBuilder for a resolved address with default LoadBalancer.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

host - resolved host address to connect to.

port - port to connect to

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forResolvedAddress

public static GrpcClientBuilder<HostAndPort,InetSocketAddress> forResolvedAddress(HostAndPort address)

Creates a GrpcClientBuilder for an address with default LoadBalancer.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

address - the ResolvedAddress to connect to.

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forResolvedAddress

public static GrpcClientBuilder<InetSocketAddress,InetSocketAddress> forResolvedAddress(InetSocketAddress address)

Creates a GrpcClientBuilder for an address with default LoadBalancer.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Parameters:

address - the InetSocketAddress to connect to.

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forResolvedAddress

public static <T extends SocketAddress> GrpcClientBuilder<T,T> forResolvedAddress(T address)

Creates a GrpcClientBuilder for an address with default LoadBalancer.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Type Parameters:

T - The type of SocketAddress.

Parameters:

address - the ResolvedAddress to connect. This address will also be used for the HttpHeaderNames.HOST. Use SingleAddressHttpClientBuilder.unresolvedAddressToHost(Function) via GrpcClientBuilder.initializeHttp(GrpcClientBuilder.HttpInitializer) if you want to override that value or SingleAddressHttpClientBuilder.hostHeaderFallback(boolean) if you want to disable this behavior.

Returns:

new builder for the address

See Also:

GrpcProviders.GrpcClientBuilderProvider

forAddress

public static <U,R> GrpcClientBuilder<U,R> forAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer,
                                                      U address)

Creates a GrpcClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using background discovery strategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Type Parameters:

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

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

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

address - the UnresolvedAddress to connect to resolved using the provided serviceDiscoverer.

Returns:

new builder with provided configuration

See Also:

GrpcProviders.GrpcClientBuilderProvider

forAddress

public static <U,R> GrpcClientBuilder<U,R> forAddress(ServiceDiscoverer<U,R,? extends ServiceDiscovererEvent<R>> serviceDiscoverer,
                                                      U address,
                                                      HttpClients.DiscoveryStrategy discoveryStrategy)

Creates a GrpcClientBuilder for a custom address type with default LoadBalancer and user provided ServiceDiscoverer using the specified HttpClients.DiscoveryStrategy.

The returned builder can be customized using GrpcProviders.GrpcClientBuilderProvider.

Type Parameters:

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

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

Parameters:

serviceDiscoverer - The ServiceDiscoverer to resolve addresses of remote servers to connect to. The lifecycle of the provided ServiceDiscoverer should be managed by the caller.

address - the UnresolvedAddress to connect to resolved using the provided serviceDiscoverer.

discoveryStrategy - HttpClients.DiscoveryStrategy to use

Returns:

new builder with provided configuration

See Also:

GrpcProviders.GrpcClientBuilderProvider