Class HealthCheckedChannelPool

java.lang.Object

software.amazon.awssdk.http.nio.netty.internal.HealthCheckedChannelPool

All Implemented Interfaces:

io.netty.channel.pool.ChannelPool, Closeable, AutoCloseable, SdkChannelPool

@SdkInternalApi
public class HealthCheckedChannelPool
extends Object
implements SdkChannelPool

An implementation of ChannelPool that validates the health of its connections. This wraps another ChannelPool, and verifies:

1. All connections acquired from the underlying channel pool are in the active state.
2. All connections released into the underlying pool that are not active, are closed before they are released.

Acquisitions that fail due to an unhealthy underlying channel are retried until a healthy channel can be returned, or the NettyConfiguration.connectionAcquireTimeoutMillis() timeout is reached.

Constructor Summary

Constructors

Constructor	Description
HealthCheckedChannelPool(io.netty.channel.EventLoopGroup eventLoopGroup, NettyConfiguration configuration, SdkChannelPool delegate)

Method Summary

Modifier and Type	Method	Description
io.netty.util.concurrent.Future<io.netty.channel.Channel>	acquire()
io.netty.util.concurrent.Future<io.netty.channel.Channel>	acquire(io.netty.util.concurrent.Promise<io.netty.channel.Channel> resultFuture)
void	close()
CompletableFuture<Void>	collectChannelPoolMetrics(MetricCollector metrics)	Collect channel pool metrics into the provided MetricCollector collection, completing the returned future when all metric publishing is complete.
io.netty.util.concurrent.Future<Void>	release(io.netty.channel.Channel channel)
io.netty.util.concurrent.Future<Void>	release(io.netty.channel.Channel channel, io.netty.util.concurrent.Promise<Void> promise)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HealthCheckedChannelPool

public HealthCheckedChannelPool(io.netty.channel.EventLoopGroup eventLoopGroup,
 NettyConfiguration configuration,
 SdkChannelPool delegate)

Method Details

acquire

public io.netty.util.concurrent.Future<io.netty.channel.Channel> acquire()

Specified by:

acquire in interface io.netty.channel.pool.ChannelPool

acquire

public io.netty.util.concurrent.Future<io.netty.channel.Channel> acquire(io.netty.util.concurrent.Promise<io.netty.channel.Channel> resultFuture)

Specified by:

acquire in interface io.netty.channel.pool.ChannelPool

release

public io.netty.util.concurrent.Future<Void> release(io.netty.channel.Channel channel)

Specified by:

release in interface io.netty.channel.pool.ChannelPool

release

public io.netty.util.concurrent.Future<Void> release(io.netty.channel.Channel channel,
 io.netty.util.concurrent.Promise<Void> promise)

Specified by:

release in interface io.netty.channel.pool.ChannelPool

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface io.netty.channel.pool.ChannelPool

Specified by:

close in interface Closeable

collectChannelPoolMetrics

public CompletableFuture<Void> collectChannelPoolMetrics(MetricCollector metrics)

Description copied from interface: SdkChannelPool

Collect channel pool metrics into the provided MetricCollector collection, completing the returned future when all metric publishing is complete.

Specified by:

collectChannelPoolMetrics in interface SdkChannelPool

Parameters:

metrics - The collection to which all metrics should be added.

Returns:

A future that is completed when all metric publishing is complete.