Skip to content

Commit a60d8e5

Browse files
committed
AbstractIOSessionPool: improved available sessions enumeration; improved session validation; added method to evict expired sessions
1 parent 4ca20a4 commit a60d8e5

4 files changed

Lines changed: 207 additions & 44 deletions

File tree

‎httpcore5-h2/src/main/java/org/apache/hc/core5/http2/nio/pool/H2ConnPool.java‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,14 @@ public void completed(final TransportSecurityLayer transportSecurityLayer) {
151151

152152
@Override
153153
protected void validateSession(
154+
final HttpHost namedEndpoint,
154155
final IOSession ioSession,
155156
final Callback<Boolean> callback) {
156157
if (ioSession.isOpen()) {
157158
final TimeValue inactivityTime = validateAfterInactivity;
158159
if (TimeValue.isNonNegative(inactivityTime)) {
159160
// Last tolerable point of inactivity
160-
final long deadline = inactivityDeadline(inactivityTime);
161+
final long deadline = clockMillis() - inactivityTime.toMilliseconds();
161162
if (ioSession.getLastEventTime() <= deadline) {
162163
ioSession.enqueue(new StaleCheckCommand(callback::execute), Command.Priority.NORMAL);
163164
return;
@@ -178,15 +179,4 @@ protected boolean isIdle(final IOSession session) {
178179
return false;
179180
}
180181

181-
/**
182-
* Evict expired (closed) sessions.
183-
* @since 5.5
184-
*/
185-
public void evictExpired() {
186-
// This will cause closed sessions to get removed from the pool
187-
enumAvailable(e -> {
188-
// no op
189-
});
190-
}
191-
192182
}

‎httpcore5-h2/src/test/java/org/apache/hc/core5/http2/nio/pool/TestH2ConnPool.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,13 @@ void testCloseSessionImmediateCloses() {
7878
@Test
7979
void testValidateSessionClosed() {
8080
final ConnectionInitiator connectionInitiator = Mockito.mock(ConnectionInitiator.class);
81+
final HttpHost host = new HttpHost(URIScheme.HTTP.id, "localhost", 7443);
8182
try (H2ConnPool pool = new H2ConnPool(connectionInitiator, null, null)) {
8283
final IOSession session = Mockito.mock(IOSession.class);
8384
Mockito.when(session.isOpen()).thenReturn(false);
8485

8586
final AtomicReference<Boolean> result = new AtomicReference<>();
86-
pool.validateSession(session, result::set);
87+
pool.validateSession(host, session, result::set);
8788

8889
Assertions.assertEquals(Boolean.FALSE, result.get());
8990
}
@@ -92,6 +93,7 @@ void testValidateSessionClosed() {
9293
@Test
9394
void testValidateSessionEnqueuesStaleCheck() {
9495
final ConnectionInitiator connectionInitiator = Mockito.mock(ConnectionInitiator.class);
96+
final HttpHost host = new HttpHost(URIScheme.HTTP.id, "localhost", 7443);
9597
try (H2ConnPool pool = new H2ConnPool(connectionInitiator, null, null)) {
9698
pool.setValidateAfterInactivity(TimeValue.ZERO_MILLISECONDS);
9799

@@ -102,7 +104,7 @@ void testValidateSessionEnqueuesStaleCheck() {
102104

103105
@SuppressWarnings("unchecked")
104106
final Callback<Boolean> callback = (Callback<Boolean>) Mockito.mock(Callback.class);
105-
pool.validateSession(session, callback);
107+
pool.validateSession(host, session, callback);
106108

107109
Mockito.verify(session).enqueue(Mockito.any(StaleCheckCommand.class), Mockito.eq(Command.Priority.NORMAL));
108110
Mockito.verifyNoInteractions(callback);

‎httpcore5/src/main/java/org/apache/hc/core5/reactor/AbstractIOSessionPool.java‎

Lines changed: 87 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,16 @@
2929
import java.time.Clock;
3030
import java.util.ArrayDeque;
3131
import java.util.HashSet;
32+
import java.util.Iterator;
33+
import java.util.Map;
3234
import java.util.Queue;
3335
import java.util.Set;
3436
import java.util.concurrent.ConcurrentHashMap;
3537
import java.util.concurrent.ConcurrentMap;
3638
import java.util.concurrent.Future;
3739
import java.util.concurrent.atomic.AtomicBoolean;
3840
import java.util.concurrent.locks.ReentrantLock;
41+
import java.util.function.BiConsumer;
3942

4043
import org.apache.hc.core5.annotation.Contract;
4144
import org.apache.hc.core5.annotation.ThreadingBehavior;
@@ -80,14 +83,38 @@ protected abstract Future<IOSession> connectSession(
8083
Timeout connectTimeout,
8184
FutureCallback<IOSession> callback);
8285

83-
protected abstract void validateSession(
84-
IOSession ioSession,
85-
Callback<Boolean> callback);
86+
/**
87+
* @deprecated Use {@link #validateSession(Object, IOSession, Callback)}.
88+
*/
89+
@Deprecated
90+
protected void validateSession(
91+
final IOSession ioSession,
92+
final Callback<Boolean> callback) {
93+
callback.execute(Boolean.TRUE);
94+
}
95+
96+
/**
97+
* @since 5.5
98+
*/
99+
@SuppressWarnings("deprecation")
100+
protected void validateSession(
101+
final T endpoint,
102+
final IOSession ioSession,
103+
final Callback<Boolean> callback) {
104+
validateSession(ioSession, callback);
105+
}
86106

87107
protected abstract void closeSession(
88108
IOSession ioSession,
89109
CloseMode closeMode);
90110

111+
/**
112+
* @since 5.5
113+
*/
114+
protected long clockMillis() {
115+
return clock.millis();
116+
}
117+
91118
/**
92119
* Tests if the given session is idle. This method is expected to be communication protocol
93120
* aware.
@@ -98,6 +125,16 @@ protected boolean isIdle(final IOSession session) {
98125
return false;
99126
}
100127

128+
/**
129+
* Tests if the given session has expired. This method is expected to be communication protocol
130+
* aware.
131+
*
132+
* @since 5.5
133+
*/
134+
protected boolean isExpired(final T endpoint, final IOSession session) {
135+
return false;
136+
}
137+
101138
@Override
102139
public final void close(final CloseMode closeMode) {
103140
if (closed.compareAndSet(false, true)) {
@@ -157,14 +194,19 @@ public final Future<IOSession> getSession(
157194

158195
@Override
159196
public void completed(final IOSession ioSession) {
160-
validateSession(ioSession, result -> {
161-
if (result) {
162-
future.completed(ioSession);
163-
} else {
164-
getSessionInternal(poolEntry, true, endpoint, connectTimeout,
197+
if (isIdle(ioSession) && isExpired(endpoint, ioSession)) {
198+
getSessionInternal(poolEntry, true, endpoint, connectTimeout,
165199
new CompletingFutureContribution<>(future));
166-
}
167-
});
200+
} else {
201+
validateSession(endpoint, ioSession, result -> {
202+
if (result) {
203+
future.completed(ioSession);
204+
} else {
205+
getSessionInternal(poolEntry, true, endpoint, connectTimeout,
206+
new CompletingFutureContribution<>(future));
207+
}
208+
});
209+
}
168210
}
169211

170212
@Override
@@ -265,13 +307,31 @@ public void cancelled() {
265307
}
266308
}
267309

310+
/**
311+
* @deprecated Use {@link #enumAvailable(BiConsumer)}.
312+
*/
313+
@Deprecated
268314
public final void enumAvailable(final Callback<IOSession> callback) {
269-
for (final PoolEntry poolEntry: sessionPool.values()) {
315+
Args.notNull(callback, "Callback");
316+
enumAvailable((endpoint, session) -> callback.execute(session));
317+
}
318+
319+
/**
320+
* @since 5.5
321+
*/
322+
public final void enumAvailable(final BiConsumer<T, IOSession> consumer) {
323+
Args.notNull(consumer, "consumer");
324+
for (final Iterator<Map.Entry<T, PoolEntry>> it = sessionPool.entrySet().iterator(); it.hasNext(); ) {
325+
final Map.Entry<T, PoolEntry> entry = it.next();
326+
final PoolEntry poolEntry = entry.getValue();
270327
if (poolEntry.session != null) {
271328
poolEntry.lock.lock();
272329
try {
273330
if (poolEntry.session != null) {
274-
callback.execute(poolEntry.session);
331+
if (poolEntry.session.isOpen()) {
332+
final T endpoint = entry.getKey();
333+
consumer.accept(endpoint, poolEntry.session);
334+
}
275335
if (!poolEntry.session.isOpen()) {
276336
poolEntry.session = null;
277337
}
@@ -283,25 +343,32 @@ public final void enumAvailable(final Callback<IOSession> callback) {
283343
}
284344
}
285345

286-
protected long inactivityDeadline(final TimeValue inactivityTime) {
287-
return this.clock.millis() - (TimeValue.isPositive(inactivityTime) ? inactivityTime.toMilliseconds() : 0);
288-
}
289-
290346
/**
291347
* Close sessions idle longer than the given period of inactivity. This method will also
292348
* Evict closed sessions.
293349
*/
294350
public final void closeIdle(final TimeValue inactivityTime) {
295-
// Last tolerable point of inactivity
296-
// Millisecond precision is good enough
297-
final long deadline = inactivityDeadline(inactivityTime);
298-
enumAvailable(session -> {
351+
final long deadline = clockMillis() - (TimeValue.isPositive(inactivityTime) ? inactivityTime.toMilliseconds() : 0);
352+
enumAvailable((endpoint, session) -> {
299353
if (isIdle(session) && session.getLastEventTime() <= deadline) {
300354
closeSession(session, CloseMode.GRACEFUL);
301355
}
302356
});
303357
}
304358

359+
/**
360+
* Evict expired (closed) sessions.
361+
* @since 5.5
362+
*/
363+
public final void evictExpired() {
364+
// This method also causes closed sessions to get removed from the pool
365+
enumAvailable((endpoint, session) -> {
366+
if (isIdle(session) && isExpired(endpoint, session)) {
367+
closeSession(session, CloseMode.GRACEFUL);
368+
}
369+
});
370+
}
371+
305372
public final Set<T> getRoutes() {
306373
return new HashSet<>(sessionPool.keySet());
307374
}

0 commit comments

Comments
 (0)