Package io.servicetalk.http.netty

Class DefaultHttpLoadBalancerFactory<ResolvedAddress>

java.lang.Object

io.servicetalk.http.netty.DefaultHttpLoadBalancerFactory<ResolvedAddress>

Type Parameters:

ResolvedAddress - The type of address after resolution.

All Implemented Interfaces:

LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>, HttpLoadBalancerFactory<ResolvedAddress>, ExecutionStrategyInfluencer<ExecutionStrategy>

public final class DefaultHttpLoadBalancerFactory<ResolvedAddress>
extends Object
implements HttpLoadBalancerFactory<ResolvedAddress>

Default implementation of HttpLoadBalancerFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultHttpLoadBalancerFactory.Builder<ResolvedAddress>	A builder for creating instances of DefaultHttpLoadBalancerFactory.

Method Summary

Modifier and Type	Method	Description
LoadBalancer<FilterableStreamingHttpLoadBalancedConnection>	newLoadBalancer(Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher, ConnectionFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection> connectionFactory, String targetResource)	Create a new LoadBalancer.
<T extends FilterableStreamingHttpLoadBalancedConnection> LoadBalancer<T>	newLoadBalancer(String targetResource, Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher, ConnectionFactory<ResolvedAddress,T> connectionFactory)	Create a new LoadBalancer.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.
FilterableStreamingHttpLoadBalancedConnection	toLoadBalancedConnection(FilterableStreamingHttpConnection connection)	Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.
FilterableStreamingHttpLoadBalancedConnection	toLoadBalancedConnection(FilterableStreamingHttpConnection connection, ReservableRequestConcurrencyController concurrencyController, ContextMap context)	Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.client.api.LoadBalancerFactory

newLoadBalancer

Method Details

newLoadBalancer

public <T extends FilterableStreamingHttpLoadBalancedConnection>
LoadBalancer<T> newLoadBalancer(String targetResource,
 Publisher<? extends Collection<? extends ServiceDiscovererEvent<ResolvedAddress>>> eventPublisher,
 ConnectionFactory<ResolvedAddress,T> connectionFactory)

Description copied from interface: LoadBalancerFactory

Create a new LoadBalancer.

Specified by:

newLoadBalancer in interface LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

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

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

Description copied from interface: LoadBalancerFactory

Create a new LoadBalancer.

Specified by:

newLoadBalancer in interface LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

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.

toLoadBalancedConnection

public FilterableStreamingHttpLoadBalancedConnection toLoadBalancedConnection(FilterableStreamingHttpConnection connection)

Description copied from interface: HttpLoadBalancerFactory

Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

Specified by:

toLoadBalancedConnection in interface HttpLoadBalancerFactory<ResolvedAddress>

Parameters:

connection - FilterableStreamingHttpConnection to convert

Returns:

FilterableStreamingHttpLoadBalancedConnection for the passed FilterableStreamingHttpConnection

toLoadBalancedConnection

public FilterableStreamingHttpLoadBalancedConnection toLoadBalancedConnection(FilterableStreamingHttpConnection connection,
 ReservableRequestConcurrencyController concurrencyController,
 @Nullable
 ContextMap context)

Description copied from interface: HttpLoadBalancerFactory

Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

Specified by:

toLoadBalancedConnection in interface HttpLoadBalancerFactory<ResolvedAddress>

Parameters:

connection - FilterableStreamingHttpConnection to convert

concurrencyController - ReservableRequestConcurrencyController to control access to the connection

context - A context of the caller (e.g. request/LB context) or null if no context

Returns:

FilterableStreamingHttpLoadBalancedConnection for the passed FilterableStreamingHttpConnection.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: ExecutionStrategyInfluencer

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

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<ResolvedAddress>

Specified by:

requiredOffloads in interface HttpLoadBalancerFactory<ResolvedAddress>

Specified by:

requiredOffloads in interface LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

Returns:

the ExecutionStrategy required by the influencer.