ktor-client-core/io.ktor.client.utils

Package-level declarations

Types

CacheControl

object CacheControl

List of CacheControl known values.

EmptyContent

data object EmptyContent : OutgoingContent.NoContent

Concrete OutgoingContent without a payload.

HttpResponseReceiveFail

class HttpResponseReceiveFail(val response: HttpResponse, val cause: Throwable)

Utility class containing response and fail reasons for an HttpResponseReceiveFailed event.

Properties

DEFAULT_HTTP_BUFFER_SIZE

const val DEFAULT_HTTP_BUFFER_SIZE: Int = 4096

Size of each buffer in the HttpClientDefaultPool.

DEFAULT_HTTP_POOL_SIZE

const val DEFAULT_HTTP_POOL_SIZE: Int = 1000

Maximum number of buffers to be allocated in the HttpClientDefaultPool.

HttpClientDefaultPool

val HttpClientDefaultPool: ByteBufferPool

Singleton pool of ByteBuffer objects used for HttpClient.

HttpRequestCreated

val HttpRequestCreated: EventDefinition<HttpRequestBuilder>

Occurs after the creation of a new request

HttpRequestIsReadyForSending

val HttpRequestIsReadyForSending: EventDefinition<HttpRequestBuilder>

Occurs before sending the request, and after execution of all interceptors.

HttpResponseCancelled

val HttpResponseCancelled: EventDefinition<HttpResponse>

Occurs when the response is cancelled due to an exception.

HttpResponseReceived

val HttpResponseReceived: EventDefinition<HttpResponse>

Occurs after responses headers have been received.

HttpResponseReceiveFailed

val HttpResponseReceiveFailed: EventDefinition<HttpResponseReceiveFail>

Occurs when an exception is thrown during receiving of body.

Functions

buildHeaders

fun buildHeaders(block: HeadersBuilder.() -> Unit = {}): Headers

Builds an instance of Headers using the block function.

clientDispatcher

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

Creates CoroutineDispatcher for client with fixed threadCount and specified dispatcherName.

actual fun Dispatchers.clientDispatcher(threadCount: Int, dispatcherName: String): CoroutineDispatcher

Creates CoroutineDispatcher for client with fixed threadCount and specified dispatcherName.

actual fun Dispatchers.clientDispatcher(threadCount: Int, dispatcherName: String): CoroutineDispatcher

Creates CoroutineDispatcher based on thread pool of threadCount threads.

actual fun Dispatchers.clientDispatcher(threadCount: Int, dispatcherName: String): CoroutineDispatcher

Creates CoroutineDispatcher for client with fixed threadCount and specified dispatcherName.

unwrapCancellationException

expect fun Throwable.unwrapCancellationException(): Throwable

If the exception contains cause that differs from CancellationException returns it otherwise returns itself.

actual fun Throwable.unwrapCancellationException(): Throwable

If the exception contains cause that differs from CancellationException returns it otherwise returns itself.

actual fun Throwable.unwrapCancellationException(): Throwable

If the exception contains cause that differs from CancellationException returns it otherwise returns itself.

actual fun Throwable.unwrapCancellationException(): Throwable

If the exception contains cause that differs from CancellationException returns it otherwise returns itself.

wrapHeaders

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

Generates a new OutgoingContent of the same abstract type but with OutgoingContent.headers transformed by the specified block.