1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 package software.amazon.awssdk.http.nio.netty.internal;
17 
18 import io.netty.channel.pool.ChannelPool;
19 import java.util.concurrent.CompletableFuture;
20 import software.amazon.awssdk.annotations.SdkInternalApi;
21 import software.amazon.awssdk.metrics.MetricCollector;
22 
23 /**
24  * A {@link ChannelPool} implementation that allows a caller to asynchronously retrieve channel-pool related metrics via
25  * {@link #collectChannelPoolMetrics(MetricCollector)}.
26  */
27 @SdkInternalApi
28 public interface SdkChannelPool extends ChannelPool {
29     /**
30      * Collect channel pool metrics into the provided {@link MetricCollector} collection, completing the returned future when
31      * all metric publishing is complete.
32      *
33      * @param metrics The collection to which all metrics should be added.
34      * @return A future that is completed when all metric publishing is complete.
35      */
collectChannelPoolMetrics(MetricCollector metrics)36     CompletableFuture<Void> collectChannelPoolMetrics(MetricCollector metrics);
37 }
38