From a5bdec0ad795505b94e3098ea6436bcf68b56deb Mon Sep 17 00:00:00 2001 From: oshai Date: Thu, 4 Jan 2018 16:43:18 +0200 Subject: [PATCH] fix documentation (#1055) --- .../java/com/zaxxer/hikari/HikariConfigMXBean.java | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/zaxxer/hikari/HikariConfigMXBean.java b/src/main/java/com/zaxxer/hikari/HikariConfigMXBean.java index 00fefc97..474152b3 100644 --- a/src/main/java/com/zaxxer/hikari/HikariConfigMXBean.java +++ b/src/main/java/com/zaxxer/hikari/HikariConfigMXBean.java @@ -112,12 +112,9 @@ public interface HikariConfigMXBean void setMaxLifetime(long maxLifetimeMs); /** - * The property controls the maximum size that the pool is allowed to reach, including both idle and in-use - * connections. Basically this value will determine the maximum number of actual connections to the database - * backend. - *

- * When the pool reaches this size, and no idle connections are available, calls to getConnection() will - * block for up to connectionTimeout milliseconds before timing out. + * The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, + * including both idle and in-use connections. If the idle connections dip below this value, HikariCP will + * make a best effort to restore them quickly and efficiently. * * @return the minimum number of connections in the pool */ @@ -177,4 +174,4 @@ public interface HikariConfigMXBean * @return the name of the connection pool */ String getPoolName(); -} \ No newline at end of file +}