Package io.servicetalk.http.api

Interface HttpLoadBalancerFactory<ResolvedAddress>

Type Parameters:

ResolvedAddress - The type of address after resolution.

All Superinterfaces:

ExecutionStrategyInfluencer<ExecutionStrategy>, LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

All Known Implementing Classes:

CacheConnectionHttpLoadBalanceFactory, DefaultHttpLoadBalancerFactory

public interface HttpLoadBalancerFactory<ResolvedAddress>
extends LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

A LoadBalancerFactory for HTTP clients.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpLoadBalancerFactory.DefaultFilterableStreamingHttpLoadBalancedConnection	Default implementation of FilterableStreamingHttpLoadBalancedConnection.

Method Summary

Modifier and Type	Method	Description
default HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.
default FilterableStreamingHttpLoadBalancedConnection	toLoadBalancedConnection(FilterableStreamingHttpConnection connection)	Deprecated. Implement and use toLoadBalancedConnection(FilterableStreamingHttpConnection, ReservableRequestConcurrencyController, ContextMap)
default FilterableStreamingHttpLoadBalancedConnection	toLoadBalancedConnection(FilterableStreamingHttpConnection connection, ReservableRequestConcurrencyController concurrencyController, ContextMap context)	Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

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

newLoadBalancer, newLoadBalancer, newLoadBalancer

Method Details

toLoadBalancedConnection

@Deprecated
default FilterableStreamingHttpLoadBalancedConnection toLoadBalancedConnection(FilterableStreamingHttpConnection connection)

Deprecated.

Implement and use toLoadBalancedConnection(FilterableStreamingHttpConnection, ReservableRequestConcurrencyController, ContextMap)

Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

Parameters:

connection - FilterableStreamingHttpConnection to convert

Returns:

FilterableStreamingHttpLoadBalancedConnection for the passed FilterableStreamingHttpConnection

toLoadBalancedConnection

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

Converts the passed FilterableStreamingHttpConnection to a FilterableStreamingHttpLoadBalancedConnection.

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

default 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 LoadBalancerFactory<ResolvedAddress,FilterableStreamingHttpLoadBalancedConnection>

Returns:

the ExecutionStrategy required by the influencer.