Package io.servicetalk.client.api

Interface LoadBalancerFactory<ResolvedAddress,C extends LoadBalancedConnection>

Type Parameters:

ResolvedAddress - The type of address after resolution.

C - The type of connection.

All Superinterfaces:

ExecutionStrategyInfluencer<ExecutionStrategy>

All Known Subinterfaces:

HttpLoadBalancerFactory<ResolvedAddress>

All Known Implementing Classes:

CacheConnectionHttpLoadBalanceFactory, DefaultHttpLoadBalancerFactory, DefaultHttpLoadBalancerFactory, RoundRobinLoadBalancerFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface LoadBalancerFactory<ResolvedAddress,C extends LoadBalancedConnection>
extends ExecutionStrategyInfluencer<ExecutionStrategy>

A factory for creating LoadBalancer instances.

Method Summary

Modifier and Type	Method	Description
default <T extends C> LoadBalancer<T>	newLoadBalancer(Publisher<? extends ServiceDiscovererEvent<ResolvedAddress>> eventPublisher, ConnectionFactory<ResolvedAddress,T> connectionFactory)	Deprecated. Use newLoadBalancer(Publisher, ConnectionFactory, String).
default LoadBalancer<C>	newLoadBalancer(Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher, ConnectionFactory<ResolvedAddress,C> connectionFactory, String targetResource)	Create a new LoadBalancer.
<T extends C> LoadBalancer<T>	newLoadBalancer(String targetResource, Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher, ConnectionFactory<ResolvedAddress,T> connectionFactory)	Deprecated. Use newLoadBalancer(Publisher, ConnectionFactory, String).
default ExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Method Details

newLoadBalancer

@Deprecated
default <T extends C> LoadBalancer<T> newLoadBalancer(Publisher<? extends ServiceDiscovererEvent<ResolvedAddress>> eventPublisher,
 ConnectionFactory<ResolvedAddress,T> connectionFactory)

Deprecated.

Use newLoadBalancer(Publisher, ConnectionFactory, String).

Create a new LoadBalancer.

Type Parameters:

T - Type of connections created by the passed ConnectionFactory.

Parameters:

eventPublisher - A stream of ServiceDiscovererEvents which the LoadBalancer can use to connect to physical hosts. Typically generated from a ServiceDiscoverer.

connectionFactory - ConnectionFactory that the returned LoadBalancer will use to generate new connections. Returned LoadBalancer will own the responsibility for this ConnectionFactory and hence will call AsyncCloseable.closeAsync() when AsyncCloseable.closeAsync() is called.

Returns:

a new LoadBalancer.

newLoadBalancer

@Deprecated
<T extends C> LoadBalancer<T> newLoadBalancer(String targetResource,
 Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher,
 ConnectionFactory<ResolvedAddress,T> connectionFactory)

Deprecated.

Use newLoadBalancer(Publisher, ConnectionFactory, String).

Create a new LoadBalancer.

Type Parameters:

T - Type of connections created by the passed ConnectionFactory.

Parameters:

targetResource - A String representation of the target resource for which the created instance will perform load balancing. Bear in mind, load balancing is performed over the a collection of hosts provided via the eventPublisher which may not correspond directly to a single unresolved address, but potentially a merged collection.

eventPublisher - A stream of Collection<ServiceDiscovererEvent> which the LoadBalancer can use to connect to physical hosts. Typically generated from ServiceDiscoverer.

connectionFactory - ConnectionFactory that the returned LoadBalancer will use to generate new connections. Returned LoadBalancer will own the responsibility for this ConnectionFactory and hence will call AsyncCloseable.closeAsync() when AsyncCloseable.closeAsync() is called.

Returns:

a new LoadBalancer.

newLoadBalancer

default LoadBalancer<C> newLoadBalancer(Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher,
 ConnectionFactory<ResolvedAddress,C> connectionFactory,
 String targetResource)

Create a new LoadBalancer.

Parameters:

eventPublisher - A stream of Collection<ServiceDiscovererEvent> which the LoadBalancer can use to connect to physical hosts. Typically generated from ServiceDiscoverer.

connectionFactory - ConnectionFactory that the returned LoadBalancer will use to generate new connections. Returned LoadBalancer will own the responsibility for this ConnectionFactory and hence will call AsyncCloseable.closeAsync() when AsyncCloseable.closeAsync() is called.

targetResource - A String representation of the target resource for which the created instance will perform load balancing. Bear in mind, load balancing is performed over the collection of hosts provided via the eventPublisher which may not correspond directly to a single unresolved address, but potentially a merged collection.

Returns:

a new LoadBalancer.

requiredOffloads

default ExecutionStrategy requiredOffloads()

Description copied from interface: ExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<ResolvedAddress>

Returns:

the ExecutionStrategy required by the influencer.