io.servicetalk.client.api

Interface LoadBalancedAddress<C extends LoadBalancedConnection>

Type Parameters:

C - type of LoadBalancedConnection.

All Superinterfaces:

AsyncCloseable, ListenableAsyncCloseable, ScoreSupplier

public interface LoadBalancedAddress<C extends LoadBalancedConnection>
extends ListenableAsyncCloseable, ScoreSupplier

An address managed by a LoadBalancer.

Note: ScoreSupplier contract provides this address' score, where 0.0 is the lowest score and 1.0 is the highest. LoadBalancers prefer addresses with a higher score. Note: Weight provides a way to influence the selection of the connection with external factors. With a range of 0.1 to 1.0 influencing the connection score for selectivity.

Method Summary

Modifier and Type	Method and Description
Single<C>	newConnection() Creates and asynchronously returns a connection for this address.
default float	weight(float weight) Enables addresses scoring to be influenced by a weight factor.

Methods inherited from interface ListenableAsyncCloseable

onClose

Methods inherited from interface AsyncCloseable

closeAsync, closeAsyncGracefully

Methods inherited from interface ScoreSupplier

score

Method Detail

newConnection

Single<C> newConnection()

Creates and asynchronously returns a connection for this address.

Returns:

Single that emits the created LoadBalancedConnection.

weight

default float weight(float weight)

Enables addresses scoring to be influenced by a weight factor. Sets the weight of a resource and returns the previous one.

Parameters:

weight - The new weight.

Returns:

the previous associated weight.