ktor-client-core

alltypes

class AcceptAllCookiesStorage : CookiesStorage

AcceptAllCookiesStorage()
suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>

typealias BadResponseStatusException = ResponseException
class BodyProgress

companion object Feature : HttpClientFeature<Unit, BodyProgress>

fun install(feature: BodyProgress, scope: HttpClient): Unit
val key: AttributeKey<BodyProgress>
fun prepare(block: Unit.() -> Unit): BodyProgress

fun install(feature: BodyProgress, scope: HttpClient): Unit
val key: AttributeKey<BodyProgress>
fun prepare(block: Unit.() -> Unit): BodyProgress

class ByteBufferPool : DefaultPool<ByteBuffer>

ByteBufferPool()
protected fun clearInstance(instance: ByteBuffer): ByteBuffer
protected fun produceInstance(): ByteBuffer

object CacheControl

const val MAX_AGE: String
const val MAX_STALE: String
const val MIN_FRESH: String
const val MUST_REVALIDATE: String
const val NO_CACHE: String
const val NO_STORE: String
const val NO_TRANSFORM: String
const val ONLY_IF_CACHED: String
const val PRIVATE: String
const val PROXY_REVALIDATE: String
const val PUBLIC: String
const val S_MAX_AGE: String
fun getMAX_AGE(): String
fun getMAX_STALE(): String
fun getMIN_FRESH(): String
fun getMUST_REVALIDATE(): String
fun getNO_CACHE(): String
fun getNO_STORE(): String
fun getNO_TRANSFORM(): String
fun getONLY_IF_CACHED(): String
fun getPRIVATE(): String
fun getPROXY_REVALIDATE(): String
fun getPUBLIC(): String
fun getS_MAX_AGE(): String

typealias CallExceptionHandler = suspend (cause: Throwable) -> Unit
class ClientEngineClosedException : IllegalStateException

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

class ClientRequestException : ResponseException

ClientRequestException(response: HttpResponse)
ClientRequestException(response: HttpResponse, cachedResponseText: String)
val message: String?

abstract class ClientUpgradeContent : NoContent

ClientUpgradeContent()
val output: ByteWriteChannel
suspend fun pipeTo(output: ByteWriteChannel): Unit
abstract fun verify(headers: Headers): Unit

interface ClientWebSocketSession : WebSocketSession

abstract val call: HttpClientCall

expect class ConnectTimeoutException

ConnectTimeoutException(message: String, cause: Throwable? = null)
val cause: Throwable?

class ConstantCookiesStorage : CookiesStorage

ConstantCookiesStorage(vararg cookies: Cookie)
suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>

interface CookiesStorage

abstract suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
abstract suspend fun get(requestUrl: Url): List<Cookie>

object DataConversion : HttpClientFeature<Configuration, DataConversion>

fun install(feature: DataConversion, scope: HttpClient): Unit
val key: AttributeKey<DataConversion>
fun prepare(block: Configuration.() -> Unit): DataConversion

class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession

DefaultClientWebSocketSession(call: HttpClientCall, delegate: DefaultWebSocketSession)
val call: HttpClientCall

open class DefaultHttpRequest : HttpRequest

DefaultHttpRequest(call: HttpClientCall, data: HttpRequestData)
open val attributes: Attributes
open val call: HttpClientCall
open val content: OutgoingContent
open val coroutineContext: <ERROR CLASS>
open val headers: Headers
open val method: HttpMethod
open val url: Url

class DefaultHttpResponse : HttpResponse

DefaultHttpResponse(call: HttpClientCall, responseData: HttpResponseData)
val call: HttpClientCall
val content: ByteReadChannel
val coroutineContext: <ERROR CLASS>
val headers: Headers
val requestTime: GMTDate
val responseTime: GMTDate
val status: HttpStatusCode
val version: HttpProtocolVersion

class DefaultRequest

DefaultRequest(builder: HttpRequestBuilder.() -> Unit)
companion object Feature : HttpClientFeature<HttpRequestBuilder, DefaultRequest>

fun install(feature: DefaultRequest, scope: HttpClient): Unit
val key: AttributeKey<DefaultRequest>
fun prepare(block: HttpRequestBuilder.() -> Unit): DefaultRequest

fun install(feature: DefaultRequest, scope: HttpClient): Unit
val key: AttributeKey<DefaultRequest>
fun prepare(block: HttpRequestBuilder.() -> Unit): DefaultRequest

class DoubleReceiveException : IllegalStateException

DoubleReceiveException(call: HttpClientCall)
val message: String

object EmptyContent : NoContent

val contentLength: Long
fun toString(): String

class ExpectSuccess

ExpectSuccess()
companion object Companion : HttpClientFeature<Unit, ExpectSuccess>

fun install(feature: ExpectSuccess, scope: HttpClient): Unit
val key: AttributeKey<ExpectSuccess>
fun prepare(block: Unit.() -> Unit): ExpectSuccess

fun install(feature: ExpectSuccess, scope: HttpClient): Unit
val key: AttributeKey<ExpectSuccess>
fun prepare(block: Unit.() -> Unit): ExpectSuccess

class FormBuilder

fun <T : Any> append(key: String, value: T, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: String, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: Number, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: ByteArray, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: InputProvider, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: ByteReadPacket, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: Input, headers: Headers = Headers.Empty): Unit
fun <T : Any> append(part: FormPart<T>): Unit
fun appendInput(key: String, headers: Headers = Headers.Empty, size: Long? = null, block: () -> Input): Unit

class FormDataContent : ByteArrayContent

FormDataContent(formData: Parameters)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType
val formData: Parameters

data class FormPart<T : Any>

FormPart(key: String, value: T, headers: Headers = Headers.Empty)
val headers: Headers
val key: String
val value: T

class HttpCache

HttpCache(publicStorage: HttpCacheStorage, privateStorage: HttpCacheStorage)
companion object Companion : HttpClientFeature<Config, HttpCache>

fun install(feature: HttpCache, scope: HttpClient): Unit
val key: AttributeKey<HttpCache>
fun prepare(block: Config.() -> Unit): HttpCache

class Config

Config()
var privateStorage: HttpCacheStorage
var publicStorage: HttpCacheStorage

fun install(feature: HttpCache, scope: HttpClient): Unit
val key: AttributeKey<HttpCache>
fun prepare(block: Config.() -> Unit): HttpCache
val privateStorage: HttpCacheStorage
val publicStorage: HttpCacheStorage

class HttpCacheEntry

val body: ByteArray
fun equals(other: Any?): Boolean
val expires: GMTDate
fun hashCode(): Int
val response: HttpResponse
val varyKeys: Map<String, String>

abstract class HttpCacheStorage

HttpCacheStorage()
val Disabled: HttpCacheStorage
val Unlimited: () -> HttpCacheStorage
abstract fun find(url: Url, varyKeys: Map<String, String>): HttpCacheEntry?
abstract fun findByUrl(url: Url): Set<HttpCacheEntry>
abstract fun store(url: Url, value: HttpCacheEntry): Unit

class HttpCallValidator

HttpCallValidator(responseValidators: List<ResponseValidator>, callExceptionHandlers: List<CallExceptionHandler>)
companion object Companion : HttpClientFeature<Config, HttpCallValidator>

fun install(feature: HttpCallValidator, scope: HttpClient): Unit
val key: AttributeKey<HttpCallValidator>
fun prepare(block: Config.() -> Unit): HttpCallValidator

class Config

Config()
var expectSuccess: Boolean
fun handleResponseException(block: CallExceptionHandler): Unit
fun validateResponse(block: ResponseValidator): Unit

fun install(feature: HttpCallValidator, scope: HttpClient): Unit
val key: AttributeKey<HttpCallValidator>
fun prepare(block: Config.() -> Unit): HttpCallValidator

class HttpClient : CoroutineScope

HttpClient(engine: HttpClientEngine, userConfig: HttpClientConfig<out HttpClientEngineConfig> = HttpClientConfig())
val attributes: Attributes
fun close(): Unit
fun config(block: HttpClientConfig<*>.() -> Unit): HttpClient
val coroutineContext: <ERROR CLASS>
val dispatcher: CoroutineDispatcher
val engine: HttpClientEngine
val engineConfig: HttpClientEngineConfig
suspend fun execute(builder: HttpRequestBuilder): HttpClientCall
fun isSupported(capability: HttpClientEngineCapability<*>): Boolean
val receivePipeline: HttpReceivePipeline
val requestPipeline: HttpRequestPipeline
val responsePipeline: HttpResponsePipeline
val sendPipeline: HttpSendPipeline
fun toString(): String

open class HttpClientCall : CoroutineScope

val CustomResponse: AttributeKey<Any>
protected open val allowDoubleReceive: Boolean
val attributes: Attributes
val client: HttpClient?
open val coroutineContext: <ERROR CLASS>
protected open suspend fun getResponseContent(): ByteReadChannel
suspend fun receive(info: TypeInfo): Any
suspend fun receive(info: TypeInfo): Any
lateinit var request: HttpRequest
lateinit var response: HttpResponse
open fun toString(): String

class HttpClientConfig<T : HttpClientEngineConfig>

HttpClientConfig()
fun clone(): HttpClientConfig<T>
var developmentMode: Boolean
fun engine(block: T.() -> Unit): Unit
var expectSuccess: Boolean
var followRedirects: Boolean
fun <TBuilder : Any, TFeature : Any> install(feature: HttpClientFeature<TBuilder, TFeature>, configure: TBuilder.() -> Unit = {}): Unit
fun install(key: String, block: HttpClient.() -> Unit): Unit
fun install(client: HttpClient): Unit
operator fun plusAssign(other: HttpClientConfig<out T>): Unit
var useDefaultTransformers: Boolean

@DslMarker annotation class HttpClientDsl

HttpClientDsl()

interface HttpClientEngine : CoroutineScope

abstract val config: HttpClientEngineConfig
abstract val dispatcher: CoroutineDispatcher
abstract suspend fun execute(data: HttpRequestData): HttpResponseData
open fun install(client: HttpClient): Unit
open val supportedCapabilities: Set<HttpClientEngineCapability<*>>

abstract class HttpClientEngineBase : HttpClientEngine

HttpClientEngineBase(engineName: String)
open fun close(): Unit
open val coroutineContext: <ERROR CLASS>

interface HttpClientEngineCapability<T>
open class HttpClientEngineConfig

HttpClientEngineConfig()
var pipelining: Boolean
var proxy: ProxyConfig?
val response: Nothing
var threadsCount: Int

interface HttpClientEngineContainer

abstract val factory: HttpClientEngineFactory<*>

interface HttpClientEngineFactory<out T : HttpClientEngineConfig>

abstract fun create(block: T.() -> Unit = {}): HttpClientEngine

interface HttpClientFeature<out TConfig : Any, TFeature : Any>

abstract fun install(feature: TFeature, scope: HttpClient): Unit
abstract val key: AttributeKey<TFeature>
abstract fun prepare(block: TConfig.() -> Unit = {}): TFeature

abstract class HttpClientJvmEngine : HttpClientEngine

HttpClientJvmEngine(engineName: String)
open fun close(): Unit
open val coroutineContext: <ERROR CLASS>
protected suspend fun createCallContext(): <ERROR CLASS>
open val dispatcher: CoroutineDispatcher

class HttpCookies

HttpCookies(storage: CookiesStorage, defaults: List<suspend CookiesStorage.() -> Unit>)
companion object Companion : HttpClientFeature<Config, HttpCookies>

fun install(feature: HttpCookies, scope: HttpClient): Unit
val key: AttributeKey<HttpCookies>
fun prepare(block: Config.() -> Unit): HttpCookies

class Config

Config()
fun default(block: suspend CookiesStorage.() -> Unit): Unit
var storage: CookiesStorage

fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>
fun install(feature: HttpCookies, scope: HttpClient): Unit
val key: AttributeKey<HttpCookies>
fun prepare(block: Config.() -> Unit): HttpCookies

data class HttpEngineCall

HttpEngineCall(request: HttpRequest, response: HttpResponse)
val request: HttpRequest
val response: HttpResponse

class HttpPlainText

class Config

Config()
var defaultCharset: <ERROR CLASS>
fun register(charset: <ERROR CLASS>, quality: Float? = null): Unit
var responseCharsetFallback: <ERROR CLASS>
var sendCharset: <ERROR CLASS>?

companion object Feature : HttpClientFeature<Config, HttpPlainText>

fun install(feature: HttpPlainText, scope: HttpClient): Unit
val key: AttributeKey<HttpPlainText>
fun prepare(block: Config.() -> Unit): HttpPlainText

var defaultCharset: <ERROR CLASS>
fun install(feature: HttpPlainText, scope: HttpClient): Unit
val key: AttributeKey<HttpPlainText>
fun prepare(block: Config.() -> Unit): HttpPlainText

class HttpReceivePipeline : Pipeline<HttpResponse, HttpClientCall>

HttpReceivePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val State: PipelinePhase
val developmentMode: Boolean

class HttpRedirect

HttpRedirect()
companion object Feature : HttpClientFeature<HttpRedirect, HttpRedirect>

fun install(feature: HttpRedirect, scope: HttpClient): Unit
val key: AttributeKey<HttpRedirect>
fun prepare(block: HttpRedirect.() -> Unit): HttpRedirect

var allowHttpsDowngrade: Boolean
var checkHttpMethod: Boolean
fun install(feature: HttpRedirect, scope: HttpClient): Unit
val key: AttributeKey<HttpRedirect>
fun prepare(block: HttpRedirect.() -> Unit): HttpRedirect

interface HttpRequest : HttpMessage, CoroutineScope

abstract val attributes: Attributes
abstract val call: HttpClientCall
abstract val content: OutgoingContent
open val coroutineContext: <ERROR CLASS>
open val executionContext: Job
abstract val method: HttpMethod
abstract val url: Url

class HttpRequestBuilder : HttpMessageBuilder

HttpRequestBuilder()
val attributes: Attributes
var body: Any
fun build(): HttpRequestData
var executionContext: Job
fun <T : Any> getCapabilityOrNull(key: HttpClientEngineCapability<T>): T?
val headers: HeadersBuilder
var method: HttpMethod
fun setAttributes(block: Attributes.() -> Unit): Unit
fun <T : Any> setCapability(key: HttpClientEngineCapability<T>, capability: T): Unit
fun takeFrom(builder: HttpRequestBuilder): HttpRequestBuilder
fun takeFromWithExecutionContext(builder: HttpRequestBuilder): HttpRequestBuilder
val url: URLBuilder
fun url(block: URLBuilder.(URLBuilder) -> Unit): Unit

class HttpRequestData

HttpRequestData(url: Url, method: HttpMethod, headers: Headers, body: OutgoingContent, executionContext: Job, attributes: Attributes)
val attributes: Attributes
val body: OutgoingContent
val executionContext: Job
fun <T> getCapabilityOrNull(key: HttpClientEngineCapability<T>): T?
val headers: Headers
val method: HttpMethod
fun toString(): String
val url: Url

class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>

HttpRequestPipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Render: PipelinePhase
val Send: PipelinePhase
val State: PipelinePhase
val Transform: PipelinePhase
val developmentMode: Boolean

class HttpRequestTimeoutException

HttpRequestTimeoutException(request: HttpRequestBuilder)

class HttpResponse : CoroutineScope, HttpMessage

HttpResponse()
val coroutineContext: <ERROR CLASS>
val headers: Headers

abstract class HttpResponse : HttpMessage, CoroutineScope

HttpResponse()
abstract val call: HttpClientCall
abstract val content: ByteReadChannel
abstract val requestTime: GMTDate
abstract val responseTime: GMTDate
abstract val status: HttpStatusCode
open fun toString(): String
abstract val version: HttpProtocolVersion

data class HttpResponseContainer

HttpResponseContainer(expectedType: TypeInfo, response: Any)
HttpResponseContainer(expectedType: TypeInfo, response: Any)
val expectedType: TypeInfo
val response: Any

class HttpResponseData

HttpResponseData(statusCode: HttpStatusCode, requestTime: GMTDate, headers: Headers, version: HttpProtocolVersion, body: Any, callContext: <ERROR CLASS>)
val body: Any
val callContext: <ERROR CLASS>
val headers: Headers
val requestTime: GMTDate
val responseTime: GMTDate
val statusCode: HttpStatusCode
fun toString(): String
val version: HttpProtocolVersion

class HttpResponsePipeline : Pipeline<HttpResponseContainer, HttpClientCall>

HttpResponsePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Parse: PipelinePhase
val Receive: PipelinePhase
val State: PipelinePhase
val Transform: PipelinePhase
val developmentMode: Boolean

class HttpSend

HttpSend(maxSendCount: Int = 20)
companion object Feature : HttpClientFeature<HttpSend, HttpSend>

fun install(feature: HttpSend, scope: HttpClient): Unit
val key: AttributeKey<HttpSend>
fun prepare(block: HttpSend.() -> Unit): HttpSend

fun install(feature: HttpSend, scope: HttpClient): Unit
fun intercept(block: HttpSendInterceptor): Unit
fun intercept(block: HttpSendInterceptorBackwardCompatible): Unit
val key: AttributeKey<HttpSend>
var maxSendCount: Int
fun prepare(block: HttpSend.() -> Unit): HttpSend

typealias HttpSendInterceptor = suspend Sender.(HttpClientCall, HttpRequestBuilder) -> HttpClientCall
typealias HttpSendInterceptorBackwardCompatible = suspend Sender.(HttpClientCall) -> HttpClientCall
class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>

HttpSendPipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Engine: PipelinePhase
val Monitoring: PipelinePhase
val Receive: PipelinePhase
val State: PipelinePhase
val developmentMode: Boolean

class HttpStatement

HttpStatement(builder: HttpRequestBuilder, client: HttpClient)
suspend fun <T> execute(block: suspend (response: HttpResponse) -> T): T
suspend fun execute(): HttpResponse
inline suspend fun <reified T> receive(): T
inline suspend fun <reified T, R> receive(crossinline block: suspend (response: T) -> R): R
fun toString(): String

class HttpTimeout

HttpTimeout(requestTimeoutMillis: Long?, connectTimeoutMillis: Long?, socketTimeoutMillis: Long?)
companion object Feature : HttpClientFeature<HttpTimeoutCapabilityConfiguration, HttpTimeout>, HttpClientEngineCapability<HttpTimeoutCapabilityConfiguration>

const val INFINITE_TIMEOUT_MS: Long
fun install(feature: HttpTimeout, scope: HttpClient): Unit
val key: AttributeKey<HttpTimeout>
fun prepare(block: HttpTimeoutCapabilityConfiguration.() -> Unit): HttpTimeout

class HttpTimeoutCapabilityConfiguration

HttpTimeoutCapabilityConfiguration(requestTimeoutMillis: Long? = null, connectTimeoutMillis: Long? = null, socketTimeoutMillis: Long? = null)
var connectTimeoutMillis: Long?
fun equals(other: Any?): Boolean
fun hashCode(): Int
val key: AttributeKey<HttpTimeoutCapabilityConfiguration>
var requestTimeoutMillis: Long?
var socketTimeoutMillis: Long?

const val INFINITE_TIMEOUT_MS: Long
fun install(feature: HttpTimeout, scope: HttpClient): Unit
val key: AttributeKey<HttpTimeout>
fun prepare(block: HttpTimeoutCapabilityConfiguration.() -> Unit): HttpTimeout

class InputProvider

InputProvider(size: Long? = null, block: () -> Input)
val block: () -> Input
val size: Long?

class InvalidCacheStateException : IllegalStateException

InvalidCacheStateException(requestUrl: Url)

class LocalFileContent : ReadChannelContent

LocalFileContent(file: File, contentType: ContentType = ContentType.defaultForFile(file))
val contentLength: Long
val contentType: ContentType
val file: File
fun readFrom(): ByteReadChannel
fun readFrom(range: LongRange): ByteReadChannel

class MultiPartFormDataContent : WriteChannelContent

MultiPartFormDataContent(parts: List<PartData>)
val contentLength: Long?
val contentType: ContentType
suspend fun writeTo(channel: ByteWriteChannel): Unit

class NoTransformationFoundException : UnsupportedOperationException

NoTransformationFoundException(response: HttpResponse, from: KClass<*>, to: KClass<*>)
val message: String?

class ObservableBody

ObservableBody(body: Any, bodyType: TypeInfo, listener: ProgressListener)
val body: Any
val bodyType: TypeInfo
val listener: ProgressListener

class ObservableContent : ReadChannelContent

ObservableContent(delegate: OutgoingContent, callContext: <ERROR CLASS>, listener: ProgressListener)
val contentLength: Long?
val contentType: ContentType?
fun <T : Any> getProperty(key: AttributeKey<T>): T?
val headers: Headers
fun readFrom(): ByteReadChannel
fun <T : Any> setProperty(key: AttributeKey<T>, value: T?): Unit
val status: HttpStatusCode?

typealias ProgressListener = (bytesSendTotal: Long, contentLength: Long) -> Unit
expect object ProxyBuilder

fun http(url: Url): ProxyConfig
fun socks(host: String, port: Int): ProxyConfig

enum class ProxyType

HTTP
SOCKS
UNKNOWN

class ReceivePipelineException : IllegalStateException

ReceivePipelineException(request: HttpClientCall, info: TypeInfo, cause: Throwable)
ReceivePipelineException(request: HttpClientCall, info: TypeInfo, cause: Throwable)
val cause: Throwable
val info: TypeInfo
val request: HttpClientCall

class RedirectResponseException : ResponseException

RedirectResponseException(response: HttpResponse)
RedirectResponseException(response: HttpResponse, cachedResponseText: String)
val message: String?

open class ResponseException : IllegalStateException

ResponseException(response: HttpResponse)
ResponseException(response: HttpResponse, cachedResponseText: String)
val response: HttpResponse

typealias ResponseHandler = suspend (HttpResponse) -> Unit
class ResponseObserver

ResponseObserver(responseHandler: ResponseHandler)
class Config

Config()
fun onResponse(block: ResponseHandler): Unit

companion object Feature : HttpClientFeature<Config, ResponseObserver>

fun install(feature: ResponseObserver, scope: HttpClient): Unit
val key: AttributeKey<ResponseObserver>
fun prepare(block: Config.() -> Unit): ResponseObserver

fun install(feature: ResponseObserver, scope: HttpClient): Unit
val key: AttributeKey<ResponseObserver>
fun prepare(block: Config.() -> Unit): ResponseObserver

typealias ResponseValidator = suspend (response: HttpResponse) -> Unit
class SendCountExceedException : IllegalStateException

SendCountExceedException(message: String)

interface Sender

abstract suspend fun execute(requestBuilder: HttpRequestBuilder): HttpClientCall

class ServerResponseException : ResponseException

ServerResponseException(response: HttpResponse)
ServerResponseException(response: HttpResponse, cachedResponseText: String)
val message: String?

expect class SocketTimeoutException

SocketTimeoutException(message: String, cause: Throwable? = null)
val cause: Throwable?

typealias Type = <ERROR CLASS>
data class TypeInfo : TypeInfo

TypeInfo(type: KClass<*>, reifiedType: <ERROR CLASS>, kotlinType: KType? = null)
val kotlinType: KType?
val reifiedType: <ERROR CLASS>
val type: KClass<*>

class UnsupportedContentTypeException : IllegalStateException

UnsupportedContentTypeException(content: OutgoingContent)

class UnsupportedUpgradeProtocolException : IllegalArgumentException

UnsupportedUpgradeProtocolException(url: Url)

class UserAgent

UserAgent(agent: String)
class Config

Config(agent: String = "Ktor http-client")
var agent: String

companion object Feature : HttpClientFeature<Config, UserAgent>

fun install(feature: UserAgent, scope: HttpClient): Unit
val key: AttributeKey<UserAgent>
fun prepare(block: Config.() -> Unit): UserAgent

val agent: String
fun install(feature: UserAgent, scope: HttpClient): Unit
val key: AttributeKey<UserAgent>
fun prepare(block: Config.() -> Unit): UserAgent

object WebSocketCapability : HttpClientEngineCapability<Unit>

fun toString(): String

class WebSocketException : IllegalStateException

WebSocketException(message: String)

object WebSocketExtensionsCapability : HttpClientEngineCapability<Unit>

fun toString(): String

class WebSockets

WebSockets(pingInterval: Long = -1L, maxFrameSize: Long = Int.MAX_VALUE.toLong())
WebSockets()
class Config

Config()
fun extensions(block: WebSocketExtensionsConfig.() -> Unit): Unit
var maxFrameSize: Long
var pingInterval: Long

companion object Feature : HttpClientFeature<Config, WebSockets>

fun install(feature: WebSockets, scope: HttpClient): Unit
val key: AttributeKey<WebSockets>
fun prepare(block: Config.() -> Unit): WebSockets

fun install(feature: WebSockets, scope: HttpClient): Unit
val key: AttributeKey<WebSockets>
val maxFrameSize: Long
val pingInterval: Long
fun prepare(block: Config.() -> Unit): WebSockets

io.ktor.http.content.OutgoingContent

fun OutgoingContent.wrapHeaders(block: (Headers) -> Headers): OutgoingContent

java.net.Proxy

expect fun ProxyConfig.resolveAddress(): <ERROR CLASS>
expect val ProxyConfig.type: ProxyType

kotlin.Throwable

expect fun Throwable.unwrapCancellationException(): Throwable

kotlin.collections.List

operator fun List<Cookie>.get(name: String): Cookie?

kotlinx.coroutines.CoroutineScope

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

kotlinx.coroutines.Dispatchers

expect fun Dispatchers.clientDispatcher(threadCount: Int, dispatcherName: String = "ktor-client-dispatcher"): CoroutineDispatcher
fun Dispatchers.fixedThreadPoolDispatcher(threadCount: Int, dispatcherName: String = "client-dispatcher"): CoroutineDispatcher

package io.ktor.client

expect fun HttpClient(block: HttpClientConfig<*>.() -> Unit = {}): HttpClient
fun <T : HttpClientEngineConfig> HttpClient(engineFactory: HttpClientEngineFactory<T>, block: HttpClientConfig<T>.() -> Unit = {}): HttpClient
fun HttpClient(engine: HttpClientEngine, block: HttpClientConfig<*>.() -> Unit): HttpClient
class HttpClient : CoroutineScope

HttpClient(engine: HttpClientEngine, userConfig: HttpClientConfig<out HttpClientEngineConfig> = HttpClientConfig())
val attributes: Attributes
fun close(): Unit
fun config(block: HttpClientConfig<*>.() -> Unit): HttpClient
val coroutineContext: <ERROR CLASS>
val dispatcher: CoroutineDispatcher
val engine: HttpClientEngine
val engineConfig: HttpClientEngineConfig
suspend fun execute(builder: HttpRequestBuilder): HttpClientCall
fun isSupported(capability: HttpClientEngineCapability<*>): Boolean
val receivePipeline: HttpReceivePipeline
val requestPipeline: HttpRequestPipeline
val responsePipeline: HttpResponsePipeline
val sendPipeline: HttpSendPipeline
fun toString(): String

class HttpClientConfig<T : HttpClientEngineConfig>

HttpClientConfig()
fun clone(): HttpClientConfig<T>
var developmentMode: Boolean
fun engine(block: T.() -> Unit): Unit
var expectSuccess: Boolean
var followRedirects: Boolean
fun <TBuilder : Any, TFeature : Any> install(feature: HttpClientFeature<TBuilder, TFeature>, configure: TBuilder.() -> Unit = {}): Unit
fun install(key: String, block: HttpClient.() -> Unit): Unit
fun install(client: HttpClient): Unit
operator fun plusAssign(other: HttpClientConfig<out T>): Unit
var useDefaultTransformers: Boolean

@DslMarker annotation class HttpClientDsl

HttpClientDsl()

interface HttpClientEngineContainer

abstract val factory: HttpClientEngineFactory<*>

package io.ktor.client.call

class DoubleReceiveException : IllegalStateException

DoubleReceiveException(call: HttpClientCall)
val message: String

open class HttpClientCall : CoroutineScope

val CustomResponse: AttributeKey<Any>
protected open val allowDoubleReceive: Boolean
val attributes: Attributes
val client: HttpClient?
open val coroutineContext: <ERROR CLASS>
protected open suspend fun getResponseContent(): ByteReadChannel
suspend fun receive(info: TypeInfo): Any
suspend fun receive(info: TypeInfo): Any
lateinit var request: HttpRequest
lateinit var response: HttpResponse
open fun toString(): String

data class HttpEngineCall

HttpEngineCall(request: HttpRequest, response: HttpResponse)
val request: HttpRequest
val response: HttpResponse

class NoTransformationFoundException : UnsupportedOperationException

NoTransformationFoundException(response: HttpResponse, from: KClass<*>, to: KClass<*>)
val message: String?

class ReceivePipelineException : IllegalStateException

ReceivePipelineException(request: HttpClientCall, info: TypeInfo, cause: Throwable)
ReceivePipelineException(request: HttpClientCall, info: TypeInfo, cause: Throwable)
val cause: Throwable
val info: TypeInfo
val request: HttpClientCall

typealias Type = <ERROR CLASS>
data class TypeInfo : TypeInfo

TypeInfo(type: KClass<*>, reifiedType: <ERROR CLASS>, kotlinType: KType? = null)
val kotlinType: KType?
val reifiedType: <ERROR CLASS>
val type: KClass<*>

class UnsupportedContentTypeException : IllegalStateException

UnsupportedContentTypeException(content: OutgoingContent)

class UnsupportedUpgradeProtocolException : IllegalArgumentException

UnsupportedUpgradeProtocolException(url: Url)

suspend fun HttpClient.call(block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
suspend fun HttpClient.call(builder: HttpRequestBuilder): HttpClientCall
suspend fun HttpClient.call(urlString: String, block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
suspend fun HttpClient.call(url: Url, block: suspend HttpRequestBuilder.() -> Unit = {}): HttpClientCall
suspend fun HttpClient.call(url: URL, block: HttpRequestBuilder.() -> Unit = {}): HttpClientCall
inline suspend fun <reified T> HttpClientCall.receive(): T
inline suspend fun <reified T> HttpResponse.receive(): T
suspend fun HttpClientCall.save(): HttpClientCall
inline fun <reified T> typeInfo(): TypeInfo

package io.ktor.client.content

class LocalFileContent : ReadChannelContent

LocalFileContent(file: File, contentType: ContentType = ContentType.defaultForFile(file))
val contentLength: Long
val contentType: ContentType
val file: File
fun readFrom(): ByteReadChannel
fun readFrom(range: LongRange): ByteReadChannel

fun LocalFileContent(baseDir: File, relativePath: String, contentType: ContentType = ContentType.defaultForFilePath(relativePath)): LocalFileContent
class ObservableContent : ReadChannelContent

ObservableContent(delegate: OutgoingContent, callContext: <ERROR CLASS>, listener: ProgressListener)
val contentLength: Long?
val contentType: ContentType?
fun <T : Any> getProperty(key: AttributeKey<T>): T?
val headers: Headers
fun readFrom(): ByteReadChannel
fun <T : Any> setProperty(key: AttributeKey<T>, value: T?): Unit
val status: HttpStatusCode?

typealias ProgressListener = (bytesSendTotal: Long, contentLength: Long) -> Unit

package io.ktor.client.engine

class ClientEngineClosedException : IllegalStateException

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

val DEFAULT_CAPABILITIES: Set<HttpTimeout.Feature>
interface HttpClientEngine : CoroutineScope

abstract val config: HttpClientEngineConfig
abstract val dispatcher: CoroutineDispatcher
abstract suspend fun execute(data: HttpRequestData): HttpResponseData
open fun install(client: HttpClient): Unit
open val supportedCapabilities: Set<HttpClientEngineCapability<*>>

abstract class HttpClientEngineBase : HttpClientEngine

HttpClientEngineBase(engineName: String)
open fun close(): Unit
open val coroutineContext: <ERROR CLASS>

interface HttpClientEngineCapability<T>
open class HttpClientEngineConfig

HttpClientEngineConfig()
var pipelining: Boolean
var proxy: ProxyConfig?
val response: Nothing
var threadsCount: Int

interface HttpClientEngineFactory<out T : HttpClientEngineConfig>

abstract fun create(block: T.() -> Unit = {}): HttpClientEngine

abstract class HttpClientJvmEngine : HttpClientEngine

HttpClientJvmEngine(engineName: String)
open fun close(): Unit
open val coroutineContext: <ERROR CLASS>
protected suspend fun createCallContext(): <ERROR CLASS>
open val dispatcher: CoroutineDispatcher

val KTOR_DEFAULT_USER_AGENT: String
expect object ProxyBuilder

fun http(url: Url): ProxyConfig
fun socks(host: String, port: Int): ProxyConfig

ProxyConfig

expect class ProxyConfig
actual typealias ProxyConfig = Proxy

enum class ProxyType

HTTP
SOCKS
UNKNOWN

suspend fun callContext(): <ERROR CLASS>
fun <T : HttpClientEngineConfig> HttpClientEngineFactory<T>.config(nested: T.() -> Unit): HttpClientEngineFactory<T>
fun ProxyBuilder.http(urlString: String): ProxyConfig
java.net.Proxy

expect fun ProxyConfig.resolveAddress(): <ERROR CLASS>
expect val ProxyConfig.type: ProxyType

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

package io.ktor.client.features

typealias BadResponseStatusException = ResponseException
class BodyProgress

companion object Feature : HttpClientFeature<Unit, BodyProgress>

fun install(feature: BodyProgress, scope: HttpClient): Unit
val key: AttributeKey<BodyProgress>
fun prepare(block: Unit.() -> Unit): BodyProgress

fun install(feature: BodyProgress, scope: HttpClient): Unit
val key: AttributeKey<BodyProgress>
fun prepare(block: Unit.() -> Unit): BodyProgress

fun HttpClientConfig<*>.BrowserUserAgent(): Unit
typealias CallExceptionHandler = suspend (cause: Throwable) -> Unit
fun HttpClientConfig<*>.Charsets(block: Config.() -> Unit): Unit
class ClientRequestException : ResponseException

ClientRequestException(response: HttpResponse)
ClientRequestException(response: HttpResponse, cachedResponseText: String)
val message: String?

fun ConnectTimeoutException(request: HttpRequestData, cause: Throwable? = null): ConnectTimeoutException
fun ConnectTimeoutException(url: String, timeout: Long?, cause: Throwable? = null): ConnectTimeoutException
fun HttpClientConfig<*>.CurlUserAgent(): Unit
object DataConversion : HttpClientFeature<Configuration, DataConversion>

fun install(feature: DataConversion, scope: HttpClient): Unit
val key: AttributeKey<DataConversion>
fun prepare(block: Configuration.() -> Unit): DataConversion

class DefaultRequest

DefaultRequest(builder: HttpRequestBuilder.() -> Unit)
companion object Feature : HttpClientFeature<HttpRequestBuilder, DefaultRequest>

fun install(feature: DefaultRequest, scope: HttpClient): Unit
val key: AttributeKey<DefaultRequest>
fun prepare(block: HttpRequestBuilder.() -> Unit): DefaultRequest

fun install(feature: DefaultRequest, scope: HttpClient): Unit
val key: AttributeKey<DefaultRequest>
fun prepare(block: HttpRequestBuilder.() -> Unit): DefaultRequest

class ExpectSuccess

ExpectSuccess()
companion object Companion : HttpClientFeature<Unit, ExpectSuccess>

fun install(feature: ExpectSuccess, scope: HttpClient): Unit
val key: AttributeKey<ExpectSuccess>
fun prepare(block: Unit.() -> Unit): ExpectSuccess

fun install(feature: ExpectSuccess, scope: HttpClient): Unit
val key: AttributeKey<ExpectSuccess>
fun prepare(block: Unit.() -> Unit): ExpectSuccess

class HttpCallValidator

HttpCallValidator(responseValidators: List<ResponseValidator>, callExceptionHandlers: List<CallExceptionHandler>)
companion object Companion : HttpClientFeature<Config, HttpCallValidator>

fun install(feature: HttpCallValidator, scope: HttpClient): Unit
val key: AttributeKey<HttpCallValidator>
fun prepare(block: Config.() -> Unit): HttpCallValidator

class Config

Config()
var expectSuccess: Boolean
fun handleResponseException(block: CallExceptionHandler): Unit
fun validateResponse(block: ResponseValidator): Unit

fun install(feature: HttpCallValidator, scope: HttpClient): Unit
val key: AttributeKey<HttpCallValidator>
fun prepare(block: Config.() -> Unit): HttpCallValidator

interface HttpClientFeature<out TConfig : Any, TFeature : Any>

abstract fun install(feature: TFeature, scope: HttpClient): Unit
abstract val key: AttributeKey<TFeature>
abstract fun prepare(block: TConfig.() -> Unit = {}): TFeature

class HttpPlainText

class Config

Config()
var defaultCharset: <ERROR CLASS>
fun register(charset: <ERROR CLASS>, quality: Float? = null): Unit
var responseCharsetFallback: <ERROR CLASS>
var sendCharset: <ERROR CLASS>?

companion object Feature : HttpClientFeature<Config, HttpPlainText>

fun install(feature: HttpPlainText, scope: HttpClient): Unit
val key: AttributeKey<HttpPlainText>
fun prepare(block: Config.() -> Unit): HttpPlainText

var defaultCharset: <ERROR CLASS>
fun install(feature: HttpPlainText, scope: HttpClient): Unit
val key: AttributeKey<HttpPlainText>
fun prepare(block: Config.() -> Unit): HttpPlainText

class HttpRedirect

HttpRedirect()
companion object Feature : HttpClientFeature<HttpRedirect, HttpRedirect>

fun install(feature: HttpRedirect, scope: HttpClient): Unit
val key: AttributeKey<HttpRedirect>
fun prepare(block: HttpRedirect.() -> Unit): HttpRedirect

var allowHttpsDowngrade: Boolean
var checkHttpMethod: Boolean
fun install(feature: HttpRedirect, scope: HttpClient): Unit
val key: AttributeKey<HttpRedirect>
fun prepare(block: HttpRedirect.() -> Unit): HttpRedirect

class HttpRequestTimeoutException

HttpRequestTimeoutException(request: HttpRequestBuilder)

fun HttpClientConfig<*>.HttpResponseValidator(block: Config.() -> Unit): Unit
class HttpSend

HttpSend(maxSendCount: Int = 20)
companion object Feature : HttpClientFeature<HttpSend, HttpSend>

fun install(feature: HttpSend, scope: HttpClient): Unit
val key: AttributeKey<HttpSend>
fun prepare(block: HttpSend.() -> Unit): HttpSend

fun install(feature: HttpSend, scope: HttpClient): Unit
fun intercept(block: HttpSendInterceptor): Unit
fun intercept(block: HttpSendInterceptorBackwardCompatible): Unit
val key: AttributeKey<HttpSend>
var maxSendCount: Int
fun prepare(block: HttpSend.() -> Unit): HttpSend

typealias HttpSendInterceptor = suspend Sender.(HttpClientCall, HttpRequestBuilder) -> HttpClientCall
typealias HttpSendInterceptorBackwardCompatible = suspend Sender.(HttpClientCall) -> HttpClientCall
class HttpTimeout

HttpTimeout(requestTimeoutMillis: Long?, connectTimeoutMillis: Long?, socketTimeoutMillis: Long?)
companion object Feature : HttpClientFeature<HttpTimeoutCapabilityConfiguration, HttpTimeout>, HttpClientEngineCapability<HttpTimeoutCapabilityConfiguration>

const val INFINITE_TIMEOUT_MS: Long
fun install(feature: HttpTimeout, scope: HttpClient): Unit
val key: AttributeKey<HttpTimeout>
fun prepare(block: HttpTimeoutCapabilityConfiguration.() -> Unit): HttpTimeout

class HttpTimeoutCapabilityConfiguration

HttpTimeoutCapabilityConfiguration(requestTimeoutMillis: Long? = null, connectTimeoutMillis: Long? = null, socketTimeoutMillis: Long? = null)
var connectTimeoutMillis: Long?
fun equals(other: Any?): Boolean
fun hashCode(): Int
val key: AttributeKey<HttpTimeoutCapabilityConfiguration>
var requestTimeoutMillis: Long?
var socketTimeoutMillis: Long?

const val INFINITE_TIMEOUT_MS: Long
fun install(feature: HttpTimeout, scope: HttpClient): Unit
val key: AttributeKey<HttpTimeout>
fun prepare(block: HttpTimeoutCapabilityConfiguration.() -> Unit): HttpTimeout

class RedirectResponseException : ResponseException

RedirectResponseException(response: HttpResponse)
RedirectResponseException(response: HttpResponse, cachedResponseText: String)
val message: String?

open class ResponseException : IllegalStateException

ResponseException(response: HttpResponse)
ResponseException(response: HttpResponse, cachedResponseText: String)
val response: HttpResponse

typealias ResponseValidator = suspend (response: HttpResponse) -> Unit
class SendCountExceedException : IllegalStateException

SendCountExceedException(message: String)

interface Sender

abstract suspend fun execute(requestBuilder: HttpRequestBuilder): HttpClientCall

class ServerResponseException : ResponseException

ServerResponseException(response: HttpResponse)
ServerResponseException(response: HttpResponse, cachedResponseText: String)
val message: String?

fun SocketTimeoutException(request: HttpRequestData, cause: Throwable? = null): SocketTimeoutException
class UserAgent

UserAgent(agent: String)
class Config

Config(agent: String = "Ktor http-client")
var agent: String

companion object Feature : HttpClientFeature<Config, UserAgent>

fun install(feature: UserAgent, scope: HttpClient): Unit
val key: AttributeKey<UserAgent>
fun prepare(block: Config.() -> Unit): UserAgent

val agent: String
fun install(feature: UserAgent, scope: HttpClient): Unit
val key: AttributeKey<UserAgent>
fun prepare(block: Config.() -> Unit): UserAgent

fun HttpClientConfig<*>.addDefaultResponseValidation(): Unit
fun convertLongTimeoutToIntWithInfiniteAsZero(timeout: Long): Int
fun convertLongTimeoutToLongWithInfiniteAsZero(timeout: Long): Long
fun HttpClientConfig<*>.defaultRequest(block: HttpRequestBuilder.() -> Unit): Unit
fun HttpClient.defaultTransformers(): Unit
var HttpRequestBuilder.expectSuccess: Boolean
fun <B : Any, F : Any> HttpClient.feature(feature: HttpClientFeature<B, F>): F?
operator fun <B : Any, F : Any> HttpClient.get(feature: HttpClientFeature<B, F>): F
fun HttpRequestBuilder.timeout(block: HttpTimeoutCapabilityConfiguration.() -> Unit): Unit

package io.ktor.client.features.cache

class HttpCache

HttpCache(publicStorage: HttpCacheStorage, privateStorage: HttpCacheStorage)
companion object Companion : HttpClientFeature<Config, HttpCache>

fun install(feature: HttpCache, scope: HttpClient): Unit
val key: AttributeKey<HttpCache>
fun prepare(block: Config.() -> Unit): HttpCache

class Config

Config()
var privateStorage: HttpCacheStorage
var publicStorage: HttpCacheStorage

fun install(feature: HttpCache, scope: HttpClient): Unit
val key: AttributeKey<HttpCache>
fun prepare(block: Config.() -> Unit): HttpCache
val privateStorage: HttpCacheStorage
val publicStorage: HttpCacheStorage

class HttpCacheEntry

val body: ByteArray
fun equals(other: Any?): Boolean
val expires: GMTDate
fun hashCode(): Int
val response: HttpResponse
val varyKeys: Map<String, String>

class InvalidCacheStateException : IllegalStateException

InvalidCacheStateException(requestUrl: Url)

package io.ktor.client.features.cache.storage

abstract class HttpCacheStorage

HttpCacheStorage()
val Disabled: HttpCacheStorage
val Unlimited: () -> HttpCacheStorage
abstract fun find(url: Url, varyKeys: Map<String, String>): HttpCacheEntry?
abstract fun findByUrl(url: Url): Set<HttpCacheEntry>
abstract fun store(url: Url, value: HttpCacheEntry): Unit

package io.ktor.client.features.cookies

class AcceptAllCookiesStorage : CookiesStorage

AcceptAllCookiesStorage()
suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>

class ConstantCookiesStorage : CookiesStorage

ConstantCookiesStorage(vararg cookies: Cookie)
suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>

interface CookiesStorage

abstract suspend fun addCookie(requestUrl: Url, cookie: Cookie): Unit
abstract suspend fun get(requestUrl: Url): List<Cookie>

class HttpCookies

HttpCookies(storage: CookiesStorage, defaults: List<suspend CookiesStorage.() -> Unit>)
companion object Companion : HttpClientFeature<Config, HttpCookies>

fun install(feature: HttpCookies, scope: HttpClient): Unit
val key: AttributeKey<HttpCookies>
fun prepare(block: Config.() -> Unit): HttpCookies

class Config

Config()
fun default(block: suspend CookiesStorage.() -> Unit): Unit
var storage: CookiesStorage

fun close(): Unit
suspend fun get(requestUrl: Url): List<Cookie>
fun install(feature: HttpCookies, scope: HttpClient): Unit
val key: AttributeKey<HttpCookies>
fun prepare(block: Config.() -> Unit): HttpCookies

suspend fun CookiesStorage.addCookie(urlString: String, cookie: Cookie): Unit
suspend fun HttpClient.cookies(url: Url): List<Cookie>
suspend fun HttpClient.cookies(urlString: String): List<Cookie>
kotlin.collections.List

operator fun List<Cookie>.get(name: String): Cookie?

package io.ktor.client.features.observer

typealias ResponseHandler = suspend (HttpResponse) -> Unit
class ResponseObserver

ResponseObserver(responseHandler: ResponseHandler)
class Config

Config()
fun onResponse(block: ResponseHandler): Unit

companion object Feature : HttpClientFeature<Config, ResponseObserver>

fun install(feature: ResponseObserver, scope: HttpClient): Unit
val key: AttributeKey<ResponseObserver>
fun prepare(block: Config.() -> Unit): ResponseObserver

fun install(feature: ResponseObserver, scope: HttpClient): Unit
val key: AttributeKey<ResponseObserver>
fun prepare(block: Config.() -> Unit): ResponseObserver

fun HttpClientConfig<*>.ResponseObserver(block: ResponseHandler): Unit
fun HttpClientCall.wrapWithContent(content: ByteReadChannel, shouldCloseOrigin: Boolean): HttpClientCall
fun HttpClientCall.wrapWithContent(content: ByteReadChannel): HttpClientCall

package io.ktor.client.features.websocket

interface ClientWebSocketSession : WebSocketSession

abstract val call: HttpClientCall

class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession

DefaultClientWebSocketSession(call: HttpClientCall, delegate: DefaultWebSocketSession)
val call: HttpClientCall

object WebSocketCapability : HttpClientEngineCapability<Unit>

fun toString(): String

class WebSocketException : IllegalStateException

WebSocketException(message: String)

object WebSocketExtensionsCapability : HttpClientEngineCapability<Unit>

fun toString(): String

class WebSockets

WebSockets(pingInterval: Long = -1L, maxFrameSize: Long = Int.MAX_VALUE.toLong())
WebSockets()
class Config

Config()
fun extensions(block: WebSocketExtensionsConfig.() -> Unit): Unit
var maxFrameSize: Long
var pingInterval: Long

companion object Feature : HttpClientFeature<Config, WebSockets>

fun install(feature: WebSockets, scope: HttpClient): Unit
val key: AttributeKey<WebSockets>
fun prepare(block: Config.() -> Unit): WebSockets

fun install(feature: WebSockets, scope: HttpClient): Unit
val key: AttributeKey<WebSockets>
val maxFrameSize: Long
val pingInterval: Long
fun prepare(block: Config.() -> Unit): WebSockets

fun HttpClientConfig<*>.WebSockets(config: Config.() -> Unit): Unit
suspend fun HttpClient.webSocket(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.webSocket(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.webSocket(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.webSocketSession(block: HttpRequestBuilder.() -> Unit): DefaultClientWebSocketSession
suspend fun HttpClient.webSocketSession(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", block: HttpRequestBuilder.() -> Unit = {}): DefaultClientWebSocketSession
suspend fun HttpClient.ws(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.ws(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.ws(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wss(request: HttpRequestBuilder.() -> Unit, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wss(urlString: String, request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wss(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit

package io.ktor.client.request

abstract class ClientUpgradeContent : NoContent

ClientUpgradeContent()
val output: ByteWriteChannel
suspend fun pipeTo(output: ByteWriteChannel): Unit
abstract fun verify(headers: Headers): Unit

open class DefaultHttpRequest : HttpRequest

DefaultHttpRequest(call: HttpClientCall, data: HttpRequestData)
open val attributes: Attributes
open val call: HttpClientCall
open val content: OutgoingContent
open val coroutineContext: <ERROR CLASS>
open val headers: Headers
open val method: HttpMethod
open val url: Url

interface HttpRequest : HttpMessage, CoroutineScope

abstract val attributes: Attributes
abstract val call: HttpClientCall
abstract val content: OutgoingContent
open val coroutineContext: <ERROR CLASS>
open val executionContext: Job
abstract val method: HttpMethod
abstract val url: Url

class HttpRequestBuilder : HttpMessageBuilder

HttpRequestBuilder()
val attributes: Attributes
var body: Any
fun build(): HttpRequestData
var executionContext: Job
fun <T : Any> getCapabilityOrNull(key: HttpClientEngineCapability<T>): T?
val headers: HeadersBuilder
var method: HttpMethod
fun setAttributes(block: Attributes.() -> Unit): Unit
fun <T : Any> setCapability(key: HttpClientEngineCapability<T>, capability: T): Unit
fun takeFrom(builder: HttpRequestBuilder): HttpRequestBuilder
fun takeFromWithExecutionContext(builder: HttpRequestBuilder): HttpRequestBuilder
val url: URLBuilder
fun url(block: URLBuilder.(URLBuilder) -> Unit): Unit

class HttpRequestData

HttpRequestData(url: Url, method: HttpMethod, headers: Headers, body: OutgoingContent, executionContext: Job, attributes: Attributes)
val attributes: Attributes
val body: OutgoingContent
val executionContext: Job
fun <T> getCapabilityOrNull(key: HttpClientEngineCapability<T>): T?
val headers: Headers
val method: HttpMethod
fun toString(): String
val url: Url

class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>

HttpRequestPipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Render: PipelinePhase
val Send: PipelinePhase
val State: PipelinePhase
val Transform: PipelinePhase
val developmentMode: Boolean

class HttpResponseData

HttpResponseData(statusCode: HttpStatusCode, requestTime: GMTDate, headers: Headers, version: HttpProtocolVersion, body: Any, callContext: <ERROR CLASS>)
val body: Any
val callContext: <ERROR CLASS>
val headers: Headers
val requestTime: GMTDate
val responseTime: GMTDate
val statusCode: HttpStatusCode
fun toString(): String
val version: HttpProtocolVersion

class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>

HttpSendPipeline(developmentMode: Boolean = false)
val Before: PipelinePhase
val Engine: PipelinePhase
val Monitoring: PipelinePhase
val Receive: PipelinePhase
val State: PipelinePhase
val developmentMode: Boolean

class ObservableBody

ObservableBody(body: Any, bodyType: TypeInfo, listener: ProgressListener)
val body: Any
val bodyType: TypeInfo
val listener: ProgressListener

fun HttpRequestBuilder.accept(contentType: ContentType): Unit
fun HttpRequestBuilder.cookie(name: String, value: String, maxAge: Int = 0, expires: GMTDate? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
inline suspend fun <reified T> HttpClient.delete(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.delete(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.delete(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.delete(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.delete(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.get(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.head(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.head(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.head(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.head(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.head(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
fun HttpRequestBuilder.header(key: String, value: Any?): Unit
fun HttpRequestBuilder.headers(block: HeadersBuilder.() -> Unit): HeadersBuilder
var HttpRequestBuilder.host: String
operator fun HttpRequestBuilder.Companion.invoke(block: URLBuilder.() -> Unit): HttpRequestBuilder
operator fun HttpRequestBuilder.Companion.invoke(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", block: URLBuilder.() -> Unit = {}): HttpRequestBuilder
operator fun HttpRequestBuilder.Companion.invoke(url: URL): HttpRequestBuilder
fun HttpRequestData.isUpgradeRequest(): Boolean
inline fun <reified T : Any> observableBodyOf(body: T, noinline listener: ProgressListener): ObservableBody
inline suspend fun <reified T> HttpClient.options(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.options(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.options(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.options(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.options(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
fun HttpRequestBuilder.parameter(key: String, value: Any?): Unit
inline suspend fun <reified T> HttpClient.patch(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.patch(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.patch(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.patch(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.patch(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
var HttpRequestBuilder.port: Int
inline suspend fun <reified T> HttpClient.post(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.post(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.post(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.post(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.post(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.put(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.put(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.put(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.put(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.put(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.request(builder: HttpRequestBuilder = HttpRequestBuilder()): T
inline suspend fun <reified T> HttpClient.request(block: HttpRequestBuilder.() -> Unit): T
inline suspend fun <reified T> HttpClient.request(urlString: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.request(url: Url, block: HttpRequestBuilder.() -> Unit = {}): T
fun request(block: HttpRequestBuilder.() -> Unit): HttpRequestBuilder
inline suspend fun <reified T> HttpClient.request(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
fun HttpRequestBuilder.takeFrom(request: HttpRequest): HttpRequestBuilder
fun HttpRequestBuilder.takeFrom(request: HttpRequestData): HttpRequestBuilder
fun HttpRequestBuilder.url(block: URLBuilder.() -> Unit): Unit
fun HttpRequestBuilder.url(scheme: String = "http", host: String = "localhost", port: Int = DEFAULT_PORT, path: String = "/", block: URLBuilder.() -> Unit = {}): Unit
fun HttpRequestBuilder.url(urlString: String): Unit
fun HttpRequestBuilder.url(url: Url): Unit
fun HttpRequestBuilder.url(url: URL): URLBuilder

package io.ktor.client.request.forms

class FormBuilder

fun <T : Any> append(key: String, value: T, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: String, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: Number, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: ByteArray, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: InputProvider, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: ByteReadPacket, headers: Headers = Headers.Empty): Unit
fun append(key: String, value: Input, headers: Headers = Headers.Empty): Unit
fun <T : Any> append(part: FormPart<T>): Unit
fun appendInput(key: String, headers: Headers = Headers.Empty, size: Long? = null, block: () -> Input): Unit

class FormDataContent : ByteArrayContent

FormDataContent(formData: Parameters)
fun bytes(): ByteArray
val contentLength: Long
val contentType: ContentType
val formData: Parameters

data class FormPart<T : Any>

FormPart(key: String, value: T, headers: Headers = Headers.Empty)
val headers: Headers
val key: String
val value: T

class InputProvider

InputProvider(size: Long? = null, block: () -> Input)
val block: () -> Input
val size: Long?

class MultiPartFormDataContent : WriteChannelContent

MultiPartFormDataContent(parts: List<PartData>)
val contentLength: Long?
val contentType: ContentType
suspend fun writeTo(channel: ByteWriteChannel): Unit

inline fun FormBuilder.append(key: String, headers: Headers = Headers.Empty, size: Long? = null, crossinline bodyBuilder: BytePacketBuilder.() -> Unit): Unit
fun FormBuilder.append(key: String, filename: String, contentType: ContentType? = null, size: Long? = null, bodyBuilder: BytePacketBuilder.() -> Unit): Unit
fun formData(vararg values: FormPart<*>): List<PartData>
fun formData(block: FormBuilder.() -> Unit): List<PartData>
inline suspend fun <reified T> HttpClient.submitForm(formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.submitForm(url: String, formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.submitForm(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", formParameters: Parameters = Parameters.Empty, encodeInQuery: Boolean = false, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.submitFormWithBinaryData(formData: List<PartData>, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.submitFormWithBinaryData(url: String, formData: List<PartData>, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.submitFormWithBinaryData(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", formData: List<PartData> = emptyList(), block: HttpRequestBuilder.() -> Unit = {}): T

package io.ktor.client.response

class HttpResponse : CoroutineScope, HttpMessage

HttpResponse()
val coroutineContext: <ERROR CLASS>
val headers: Headers

suspend fun HttpResponse.discardRemaining(): Unit
suspend fun HttpResponse.readBytes(count: Int): ByteArray
suspend fun HttpResponse.readBytes(): ByteArray
suspend fun HttpResponse.readText(charset: <ERROR CLASS>? = null): String

package io.ktor.client.statement

class DefaultHttpResponse : HttpResponse

DefaultHttpResponse(call: HttpClientCall, responseData: HttpResponseData)
val call: HttpClientCall
val content: ByteReadChannel
val coroutineContext: <ERROR CLASS>
val headers: Headers
val requestTime: GMTDate
val responseTime: GMTDate
val status: HttpStatusCode
val version: HttpProtocolVersion

class HttpReceivePipeline : Pipeline<HttpResponse, HttpClientCall>

HttpReceivePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Before: PipelinePhase
val State: PipelinePhase
val developmentMode: Boolean

abstract class HttpResponse : HttpMessage, CoroutineScope

HttpResponse()
abstract val call: HttpClientCall
abstract val content: ByteReadChannel
abstract val requestTime: GMTDate
abstract val responseTime: GMTDate
abstract val status: HttpStatusCode
open fun toString(): String
abstract val version: HttpProtocolVersion

data class HttpResponseContainer

HttpResponseContainer(expectedType: TypeInfo, response: Any)
HttpResponseContainer(expectedType: TypeInfo, response: Any)
val expectedType: TypeInfo
val response: Any

class HttpResponsePipeline : Pipeline<HttpResponseContainer, HttpClientCall>

HttpResponsePipeline(developmentMode: Boolean = false)
val After: PipelinePhase
val Parse: PipelinePhase
val Receive: PipelinePhase
val State: PipelinePhase
val Transform: PipelinePhase
val developmentMode: Boolean

class HttpStatement

HttpStatement(builder: HttpRequestBuilder, client: HttpClient)
suspend fun <T> execute(block: suspend (response: HttpResponse) -> T): T
suspend fun execute(): HttpResponse
inline suspend fun <reified T> receive(): T
inline suspend fun <reified T, R> receive(crossinline block: suspend (response: T) -> R): R
fun toString(): String

fun HttpResponse.close(): Unit
suspend fun HttpResponse.discardRemaining(): Unit
suspend fun HttpResponse.readBytes(count: Int): ByteArray
suspend fun HttpResponse.readBytes(): ByteArray
suspend fun HttpResponse.readText(fallbackCharset: <ERROR CLASS>? = null): String
val HttpResponse.request: HttpRequest
val HttpResponse.response: HttpResponse
val HttpStatement.response: HttpResponse
fun HttpResponse.use(block: () -> Unit): Unit
fun <T> HttpStatement.use(block: suspend (response: HttpResponse) -> T): Unit

package io.ktor.client.utils

class ByteBufferPool : DefaultPool<ByteBuffer>

ByteBufferPool()
protected fun clearInstance(instance: ByteBuffer): ByteBuffer
protected fun produceInstance(): ByteBuffer

object CacheControl

const val MAX_AGE: String
const val MAX_STALE: String
const val MIN_FRESH: String
const val MUST_REVALIDATE: String
const val NO_CACHE: String
const val NO_STORE: String
const val NO_TRANSFORM: String
const val ONLY_IF_CACHED: String
const val PRIVATE: String
const val PROXY_REVALIDATE: String
const val PUBLIC: String
const val S_MAX_AGE: String
fun getMAX_AGE(): String
fun getMAX_STALE(): String
fun getMIN_FRESH(): String
fun getMUST_REVALIDATE(): String
fun getNO_CACHE(): String
fun getNO_STORE(): String
fun getNO_TRANSFORM(): String
fun getONLY_IF_CACHED(): String
fun getPRIVATE(): String
fun getPROXY_REVALIDATE(): String
fun getPUBLIC(): String
fun getS_MAX_AGE(): String

const val DEFAULT_HTTP_BUFFER_SIZE: Int
const val DEFAULT_HTTP_POOL_SIZE: Int
object EmptyContent : NoContent

val contentLength: Long
fun toString(): String

val HttpClientDefaultPool: ByteBufferPool
fun buildHeaders(block: HeadersBuilder.() -> Unit = {}): Headers
io.ktor.http.content.OutgoingContent

fun OutgoingContent.wrapHeaders(block: (Headers) -> Headers): OutgoingContent

kotlin.Throwable

expect fun Throwable.unwrapCancellationException(): Throwable

kotlinx.coroutines.Dispatchers

expect fun Dispatchers.clientDispatcher(threadCount: Int, dispatcherName: String = "ktor-client-dispatcher"): CoroutineDispatcher
fun Dispatchers.fixedThreadPoolDispatcher(threadCount: Int, dispatcherName: String = "client-dispatcher"): CoroutineDispatcher

package io.ktor.network.sockets

expect class ConnectTimeoutException

ConnectTimeoutException(message: String, cause: Throwable? = null)
val cause: Throwable?

expect class SocketTimeoutException

SocketTimeoutException(message: String, cause: Throwable? = null)
val cause: Throwable?

kotlinx.coroutines.CoroutineScope

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