io.servicetalk.client.api

Interface LoadBalancedConnection

All Superinterfaces:

AsyncCloseable, ListenableAsyncCloseable, RequestConcurrencyController, ReservableRequestConcurrencyController, ScoreSupplier

public interface LoadBalancedConnection
extends ScoreSupplier, ReservableRequestConcurrencyController, ListenableAsyncCloseable

A connection managed by a LoadBalancer.

See Also:

ScoreSupplier, ReservableRequestConcurrencyController

Nested Class Summary

Nested classes/interfaces inherited from interface RequestConcurrencyController

RequestConcurrencyController.Result

Method Summary

Modifier and Type	Method and Description
default Completable	releaseAsync() Must be called (and subscribed to) to signify the reservation has completed after ReservableRequestConcurrencyController.tryReserve().
default void	requestFinished() Must be called after RequestConcurrencyController.tryRequest() to signify the request has completed.
default RequestConcurrencyController.Result	tryRequest() Attempts to reserve a connection for a single request, needs to be followed by RequestConcurrencyController.requestFinished().
default boolean	tryReserve() Attempts to reserve a connection for exclusive use until ReservableRequestConcurrencyController.releaseAsync() is called.

Methods inherited from interface ScoreSupplier

score

Methods inherited from interface ListenableAsyncCloseable

onClose, onClosing

Methods inherited from interface AsyncCloseable

closeAsync, closeAsyncGracefully

Method Detail

tryRequest

default RequestConcurrencyController.Result tryRequest()

Description copied from interface: RequestConcurrencyController

Attempts to reserve a connection for a single request, needs to be followed by RequestConcurrencyController.requestFinished().

Specified by:

tryRequest in interface RequestConcurrencyController

Returns:

RequestConcurrencyController.Result.Accepted if this connection is available and reserved for performing a single request.

requestFinished

default void requestFinished()

Description copied from interface: RequestConcurrencyController

Must be called after RequestConcurrencyController.tryRequest() to signify the request has completed. This method should be called no more than once for each call to RequestConcurrencyController.tryRequest().

Generally called from a Publisher.beforeFinally(Runnable) after a RequestConcurrencyController.tryRequest().

Specified by:

requestFinished in interface RequestConcurrencyController

tryReserve

default boolean tryReserve()

Description copied from interface: ReservableRequestConcurrencyController

Attempts to reserve a connection for exclusive use until ReservableRequestConcurrencyController.releaseAsync() is called.

Specified by:

tryReserve in interface ReservableRequestConcurrencyController

Returns:

true if this connection is available and reserved for performing a single request.

releaseAsync

default Completable releaseAsync()

Description copied from interface: ReservableRequestConcurrencyController

Must be called (and subscribed to) to signify the reservation has completed after ReservableRequestConcurrencyController.tryReserve().

Specified by:

releaseAsync in interface ReservableRequestConcurrencyController

Returns:

a Completable for the release.