Add some javadoc around the shutdown pooling code (#5885)

palantir · Feb 3, 2022 · fd9a0ea · fd9a0ea
1 parent b41ae50
commit fd9a0ea
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...assandra/src/main/java/com/palantir/atlasdb/keyvalue/cassandra/pool/CassandraService.java b/...assandra/src/main/java/com/palantir/atlasdb/keyvalue/cassandra/pool/CassandraService.java
@@ -397,6 +397,11 @@ public void addPool(InetSocketAddress server) {
                 new CassandraClientPoolingContainer(metricsManager, server, config, currentPoolNumber, poolMetrics));
     }
 
+    /**
+     * Removes the pool from the set of current pools. Note that this shuts down all idle connections, but active ones
+     * remain alive until they are returned to the pool, whereby they are destroyed immediately. Threads waiting on the
+     * pool will be interrupted.
+     */
     public void removePool(InetSocketAddress removedServerAddress) {
         blacklist.remove(removedServerAddress);
         CassandraClientPoolingContainer removedContainer = currentPools.remove(removedServerAddress);