ktor-client-core/io.ktor.client.call/HttpClientCall

HttpClientCall

open class HttpClientCall(val client: HttpClient) : CoroutineScope

A pair of a request and response for a specific HttpClient.

Constructors

HttpClientCall

constructor(client: HttpClient, requestData: HttpRequestData, responseData: HttpResponseData)

constructor(client: HttpClient)

Types

Companion

object Companion

Properties

attributes

val attributes: Attributes

Typed Attributes associated to this call serving as a lightweight container.

client

val client: HttpClient

the client that executed the call.

coroutineContext

open override val coroutineContext: CoroutineContext

request

lateinit var request: HttpRequest

The request sent by the client.

response

lateinit var response: HttpResponse

The response sent by the server.

Functions

body

suspend fun body(info: TypeInfo): Any

Tries to receive the payload of the response as a specific expected type provided in info. Returns response if info corresponds to HttpResponse.

body

inline suspend fun <T> HttpClientCall.body(): T

Tries to receive the payload of the response as a specific type T.

bodyNullable

suspend fun bodyNullable(info: TypeInfo): Any?

Tries to receive the payload of the response as a specific expected type provided in info. Returns response if info corresponds to HttpResponse.

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.

save

suspend fun HttpClientCall.save(): HttpClientCall

Fetch data for HttpClientCall and close the origin.

toString

open override fun toString(): String

wrap

fun HttpClientCall.wrap(content: ByteReadChannel, headers: Headers): HttpClientCall

Wrap existing HttpClientCall with new response content and headers.

wrapWithContent

fun HttpClientCall.wrapWithContent(content: ByteReadChannel): HttpClientCall

Wrap existing HttpClientCall with new content.

fun HttpClientCall.wrapWithContent(block: () -> ByteReadChannel): HttpClientCall

Wrap existing HttpClientCall with new content.