commonMain.aws.smithy.kotlin.runtime.http.response.HttpCall.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-jvm Show documentation

HTTP core for Smithy clients and services generated by smithy-kotlin

There is a newer version: 1.3.31

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.http.response

import aws.smithy.kotlin.runtime.InternalApi
import aws.smithy.kotlin.runtime.http.HttpBody
import aws.smithy.kotlin.runtime.http.request.HttpRequest
import aws.smithy.kotlin.runtime.time.Instant
import kotlinx.coroutines.CompletableJob
import kotlinx.coroutines.Job
import kotlin.coroutines.CoroutineContext
import kotlin.coroutines.EmptyCoroutineContext

/**
 * A single request/response pair
 */
public data class HttpCall(
    /**
     * The original complete request
     */
    public val request: HttpRequest,

    /**
     * The [HttpResponse] for the given [request]
     */
    public val response: HttpResponse,

    /**
     * The time the request was made by the engine
     */
    public val requestTime: Instant,

    /**
     * The time the response was received. This is a rough estimate of Time-to-first-header (TTFH) as
     * reported by the engine.
     */
    public val responseTime: Instant,

    /**
     * The context associated with this call
     */
    public val callContext: CoroutineContext = EmptyCoroutineContext,
)

/**
 * Close the underlying response and cleanup any resources associated with it.
 * After closing the response body is no longer valid and should not be read from.
 *
 * This must be called when finished with the response!
 */
@InternalApi
public suspend fun HttpCall.complete() {
    val job = callContext[Job] as? CompletableJob ?: return

    try {
        // ensure the response is cancelled
        (response.body as? HttpBody.ChannelContent)?.readFrom()?.cancel(null)
    } catch (_: Throwable) {
    }

    job.complete()
    job.join()
}