ktor-client-core
Module Contents
alltypes
Module Contents
class AcceptAllCookiesStorage : CookiesStorage
typealias BadResponseStatusException = ResponseException
class BodyProgress
class ByteBufferPool : DefaultPool<ByteBuffer>
object CacheControl
typealias CallExceptionHandler = suspend (cause: Throwable) -> Unit
class ClientEngineClosedException : IllegalStateException
class ClientRequestException : ResponseException
abstract class ClientUpgradeContent : NoContent
interface ClientWebSocketSession : WebSocketSession
expect class ConnectTimeoutException
class ConstantCookiesStorage : CookiesStorage
interface CookiesStorage
object DataConversion : HttpClientFeature<Configuration, DataConversion>
class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession
open class DefaultHttpRequest : HttpRequest
class DefaultHttpResponse : HttpResponse
class DefaultRequest
class DoubleReceiveException : IllegalStateException
object EmptyContent : NoContent
class ExpectSuccess
class FormBuilder
Module Contents
fun <T : Any> append(: String, : T, : Headers = Headers.Empty): Unit
fun append(: String, : String, : Headers = Headers.Empty): Unit
fun append(: String, : Number, : Headers = Headers.Empty): Unit
fun append(: String, : ByteArray, : Headers = Headers.Empty): Unit
fun append(: String, : InputProvider, : Headers = Headers.Empty): Unit
fun append(: String, : ByteReadPacket, : Headers = Headers.Empty): Unit
fun append(: String, : Input, : Headers = Headers.Empty): Unit
fun <T : Any> append(part: FormPart<T>): Unit
fun appendInput(: String, : Headers = Headers.Empty, : Long? = null, : () -> Input): Unit
class FormDataContent : ByteArrayContent
data class FormPart<T : Any>
class HttpCache
class HttpCacheEntry
abstract class HttpCacheStorage
class HttpCallValidator
class HttpClient : CoroutineScope
open class HttpClientCall : CoroutineScope
class HttpClientConfig<T : HttpClientEngineConfig>
@DslMarker annotation class HttpClientDsl
interface HttpClientEngine : CoroutineScope
abstract class HttpClientEngineBase : HttpClientEngine
interface HttpClientEngineCapability<T>
open class HttpClientEngineConfig
interface HttpClientEngineContainer
interface HttpClientEngineFactory<out T : HttpClientEngineConfig>
interface HttpClientFeature<out TConfig : Any, TFeature : Any>
abstract class HttpClientJvmEngine : HttpClientEngine
class HttpCookies
data class HttpEngineCall
class HttpPlainText
class HttpReceivePipeline : Pipeline<HttpResponse, HttpClientCall>
class HttpRedirect
interface HttpRequest : HttpMessage, CoroutineScope
class HttpRequestBuilder : HttpMessageBuilder
class HttpRequestData
class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>
class HttpRequestTimeoutException
class HttpResponse : CoroutineScope, HttpMessage
abstract class HttpResponse : HttpMessage, CoroutineScope
data class HttpResponseContainer
class HttpResponseData
class HttpResponsePipeline : Pipeline<HttpResponseContainer, HttpClientCall>
class HttpSend
typealias HttpSendInterceptor = suspend Sender.(HttpClientCall, HttpRequestBuilder) -> HttpClientCall
typealias HttpSendInterceptorBackwardCompatible = suspend Sender.(HttpClientCall) -> HttpClientCall
class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>
class HttpStatement
class HttpTimeout
class InputProvider
class InvalidCacheStateException : IllegalStateException
class LocalFileContent : ReadChannelContent
class MultiPartFormDataContent : WriteChannelContent
class NoTransformationFoundException : UnsupportedOperationException
class ObservableBody
class ObservableContent : ReadChannelContent
typealias ProgressListener = (bytesSendTotal: Long, contentLength: Long) -> Unit
expect object ProxyBuilder
enum class ProxyType
class ReceivePipelineException : IllegalStateException
class RedirectResponseException : ResponseException
open class ResponseException : IllegalStateException
typealias ResponseHandler = suspend (HttpResponse) -> Unit
class ResponseObserver
typealias ResponseValidator = suspend (response: HttpResponse) -> Unit
class SendCountExceedException : IllegalStateException
interface Sender
class ServerResponseException : ResponseException
expect class SocketTimeoutException
typealias Type = <ERROR CLASS>
data class TypeInfo : TypeInfo
class UnsupportedContentTypeException : IllegalStateException
class UnsupportedUpgradeProtocolException : IllegalArgumentException
class UserAgent
object WebSocketCapability : HttpClientEngineCapability<Unit>
class WebSocketException : IllegalStateException
object WebSocketExtensionsCapability : HttpClientEngineCapability<Unit>
class WebSockets
io.ktor.http.content.OutgoingContent
java.net.Proxy
kotlin.Throwable
kotlin.collections.List
kotlinx.coroutines.CoroutineScope
kotlinx.coroutines.Dispatchers
package io.ktor.client
package io.ktor.client.call
package io.ktor.client.content
package io.ktor.client.engine
package io.ktor.client.features
Module Contents
typealias BadResponseStatusException = ResponseException
class BodyProgress
fun HttpClientConfig<*>.BrowserUserAgent(): Unit
typealias CallExceptionHandler = suspend (cause: Throwable) -> Unit
fun HttpClientConfig<*>.Charsets(block: Config.() -> Unit): Unit
class ClientRequestException : ResponseException
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>
class DefaultRequest
class ExpectSuccess
class HttpCallValidator
interface HttpClientFeature<out TConfig : Any, TFeature : Any>
class HttpPlainText
class HttpRedirect
class HttpRequestTimeoutException
fun HttpClientConfig<*>.HttpResponseValidator(block: Config.() -> Unit): Unit
class HttpSend
typealias HttpSendInterceptor = suspend Sender.(HttpClientCall, HttpRequestBuilder) -> HttpClientCall
typealias HttpSendInterceptorBackwardCompatible = suspend Sender.(HttpClientCall) -> HttpClientCall
class HttpTimeout
class RedirectResponseException : ResponseException
open class ResponseException : IllegalStateException
typealias ResponseValidator = suspend (response: HttpResponse) -> Unit
class SendCountExceedException : IllegalStateException
interface Sender
class ServerResponseException : ResponseException
fun SocketTimeoutException(request: HttpRequestData, cause: Throwable? = null): SocketTimeoutException
class 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
package io.ktor.client.features.cache.storage
package io.ktor.client.features.cookies
package io.ktor.client.features.observer
package io.ktor.client.features.websocket
Module Contents
interface ClientWebSocketSession : WebSocketSession
class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession
object WebSocketCapability : HttpClientEngineCapability<Unit>
class WebSocketException : IllegalStateException
object WebSocketExtensionsCapability : HttpClientEngineCapability<Unit>
class 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
Module Contents
abstract class ClientUpgradeContent : NoContent
open class DefaultHttpRequest : HttpRequest
interface HttpRequest : HttpMessage, CoroutineScope
class HttpRequestBuilder : HttpMessageBuilder
class HttpRequestData
class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>
class HttpResponseData
class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>
class ObservableBody
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(: String, : Any?): Unit
fun HttpRequestBuilder.headers(: 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
Module Contents
class FormBuilder
Module Contents
fun <T : Any> append(: String, : T, : Headers = Headers.Empty): Unit
fun append(: String, : String, : Headers = Headers.Empty): Unit
fun append(: String, : Number, : Headers = Headers.Empty): Unit
fun append(: String, : ByteArray, : Headers = Headers.Empty): Unit
fun append(: String, : InputProvider, : Headers = Headers.Empty): Unit
fun append(: String, : ByteReadPacket, : Headers = Headers.Empty): Unit
fun append(: String, : Input, : Headers = Headers.Empty): Unit
fun <T : Any> append(part: FormPart<T>): Unit
fun appendInput(: String, : Headers = Headers.Empty, : Long? = null, : () -> Input): Unit
class FormDataContent : ByteArrayContent
data class FormPart<T : Any>
class InputProvider
class MultiPartFormDataContent : WriteChannelContent
inline fun FormBuilder.append(: String, : Headers = Headers.Empty, : 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
package io.ktor.client.statement
package io.ktor.client.utils
package io.ktor.network.sockets