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

HttpClientEngineBase

abstract class HttpClientEngineBase(engineName: String) : HttpClientEngine

Abstract implementation of HttpClientEngine responsible for lifecycle control of dispatcher and coroutineContext as well as proper call context management. Should be considered as the best parent class for custom HttpClientEngine implementations.

Constructors

constructor(engineName: String)

Properties

config

abstract val config: HttpClientEngineConfig

Provides access to an engine's configuration.

coroutineContext

open override val coroutineContext: CoroutineContext

dispatcher

open override val dispatcher: CoroutineDispatcher

Specifies CoroutineDispatcher for I/O operations.

supportedCapabilities

open val supportedCapabilities: Set<HttpClientEngineCapability<*>>

Set of supported engine extensions.

Functions

open override fun close()

execute

abstract suspend fun execute(data: HttpRequestData): HttpResponseData

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

install

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.