Add TCP Keep-Alive Probe Count Configuration (#5889)

* Add Tcp Keep Alive Probe Count Configuration

* Added change log

* Add Tcp Keep-Alive Probe Count Configuration

* Fixing coding style issues

Author: S-Saranya1

.changes/next-release/feature-AWSSDKforJavav2-f45a150.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS CRT HTTP Client",
+    "contributor": "",
+    "description": "Allow users to configure the number of TCP keep alive probes in the AWS CRT HTTP client through `keepAliveProbes`."
+}

http-clients/aws-crt-client/src/main/java/software/amazon/awssdk/http/crt/TcpKeepAliveConfiguration.java

@@ -28,12 +28,17 @@ public final class TcpKeepAliveConfiguration {
 
     private final Duration keepAliveInterval;
     private final Duration keepAliveTimeout;
+    private final Integer keepAliveProbes;
 
     private TcpKeepAliveConfiguration(DefaultTcpKeepAliveConfigurationBuilder builder) {
         this.keepAliveInterval = Validate.isPositive(builder.keepAliveInterval,
                                                      "keepAliveInterval");
         this.keepAliveTimeout = Validate.isPositive(builder.keepAliveTimeout,
                                                     "keepAliveTimeout");
+        this.keepAliveProbes = builder.keepAliveProbes == null
+                                        ? null
+                                        : Validate.isNotNegative(builder.keepAliveProbes,
+                                                                 "keepAliveProbes");
     }
 
     /**
@@ -50,6 +55,13 @@ public Duration keepAliveTimeout() {
         return keepAliveTimeout;
     }
 
+    /**
+     * @return number of keepalive probes allowed to fail before the connection is considered lost.
+     */
+    public Integer keepAliveProbes() {
+        return keepAliveProbes;
+    }
+
     public static Builder builder() {
         return new DefaultTcpKeepAliveConfigurationBuilder();
     }
@@ -74,13 +86,22 @@ public interface Builder {
          */
         Builder keepAliveTimeout(Duration keepAliveTimeout);
 
+        /**
+         * Sets the number of keepalive probes allowed to fail before the connection is considered lost.
+         * If not set or set to 0, OS default settings will be used for the probe count.
+         * @param keepAliveProbes Number of keepalive probes allowed to fail before the connection is considered lost.
+         * @return Builder
+         */
+        Builder keepAliveProbes(Integer keepAliveProbes);
+
         TcpKeepAliveConfiguration build();
     }
 
     /**
      * An SDK-internal implementation of {@link Builder}.
      */
     private static final class DefaultTcpKeepAliveConfigurationBuilder implements Builder {
+        private Integer keepAliveProbes;
         private Duration keepAliveInterval;
         private Duration keepAliveTimeout;
 
@@ -109,6 +130,12 @@ public Builder keepAliveTimeout(Duration keepAliveTimeout) {
             return this;
         }
 
+        @Override
+        public Builder keepAliveProbes(Integer keepAliveProbes) {
+            this.keepAliveProbes = keepAliveProbes;
+            return this;
+        }
+
         @Override
         public TcpKeepAliveConfiguration build() {
             return new TcpKeepAliveConfiguration(this);

http-clients/aws-crt-client/src/main/java/software/amazon/awssdk/http/crt/internal/AwsCrtConfigurationUtils.java

@@ -46,7 +46,9 @@ public static SocketOptions buildSocketOptions(TcpKeepAliveConfiguration tcpKeep
                 NumericUtils.saturatedCast(tcpKeepAliveConfiguration.keepAliveInterval().getSeconds());
             clientSocketOptions.keepAliveTimeoutSecs =
                 NumericUtils.saturatedCast(tcpKeepAliveConfiguration.keepAliveTimeout().getSeconds());
-
+            if (tcpKeepAliveConfiguration.keepAliveProbes() != null) {
+                clientSocketOptions.keepAliveMaxFailedProbes = tcpKeepAliveConfiguration.keepAliveProbes();
+            }
         }
 
         return clientSocketOptions;

http-clients/aws-crt-client/src/test/java/software/amazon/awssdk/http/crt/TcpKeepAliveConfigurationTest.java

@@ -29,10 +29,12 @@ public void builder_allPropertiesSet() {
             TcpKeepAliveConfiguration.builder()
                                      .keepAliveInterval(Duration.ofMinutes(1))
                                      .keepAliveTimeout(Duration.ofSeconds(1))
+                                     .keepAliveProbes(1)
                                      .build();
 
         assertThat(tcpKeepAliveConfiguration.keepAliveInterval()).isEqualTo(Duration.ofMinutes(1));
         assertThat(tcpKeepAliveConfiguration.keepAliveTimeout()).isEqualTo(Duration.ofSeconds(1));
+        assertThat(tcpKeepAliveConfiguration.keepAliveProbes()).isEqualTo(1);
     }
 
     @Test
@@ -52,7 +54,29 @@ public void builder_nullKeepAliveInterval_shouldThrowException() {
                                                         .build())
             .hasMessageContaining("keepAliveInterval");
     }
-    
+
+    @Test
+    public void builder_nullKeepAliveMaxFailedProbes_shouldBeAllowed() {
+        TcpKeepAliveConfiguration config = TcpKeepAliveConfiguration.builder()
+                                                                    .keepAliveInterval(Duration.ofMinutes(1))
+                                                                    .keepAliveTimeout(Duration.ofSeconds(1))
+                                                                    .build();
+
+        assertThat(config.keepAliveProbes()).isNull();
+    }
+
+    @Test
+    public void builder_zeroKeepAliveMaxFailedProbes_shouldBeAllowed() {
+        TcpKeepAliveConfiguration config = TcpKeepAliveConfiguration.builder()
+                                                                    .keepAliveInterval(Duration.ofMinutes(1))
+                                                                    .keepAliveTimeout(Duration.ofSeconds(1))
+                                                                    .keepAliveProbes(0)
+                                                                    .build();
+
+        assertThat(config.keepAliveProbes()).isEqualTo(0);
+    }
+
+
     @Test
     public void builder_nonPositiveKeepAliveTimeout_shouldThrowException() {
         assertThatThrownBy(() ->
@@ -72,4 +96,15 @@ public void builder_nonPositiveKeepAliveInterval_shouldThrowException() {
                                                         .build())
             .hasMessageContaining("keepAliveInterval");
     }
+
+    @Test
+    public void builder_nonPositiveKeepAliveMaxFailedProbes_shouldThrowException() {
+        assertThatThrownBy(() ->
+                               TcpKeepAliveConfiguration.builder()
+                                                        .keepAliveInterval(Duration.ofMinutes(1))
+                                                        .keepAliveTimeout(Duration.ofSeconds(1))
+                                                        .keepAliveProbes(-1)
+                                                        .build())
+            .hasMessageContaining("keepAliveProbes");
+    }
 }