Top Description Fields Methods
io.r2dbc.pool

public Interface ConnectionPoolMXBean

Known Direct Implementers
io.r2dbc.pool.ConnectionPool.ConnectionPoolMXBeanImpl
Imports
reactor.pool.Pool

MBean for ConnectionPool.

Expose PoolMetrics values to JMX.

Author
Tadaya Tsuyukubo
See Also
PoolMetrics

Field Summary

Modifier and TypeField and Description
public static final String

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the number of acquired connections
getAcquiredSize
()

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

public int

Returns:

the total number of allocated connections managed by the Pool
getAllocatedSize
()

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

public int

Returns:

the number of idle connections
getIdleSize
()

Measure the current number of idle connections in the ConnectionPool.

public int

Returns:

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

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

public int

Returns:

the maximum number of pending acquire that can be enqueued by the ConnectionPool.
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).

public int

Returns:

the number of pending acquire
getPendingAcquireSize
()

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

Field Detail

DOMAINback to summary
public static final String DOMAIN

Method Detail

getAcquiredSizeback to summary
public int getAcquiredSize()

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

Returns:int

the number of acquired connections

See Also
PoolMetrics#acquiredSize()
getAllocatedSizeback to summary
public int getAllocatedSize()

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

Returns:int

the total number of allocated connections managed by the Pool

See Also
PoolMetrics#allocatedSize()
getIdleSizeback to summary
public 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:int

the number of idle connections

See Also
PoolMetrics#idleSize()
getMaxAllocatedSizeback to summary
public 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:int

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

See Also
PoolMetrics#getMaxAllocatedSize()
getMaxPendingAcquireSizeback to summary
public 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:int

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

See Also
PoolMetrics#getMaxPendingAcquireSize()
getPendingAcquireSizeback to summary
public 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:int

the number of pending acquire

See Also
PoolMetrics#pendingAcquireSize()