io.r2dbc.pool

Interface ConnectionPoolMXBean

public interface ConnectionPoolMXBean

MBean for ConnectionPool.

Expose PoolMetrics values to JMX.

Author:

Tadaya Tsuyukubo

See Also:

PoolMetrics

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN

Method Summary

Modifier and Type	Method and Description
int	getAcquiredSize() Measure the current number of connections that have been successfully ConnectionPool.create() acquired and are in active use.
int	getAllocatedSize() Measure the current number of allocated connections in the ConnectionPool, acquired or idle.
int	getIdleSize() Measure the current number of idle connections in the ConnectionPool.
int	getMaxAllocatedSize() Get the maximum number of live connections this ConnectionPool will allow.
int	getMaxPendingAcquireSize() Get the maximum number of ConnectionPool.create() this ConnectionPool can queue in a pending state when no available connection is immediately handy (and the ConnectionPool cannot allocate more connections).
int	getPendingAcquireSize() Measure the current number of "pending" ConnectionPool.create() acquire Monos in the ConnectionPool.

Field Detail

DOMAIN

static final String DOMAIN

See Also:

Constant Field Values

Method Detail

getAcquiredSize

int getAcquiredSize()

Measure the current number of connections that have been successfully ConnectionPool.create() acquired and are in active use.

Returns:

the number of acquired connections

See Also:

PoolMetrics.acquiredSize()

getAllocatedSize

int getAllocatedSize()

Measure the current number of allocated connections in the ConnectionPool, acquired or idle.

Returns:

the total number of allocated connections managed by the Pool

See Also:

PoolMetrics.allocatedSize()

getIdleSize

int getIdleSize()

Measure the current number of idle connections in the ConnectionPool.

Note that some connections might be lazily evicted when they're next considered for an incoming ConnectionPool.create() call. Such connections would still count towards this method.

Returns:

the number of idle connections

See Also:

PoolMetrics.idleSize()

getPendingAcquireSize

int getPendingAcquireSize()

Measure the current number of "pending" ConnectionPool.create() acquire Monos in the ConnectionPool.

An acquire is in the pending state when it is attempted at a point when no idle connections is available in the pool, and no new connection can be created.

Returns:

the number of pending acquire

See Also:

PoolMetrics.pendingAcquireSize()

getMaxAllocatedSize

int getMaxAllocatedSize()

Get the maximum number of live connections this ConnectionPool will allow.

A ConnectionPool might be unbounded, in which case this method returns Integer.MAX_VALUE.

Returns:

the maximum number of live connections that can be allocated by the ConnectionPool.

See Also:

PoolMetrics.getMaxAllocatedSize()

getMaxPendingAcquireSize

int getMaxPendingAcquireSize()

Get the maximum number of ConnectionPool.create() this ConnectionPool can queue in a pending state when no available connection is immediately handy (and the ConnectionPool cannot allocate more connections).

A ConnectionPool pending queue might be unbounded, in which case this method returns Integer.MAX_VALUE.

Returns:

the maximum number of pending acquire that can be enqueued by the ConnectionPool.

See Also:

PoolMetrics.getMaxPendingAcquireSize()