Skip to content

Update documentation for FUTURE_COMPLETION_EXECUTOR #4950

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 21, 2024
Merged

Update documentation for FUTURE_COMPLETION_EXECUTOR #4950

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a876b7d
Update documentation for FUTURE_COMPLETION_EXECUTOR
zoewangg Feb 20, 2024
8667546
Address feedback
zoewangg Feb 20, 2024
d67bb9b
Address feedback
zoewangg Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions ...src/main/java/software/amazon/awssdk/core/client/config/SdkAdvancedAsyncClientOption.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,12 @@ public final class SdkAdvancedAsyncClientOption<T> extends ClientOption<T> {
* <li>You want more fine-grained control over the {@link ThreadPoolExecutor} used, such as configuring the pool size
* or sharing a single pool between multiple clients.
* <li>You want to add instrumentation (i.e., metrics) around how the {@link Executor} is used.
* <li>You know, for certain, that all of your {@link CompletableFuture} usage is strictly non-blocking, and you wish to
* remove the minor overhead incurred by using a separate thread. In this case, you can use
* {@code Runnable::run} to execute the future-completion directly from within the I/O thread.
* </ol>
* <b>Note</b>
* <p>
* We strongly recommend <strong>against</strong> using {@code Runnable::run}, which executes the future-completion directly from
* within the I/O thread because it may block the IO thread and cause deadlock, especially if you are sending
* another SDK request in the {@link CompletableFuture} chain since the SDK may perform blocking calls in some cases.
*/
public static final SdkAdvancedAsyncClientOption<Executor> FUTURE_COMPLETION_EXECUTOR =
new SdkAdvancedAsyncClientOption<>(Executor.class);
Expand Down