diff --git a/increase-java-core/src/main/kotlin/com/increase/api/core/http/PhantomReachableClosingHttpClient.kt b/increase-java-core/src/main/kotlin/com/increase/api/core/http/PhantomReachableClosingHttpClient.kt index f0e277451..4127b6b86 100644 --- a/increase-java-core/src/main/kotlin/com/increase/api/core/http/PhantomReachableClosingHttpClient.kt +++ b/increase-java-core/src/main/kotlin/com/increase/api/core/http/PhantomReachableClosingHttpClient.kt @@ -4,6 +4,11 @@ import com.increase.api.core.RequestOptions import com.increase.api.core.closeWhenPhantomReachable import java.util.concurrent.CompletableFuture +/** + * A delegating wrapper around an `HttpClient` that closes it once it's only phantom reachable. + * + * This class ensures the `HttpClient` is closed even if the user forgets to close it. + */ internal class PhantomReachableClosingHttpClient(private val httpClient: HttpClient) : HttpClient { init { closeWhenPhantomReachable(this, httpClient)