Skip to content
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

Jump to bottom

Update documentation for ConnectionProvider.Builder#disposeInactivePoolsInBackground #2605

Merged
merged 1 commit into from Dec 8, 2022
Merged

Update documentation for ConnectionProvider.Builder#disposeInactivePoolsInBackground #2605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/asciidoc/http-client-conn-provider.adoc
View file
Open in desktop
Expand Up @@ -39,8 +39,8 @@ The following listing shows the available configurations:
|=======
| Configuration name | Description
| `disposeInactivePoolsInBackground` | When this option is enabled, connection pools are regularly checked in the background,
and those that are empty and been inactive for a specified time become eligible for disposal. By default, this background
disposal of inactive pools is disabled.
and those that are *empty* and been inactive for a specified time become eligible for disposal. Connection pool is considered
*empty* when there are no active connections, idle connections and pending acquisitions. By default, this background disposal of inactive pools is disabled.
| `disposeTimeout` | When `ConnectionProvider#dispose()` or `ConnectionProvider#disposeLater()` is called,
trigger a graceful shutdown for the connection pools, with this grace period timeout.
From there on, all calls for acquiring a connection will fail fast with an exception.
Expand Down
5 changes: 3 additions & 2 deletions reactor-netty-core/src/main/java/reactor/netty/resources/ConnectionProvider.java
View file
Open in desktop
Expand Up @@ -435,8 +435,9 @@ public final Builder name(String name) {

/**
* Set the options to use for configuring {@link ConnectionProvider} background disposal for inactive connection pools.
* When this option is enabled, the connection pools are regularly checked whether they are empty and inactive
* for a specified time, thus applicable for disposal.
* When this option is enabled, the connection pools are regularly checked whether they are <strong>empty</strong> and inactive
* for a specified time, thus applicable for disposal. Connection pool is considered
* <strong>empty</strong> when there are no active connections, idle connections and pending acquisitions.
* Default to {@link #DISPOSE_INACTIVE_POOLS_IN_BACKGROUND_DISABLED} - the background disposal is disabled.
* Providing a {@code disposeInterval} of {@link Duration#ZERO zero} means the background disposal is disabled.
*
Expand Down