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

Package-level declarations

Types

ClientEngineClosedException

class ClientEngineClosedException(val cause: Throwable? = null) : IllegalStateException

An exception indicating that the client's engine is already closed.

engines

object engines : Iterable<EngineFactory>

Shared engines collection for. Use append to enable engine auto discover in HttpClient().

HttpClientEngine

interface HttpClientEngine : CoroutineScope, Closeable

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

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.

HttpClientEngineCapability

interface HttpClientEngineCapability<T>

Capability required by request to be supported by HttpClientEngine with T representing type of the capability configuration.

HttpClientEngineConfig

open class HttpClientEngineConfig

Base configuration for HttpClientEngine.

HttpClientEngineFactory

interface HttpClientEngineFactory<out T : HttpClientEngineConfig>

A factory of HttpClientEngine with a specific T of HttpClientEngineConfig.

ProxyBuilder

expect object ProxyBuilder

A ProxyConfig factory.

actual object ProxyBuilder

ProxyConfig factory.

actual object ProxyBuilder

ProxyConfig factory.

actual object ProxyBuilder

ProxyConfig factory.

ProxyConfig

expect class ProxyConfig

A proxy configuration.

actual class ProxyConfig

Proxy configuration.

actual typealias ProxyConfig = Proxy

Proxy configuration.

actual class ProxyConfig

Proxy configuration.

ProxyType

enum ProxyType : Enum<ProxyType>

A proxy type.

Properties

DEFAULT_CAPABILITIES

val DEFAULT_CAPABILITIES: Set<HttpClientEngineCapability<*>>

Default capabilities expected to be supported by engine.

KTOR_DEFAULT_USER_AGENT

val KTOR_DEFAULT_USER_AGENT: String

Default user agent to use in ktor client.

type

expect val ProxyConfig.type: ProxyType

A type of the configured proxy.

actual val ProxyConfig.type: ProxyType

Type of configured proxy.

actual val ProxyConfig.type: ProxyType

Type of configured proxy.

Functions

callContext

suspend fun callContext(): CoroutineContext

Returns current call context if exists, otherwise null.

config

fun <T : HttpClientEngineConfig> HttpClientEngineFactory<T>.config(nested: T.() -> Unit): HttpClientEngineFactory<T>

Creates a new HttpClientEngineFactory based on this one with further configurations from the nested block.

http

fun ProxyBuilder.http(urlString: String): ProxyConfig

Creates an HTTP proxy from urlString.

mergeHeaders

fun mergeHeaders(requestHeaders: Headers, content: OutgoingContent, block: (key: String, value: String) -> Unit)

Merge headers from content and requestHeaders according to OutgoingContent properties

resolveAddress

expect fun ProxyConfig.resolveAddress(): NetworkAddress

Resolves a remote address of ProxyConfig.

actual fun ProxyConfig.resolveAddress(): NetworkAddress

Resolve remote address of ProxyConfig.

actual fun ProxyConfig.resolveAddress(): NetworkAddress

Resolve remote address of ProxyConfig.