reactor.netty.resources

Class ConnectionProvider.ConnectionPoolSpec<SPEC extends ConnectionProvider.ConnectionPoolSpec<SPEC>>

java.lang.Object

reactor.netty.resources.ConnectionProvider.ConnectionPoolSpec<SPEC>

All Implemented Interfaces:

java.util.function.Supplier<SPEC>

Direct Known Subclasses:

ConnectionProvider.Builder, ConnectionProvider.HostSpecificSpec

Enclosing interface:

ConnectionProvider

public static class ConnectionProvider.ConnectionPoolSpec<SPEC extends ConnectionProvider.ConnectionPoolSpec<SPEC>>
extends Object
implements java.util.function.Supplier<SPEC>

Method Summary

Modifier and Type	Method and Description
SPEC	fifo() Build a FIFO flavor of Pool, that is to say a flavor where the first Pool.acquire() Mono that was pending is served first whenever a resource becomes available.
SPEC	get()
SPEC	lifo() Build a LIFO flavor of Pool, that is to say a flavor where the last Pool.acquire() Mono that was pending is served first whenever a resource becomes available.
SPEC	maxConnections(int maxConnections) Set the options to use for configuring ConnectionProvider maximum connections per connection pool.
SPEC	maxIdleTime(java.time.Duration maxIdleTime) Set the options to use for configuring ConnectionProvider max idle time (resolution: ms).
SPEC	maxLifeTime(java.time.Duration maxLifeTime) Set the options to use for configuring ConnectionProvider max life time (resolution: ms).
SPEC	metrics(boolean metricsEnabled) Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.CONNECTION_PROVIDER_PREFIX.
SPEC	pendingAcquireMaxCount(int pendingAcquireMaxCount) Set the options to use for configuring ConnectionProvider the maximum number of registered requests for acquire to keep in a pending queue When invoked with -1 the pending queue will not have upper limit.
SPEC	pendingAcquireTimeout(java.time.Duration pendingAcquireTimeout) Set the options to use for configuring ConnectionProvider acquire timeout (resolution: ms).

Methods inherited from class java.lang.Object

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

Method Detail

pendingAcquireTimeout

public final SPEC pendingAcquireTimeout(java.time.Duration pendingAcquireTimeout)

Set the options to use for configuring ConnectionProvider acquire timeout (resolution: ms). Default to ConnectionProvider.DEFAULT_POOL_ACQUIRE_TIMEOUT.

Parameters:

pendingAcquireTimeout - the maximum time after which a pending acquire must complete or the TimeoutException will be thrown (resolution: ms)

Returns:

this

Throws:

NullPointerException - if pendingAcquireTimeout is null

maxConnections

public final SPEC maxConnections(int maxConnections)

Set the options to use for configuring ConnectionProvider maximum connections per connection pool. Default to ConnectionProvider.DEFAULT_POOL_MAX_CONNECTIONS.

Parameters:

maxConnections - the maximum number of connections (per connection pool) before start pending

Returns:

this

Throws:

IllegalArgumentException - if maxConnections is negative

pendingAcquireMaxCount

public final SPEC pendingAcquireMaxCount(int pendingAcquireMaxCount)

Set the options to use for configuring ConnectionProvider the maximum number of registered requests for acquire to keep in a pending queue When invoked with -1 the pending queue will not have upper limit. Default to 2 * max connections.

Parameters:

pendingAcquireMaxCount - the maximum number of registered requests for acquire to keep in a pending queue

Returns:

this

Throws:

IllegalArgumentException - if pendingAcquireMaxCount is negative

maxIdleTime

public final SPEC maxIdleTime(java.time.Duration maxIdleTime)

Set the options to use for configuring ConnectionProvider max idle time (resolution: ms). Default to ConnectionProvider.DEFAULT_POOL_MAX_IDLE_TIME if specified otherwise - no max idle time.

Parameters:

maxIdleTime - the Duration after which the channel will be closed when idle (resolution: ms)

Returns:

this

maxLifeTime

public final SPEC maxLifeTime(java.time.Duration maxLifeTime)

Set the options to use for configuring ConnectionProvider max life time (resolution: ms). By default no max life time.

Parameters:

maxLifeTime - the Duration after which the channel will be closed (resolution: ms)

Returns:

this

metrics

public final SPEC metrics(boolean metricsEnabled)

Whether to enable metrics to be collected and registered in Micrometer's globalRegistry under the name Metrics.CONNECTION_PROVIDER_PREFIX. Applications can separately register their own filters associated with this name. For example, to put an upper bound on the number of tags produced:

 MeterFilter filter = ... ;
 Metrics.globalRegistry.config().meterFilter(MeterFilter.maximumAllowableTags(CONNECTION_PROVIDER_PREFIX, 100, filter));
 

By default this is not enabled.

Parameters:

metricsEnabled - true enables metrics collection; false disables it

Returns:

this

lifo

public final SPEC lifo()

Build a LIFO flavor of Pool, that is to say a flavor where the last Pool.acquire() Mono that was pending is served first whenever a resource becomes available.

Returns:

a builder of Pool with LIFO pending acquire ordering

fifo

public final SPEC fifo()

Build a FIFO flavor of Pool, that is to say a flavor where the first Pool.acquire() Mono that was pending is served first whenever a resource becomes available.

Returns:

a builder of Pool with FIFO pending acquire ordering

get

public SPEC get()

Specified by:

get in interface java.util.function.Supplier<SPEC extends ConnectionProvider.ConnectionPoolSpec<SPEC>>