Introduce connectionPoolCleanerPeriod so that idle connections are not closed all at once, close AsyncHttpClient#1205

Author: slandelle

client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java

@@ -70,6 +70,11 @@ public interface AsyncHttpClientConfig {
      */
     int getPooledConnectionIdleTimeout();
 
+    /**
+     * @return the period in millis to clean the pool of dead and idle connections.
+     */
+    int getConnectionPoolCleanerPeriod();
+
     /**
      * Return the maximum time in millisecond an {@link AsyncHttpClient} waits until the response is completed.
      *

client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java

@@ -85,6 +85,7 @@ public class DefaultAsyncHttpClientConfig implements AsyncHttpClientConfig {
     // keep-alive
     private final boolean keepAlive;
     private final int pooledConnectionIdleTimeout;
+    private final int connectionPoolCleanerPeriod;
     private final int connectionTtl;
     private final int maxConnections;
     private final int maxConnectionsPerHost;
@@ -155,6 +156,7 @@ private DefaultAsyncHttpClientConfig(//
             // keep-alive
             boolean keepAlive,//
             int pooledConnectionIdleTimeout,//
+            int connectionPoolCleanerPeriod,//
             int connectionTtl,//
             int maxConnections,//
             int maxConnectionsPerHost,//
@@ -226,6 +228,7 @@ private DefaultAsyncHttpClientConfig(//
         // keep-alive
         this.keepAlive = keepAlive;
         this.pooledConnectionIdleTimeout = pooledConnectionIdleTimeout;
+        this.connectionPoolCleanerPeriod = connectionPoolCleanerPeriod;
         this.connectionTtl = connectionTtl;
         this.maxConnections = maxConnections;
         this.maxConnectionsPerHost = maxConnectionsPerHost;
@@ -373,6 +376,11 @@ public int getPooledConnectionIdleTimeout() {
         return pooledConnectionIdleTimeout;
     }
 
+    @Override
+    public int getConnectionPoolCleanerPeriod() {
+        return connectionPoolCleanerPeriod;
+    }
+
     @Override
     public int getConnectionTtl() {
         return connectionTtl;
@@ -603,6 +611,7 @@ public static class Builder {
         // keep-alive
         private boolean keepAlive = defaultKeepAlive();
         private int pooledConnectionIdleTimeout = defaultPooledConnectionIdleTimeout();
+        private int connectionPoolCleanerPeriod = defaultConnectionPoolCleanerPeriod();
         private int connectionTtl = defaultConnectionTtl();
         private int maxConnections = defaultMaxConnections();
         private int maxConnectionsPerHost = defaultMaxConnectionsPerHost();
@@ -1092,6 +1101,7 @@ public DefaultAsyncHttpClientConfig build() {
                     shutdownTimeout, //
                     keepAlive, //
                     pooledConnectionIdleTimeout, //
+                    connectionPoolCleanerPeriod, //
                     connectionTtl, //
                     maxConnections, //
                     maxConnectionsPerHost, //

client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java

@@ -39,6 +39,10 @@ public static int defaultPooledConnectionIdleTimeout() {
         return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + "pooledConnectionIdleTimeout");
     }
 
+    public static int defaultConnectionPoolCleanerPeriod() {
+        return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + "connectionPoolCleanerPeriod");
+    }
+
     public static int defaultReadTimeout() {
         return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + "readTimeout");
     }

client/src/main/java/org/asynchttpclient/netty/channel/DefaultChannelPool.java

@@ -54,7 +54,8 @@ public final class DefaultChannelPool implements ChannelPool {
     public DefaultChannelPool(AsyncHttpClientConfig config, Timer hashedWheelTimer) {
         this(config.getPooledConnectionIdleTimeout(),//
                 config.getConnectionTtl(),//
-                hashedWheelTimer);
+                hashedWheelTimer,//
+                config.getConnectionPoolCleanerPeriod());
     }
 
     private ChannelId channelId(Channel channel) {
@@ -63,17 +64,20 @@ private ChannelId channelId(Channel channel) {
 
     public DefaultChannelPool(int maxIdleTime,//
             int connectionTtl,//
-            Timer nettyTimer) {
+            Timer nettyTimer,//
+            int cleanerPeriod) {
         this(maxIdleTime,//
                 connectionTtl,//
                 PoolLeaseStrategy.LIFO,//
-                nettyTimer);
+                nettyTimer,//
+                cleanerPeriod);
     }
 
     public DefaultChannelPool(int maxIdleTime,//
             int connectionTtl,//
             PoolLeaseStrategy poolLeaseStrategy,//
-            Timer nettyTimer) {
+            Timer nettyTimer,//
+            int cleanerPeriod) {
         this.maxIdleTime = (int) maxIdleTime;
         this.connectionTtl = connectionTtl;
         connectionTtlEnabled = connectionTtl > 0;
@@ -82,7 +86,7 @@ public DefaultChannelPool(int maxIdleTime,//
         maxIdleTimeEnabled = maxIdleTime > 0;
         this.poolLeaseStrategy = poolLeaseStrategy;
 
-        cleanerPeriod = Math.min(connectionTtlEnabled ? connectionTtl : Integer.MAX_VALUE, maxIdleTimeEnabled ? maxIdleTime : Long.MAX_VALUE);
+        this.cleanerPeriod = Math.min(cleanerPeriod, Math.min(connectionTtlEnabled ? connectionTtl : Integer.MAX_VALUE, maxIdleTimeEnabled ? maxIdleTime : Integer.MAX_VALUE));
 
         if (connectionTtlEnabled || maxIdleTimeEnabled)
             scheduleNewIdleChannelDetector(new IdleChannelDetector());
@@ -153,7 +157,7 @@ private List<IdleChannel> expiredChannels(ConcurrentLinkedDeque<IdleChannel> par
                 if (isIdleTimeoutExpired(idleChannel, now) || isRemotelyClosed(idleChannel.channel) || isTtlExpired(idleChannel.channel, now)) {
                     LOGGER.debug("Adding Candidate expired Channel {}", idleChannel.channel);
                     if (idleTimeoutChannels == null)
-                        idleTimeoutChannels = new ArrayList<>();
+                        idleTimeoutChannels = new ArrayList<>(1);
                     idleTimeoutChannels.add(idleChannel);
                 }
             }
@@ -163,7 +167,7 @@ private List<IdleChannel> expiredChannels(ConcurrentLinkedDeque<IdleChannel> par
 
         private final List<IdleChannel> closeChannels(List<IdleChannel> candidates) {
 
-            // lazy create, only if we have a non-closeable channel
+            // lazy create, only if we hit a non-closeable channel
             List<IdleChannel> closedChannels = null;
             for (int i = 0; i < candidates.size(); i++) {
                 // We call takeOwnership here to avoid closing a channel that has just been taken out

client/src/main/resources/ahc-default.properties

@@ -3,6 +3,7 @@ org.asynchttpclient.maxConnections=-1
 org.asynchttpclient.maxConnectionsPerHost=-1
 org.asynchttpclient.connectTimeout=5000
 org.asynchttpclient.pooledConnectionIdleTimeout=60000
+org.asynchttpclient.connectionPoolCleanerPeriod=1000
 org.asynchttpclient.readTimeout=60000
 org.asynchttpclient.requestTimeout=60000
 org.asynchttpclient.connectionTtl=-1