io.servicetalk.client.api

Class LimitingConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable>

java.lang.Object

io.servicetalk.client.api.LimitingConnectionFactoryFilter<ResolvedAddress,C>

Type Parameters:

ResolvedAddress - The type of a resolved address that can be used for connecting.

C - The type of connections created by this factory.

All Implemented Interfaces:

ConnectionFactoryFilter<ResolvedAddress,C>

public final class LimitingConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable>
extends java.lang.Object
implements ConnectionFactoryFilter<ResolvedAddress,C>

A ConnectionFactory that limits the total number of active connections created using this ConnectionFactory. A connection is considered active if ListenableAsyncCloseable.onClose() has not yet terminated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LimitingConnectionFactoryFilter.ConnectionLimiter<ResolvedAddress,C extends ListenableAsyncCloseable> A contract to limit number of connections created by LimitingConnectionFactoryFilter.

Method Summary

Modifier and Type	Method and Description
ConnectionFactory<ResolvedAddress,C>	create(ConnectionFactory<ResolvedAddress,C> original) Decorates the passed original ConnectionFactory to add the filtering logic.
static <A,C extends ListenableAsyncCloseable> ConnectionFactoryFilter<A,C>	with(LimitingConnectionFactoryFilter.ConnectionLimiter<A,C> limiter) Create a new ConnectionFactory that limits the created connections using the passed LimitingConnectionFactoryFilter.ConnectionLimiter.
static <A,C extends ListenableAsyncCloseable> ConnectionFactoryFilter<A,C>	withMax(int maxConnections) Create a new ConnectionFactory that only creates a maximum of maxConnections active connections.

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.ConnectionFactoryFilter

append, identity

Method Detail

withMax

public static <A,C extends ListenableAsyncCloseable> ConnectionFactoryFilter<A,C> withMax(int maxConnections)

Create a new ConnectionFactory that only creates a maximum of maxConnections active connections.

Type Parameters:

A - The type of a resolved address that can be used for connecting.

C - The type of connections created by the returned factory.

Parameters:

maxConnections - Maximum number of active connections to create.

Returns:

A new ConnectionFactory that limits the number of active connections.

with

public static <A,C extends ListenableAsyncCloseable> ConnectionFactoryFilter<A,C> with(LimitingConnectionFactoryFilter.ConnectionLimiter<A,C> limiter)

Create a new ConnectionFactory that limits the created connections using the passed LimitingConnectionFactoryFilter.ConnectionLimiter.

Type Parameters:

A - The type of a resolved address that can be used for connecting.

C - The type of connections created by the returned factory.

Parameters:

limiter - LimitingConnectionFactoryFilter.ConnectionLimiter to use.

Returns:

A new ConnectionFactory that limits the number of active connections.

create

public ConnectionFactory<ResolvedAddress,C> create(ConnectionFactory<ResolvedAddress,C> original)

Description copied from interface: ConnectionFactoryFilter

Decorates the passed original ConnectionFactory to add the filtering logic.

Specified by:

create in interface ConnectionFactoryFilter<ResolvedAddress,C extends ListenableAsyncCloseable>

Parameters:

original - ConnectionFactory to filter.

Returns:

Decorated ConnectionFactory that contains the filtering logic.