-
Notifications
You must be signed in to change notification settings - Fork 864
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the ability to configure connection timeout, keep-alive settings,…
… and advanced SocketOptions on the AwsCrtAsyncHttpClient. This is necessary for any clients with long-running connections that exceed default socket timeouts of services along the call path, and need to enable keep-alive settings which the CRT client supports, but the Java client wasn't exposing to callers
- Loading branch information
Showing
5 changed files
with
322 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "type": "feature", | ||
| "category": "AWS SDK for Java v2", | ||
| "contributor": "nikp", | ||
| "description": "Add the ability to configure connection timeout, keep-alive settings, and other advanced SocketOptions on the AwsCrtAsyncHttpClient to support long-running connections" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
...s-crt-client/src/main/java/software/amazon/awssdk/http/crt/TcpKeepAliveConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.awssdk.http.crt; | ||
|
|
||
| import java.time.Duration; | ||
| import software.amazon.awssdk.annotations.SdkPreviewApi; | ||
| import software.amazon.awssdk.annotations.SdkPublicApi; | ||
| import software.amazon.awssdk.utils.Validate; | ||
|
|
||
| /** | ||
| * Configuration that defines keep-alive options for all connections established by | ||
| * the {@link TcpKeepAliveConfiguration}. | ||
| * | ||
| * <b>NOTE:</b> This is a Preview API and is subject to change so it should not be used in production. | ||
| */ | ||
| @SdkPublicApi | ||
| @SdkPreviewApi | ||
| public final class TcpKeepAliveConfiguration { | ||
|
|
||
| private final Duration keepAliveInterval; | ||
| private final Duration keepAliveTimeout; | ||
|
|
||
| private TcpKeepAliveConfiguration(DefaultTcpKeepAliveConfigurationBuilder builder) { | ||
| this.keepAliveInterval = Validate.isPositive(builder.keepAliveInterval, | ||
| "keepAliveInterval"); | ||
| this.keepAliveTimeout = Validate.isPositive(builder.keepAliveTimeout, | ||
| "keepAliveTimeout"); | ||
| } | ||
|
|
||
| /** | ||
| * @return number of seconds between TCP keepalive packets being sent to the peer | ||
| */ | ||
| public Duration keepAliveInterval() { | ||
| return keepAliveInterval; | ||
| } | ||
|
|
||
| /** | ||
| * @return number of seconds to wait for a keepalive response before considering the connection timed out | ||
| */ | ||
| public Duration keepAliveTimeout() { | ||
| return keepAliveTimeout; | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new DefaultTcpKeepAliveConfigurationBuilder(); | ||
| } | ||
|
|
||
| /** | ||
| * A builder for {@link TcpKeepAliveConfiguration}. | ||
| * | ||
| * <p>All implementations of this interface are mutable and not thread safe.</p> | ||
| */ | ||
| public interface Builder { | ||
| /** | ||
| * Sets the Duration between TCP keepalive packets being sent to the peer | ||
| * @param keepAliveInterval Duration between TCP keepalive packets being sent to the peer | ||
| * @return Builder | ||
| */ | ||
| Builder keepAliveInterval(Duration keepAliveInterval); | ||
|
|
||
| /** | ||
| * Sets the Duration to wait for a keepalive response before considering the connection timed out | ||
| * @param keepAliveTimeout Duration to wait for a keepalive response before considering the connection timed out | ||
| * @return Builder | ||
| */ | ||
| Builder keepAliveTimeout(Duration keepAliveTimeout); | ||
|
|
||
| TcpKeepAliveConfiguration build(); | ||
| } | ||
|
|
||
| /** | ||
| * An SDK-internal implementation of {@link Builder}. | ||
| */ | ||
| private static final class DefaultTcpKeepAliveConfigurationBuilder implements Builder { | ||
| private Duration keepAliveInterval; | ||
| private Duration keepAliveTimeout; | ||
|
|
||
| private DefaultTcpKeepAliveConfigurationBuilder() { | ||
| } | ||
|
|
||
| /** | ||
| * Sets the Duration between TCP keepalive packets being sent to the peer | ||
| * @param keepAliveInterval Duration between TCP keepalive packets being sent to the peer | ||
| * @return Builder | ||
| */ | ||
| @Override | ||
| public Builder keepAliveInterval(Duration keepAliveInterval) { | ||
| this.keepAliveInterval = keepAliveInterval; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the Duration to wait for a keepalive response before considering the connection timed out | ||
| * @param keepAliveTimeout Duration to wait for a keepalive response before considering the connection timed out | ||
| * @return Builder | ||
| */ | ||
| @Override | ||
| public Builder keepAliveTimeout(Duration keepAliveTimeout) { | ||
| this.keepAliveTimeout = keepAliveTimeout; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public TcpKeepAliveConfiguration build() { | ||
| return new TcpKeepAliveConfiguration(this); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.