commonMain.aws.smithy.kotlin.runtime.http.engine.DefaultHttpEngine.kt Maven / Gradle / Ivy

Go to download

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

Default HTTP Client Engine for Smithy services generated by smithy-kotlin

The newest version!

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

package aws.smithy.kotlin.runtime.http.engine

import aws.smithy.kotlin.runtime.http.config.EngineFactory

/**
 * Specifies the platform-default HTTP engine. Different platforms (e.g., Java) will use different implementations
 * (e.g., OkHttp).
 */
public object DefaultHttpEngine : EngineFactory {
    override val engineConstructor: (HttpClientEngineConfig.Builder.() -> Unit) -> HttpClientEngine =
        ::DefaultHttpEngine
}

/**
 * Factory function to create a new HTTP client engine using the default for the current KMP target
 */
@Suppress("ktlint:standard:function-naming")
public fun DefaultHttpEngine(block: (HttpClientEngineConfig.Builder.() -> Unit)? = null): CloseableHttpClientEngine =
    newDefaultHttpEngine(block)

internal expect fun newDefaultHttpEngine(block: (HttpClientEngineConfig.Builder.() -> Unit)?): CloseableHttpClientEngine