ktor-client-core/io.ktor.client.engine/HttpClientEngine

HttpClientEngine

interface HttpClientEngine : CoroutineScope, Closeable

Serves as the base interface for an HttpClient's engine.

Inheritors

HttpClientEngineBase

Properties

abstract val config: HttpClientEngineConfig

Provides access to an engine's configuration.

coroutineContext

abstract val coroutineContext: CoroutineContext

abstract val dispatcher: CoroutineDispatcher

Specifies CoroutineDispatcher for I/O operations.

supportedCapabilities

open val supportedCapabilities: Set<HttpClientEngineCapability<*>>

Set of supported engine extensions.

Functions

expect abstract fun close()

abstract suspend fun execute(data: HttpRequestData): HttpResponseData

Creates a new HttpClientCall specific for this engine, using a request data.

open fun install(client: HttpClient)

Installs the engine to HttpClient.

mapEngineExceptions

fun CoroutineScope.mapEngineExceptions(input: ByteReadChannel, request: HttpRequestData): ByteReadChannel

Returns ByteReadChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException.

fun CoroutineScope.mapEngineExceptions(output: ByteWriteChannel, request: HttpRequestData): ByteWriteChannel

Returns ByteWriteChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException.