io.r2dbc.pool

Class ConnectionPool

java.lang.Object

io.r2dbc.pool.ConnectionPool

All Implemented Interfaces:

Closeable, ConnectionFactory, Wrapped<ConnectionFactory>, Disposable

public class ConnectionPool
extends Object
implements ConnectionFactory, Disposable, Closeable, Wrapped<ConnectionFactory>

Reactive Relational Database Connection Pool implementation.

Author:

Mark Paluch, Tadaya Tsuyukubo, Petromir Dzhunev, Gabriel Calin

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Constructor Summary

Constructors

Constructor and Description
ConnectionPool(ConnectionPoolConfiguration configuration) Creates a new connection factory.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	close()
Mono<Connection>	create()
void	dispose()
Mono<Void>	disposeLater() Dispose this ConnectionPool in non-blocking flow.
ConnectionFactoryMetadata	getMetadata()
Optional<PoolMetrics>	getMetrics() Returns PoolMetrics if available.
protected ObjectName	getPoolObjectName(String name) Construct JMX ObjectName.
boolean	isDisposed()
String	toString()
ConnectionFactory	unwrap()
Mono<Integer>	warmup() Warms up the ConnectionPool, if needed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.r2dbc.spi.Wrapped

unwrap

Constructor Detail

ConnectionPool

public ConnectionPool(ConnectionPoolConfiguration configuration)

Creates a new connection factory.

Parameters:

configuration - the configuration to use for building the connection pool.

Throws:

IllegalArgumentException - if configuration is null

Method Detail

warmup

public Mono<Integer> warmup()

Warms up the ConnectionPool, if needed. This instructs the pool to check for a minimum size and allocate necessary connections when the minimum is not reached.

Returns:

a cold Mono that triggers resource warmup and emits the number of warmed up resources.

create

public Mono<Connection> create()

Specified by:

create in interface ConnectionFactory

close

public Mono<Void> close()

Specified by:

close in interface Closeable

dispose

public void dispose()

Specified by:

dispose in interface Disposable

disposeLater

public Mono<Void> disposeLater()

Dispose this ConnectionPool in non-blocking flow.

When multiple errors occurred during dispose flow, they are added as suppressed errors onto the first error.

Returns:

a Mono triggering the shutdown of the pool once subscribed.

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Disposable

getMetadata

public ConnectionFactoryMetadata getMetadata()

Specified by:

getMetadata in interface ConnectionFactory

unwrap

public ConnectionFactory unwrap()

Specified by:

unwrap in interface Wrapped<ConnectionFactory>

toString

public String toString()

Overrides:

toString in class Object

getMetrics

public Optional<PoolMetrics> getMetrics()

Returns PoolMetrics if available.

Returns:

the optional pool metrics.

getPoolObjectName

protected ObjectName getPoolObjectName(String name)
                                throws MalformedObjectNameException

Construct JMX ObjectName.

Parameters:

name - connection pool name

Returns:

JMX ObjectName

Throws:

MalformedObjectNameException - when invalid objectname is constructed