HttpClientCall

open class HttpClientCall : CoroutineScope, Closeable

A class that represents a single pair of request and response for a specific HttpClient.

Properties

attributes	`val attributes: Attributes` Typed Attributes associated to this call serving as a lightweight container.
client	`val client: HttpClient` : client that executed the call.
coroutineContext	`open val coroutineContext: <ERROR CLASS>`
request	`lateinit var request: HttpRequest` Represents the request sent by the client
response	`lateinit var response: HttpResponse` Represents the response sent by the server.
responseConfig	`val responseConfig: HttpResponseConfig` Configuration for the response.

Functions

close	`open fun close(): Unit` Closes the underlying response.
receive	`suspend fun receive(info: TypeInfo): Any` Tries to receive the payload of the response as an specific expectedType. Returns response if expectedType is HttpResponse.

Companion Object Properties

CustomResponse

val CustomResponse: AttributeKey<Any>

CustomResponse key used to process the response of custom type in case of HttpClientEngine can’t return body bytes directly. If present, attribute value will be an initial value for HttpResponseContainer in HttpClient.responsePipeline.

Extension Functions

decodeChunked	`fun CoroutineScope.decodeChunked( input: ByteReadChannel ): DecoderJob` Start a chunked stream decoder coroutine
embeddedServer	`fun <TEngine : ApplicationEngine, TConfiguration : Configuration> CoroutineScope.embeddedServer( factory: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = emptyList(), parentCoroutineContext: <ERROR CLASS> = EmptyCoroutineContext, configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit ): TEngine` Creates an embedded server with the given factory, listening on host:port
httpServer	`fun CoroutineScope.httpServer( settings: HttpServerSettings, handler: HttpRequestHandler ): HttpServer` Start an http server with settings invoking handler for every request
parseMultipart	`fun CoroutineScope.parseMultipart( input: ByteReadChannel, headers: HttpHeadersMap ): ReceiveChannel<MultipartEvent>` `fun CoroutineScope.parseMultipart( input: ByteReadChannel, contentType: CharSequence, contentLength: Long? ): ReceiveChannel<MultipartEvent>` `fun CoroutineScope.parseMultipart( boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long? ): ReceiveChannel<MultipartEvent>` Starts a multipart parser coroutine producing multipart events
pinger	`fun CoroutineScope.pinger( outgoing: SendChannel<Frame>, period: Duration, timeout: Duration, pool: ObjectPool<ByteBuffer> = KtorDefaultPool ): SendChannel<Pong>` Launch pinger coroutine on CoroutineScope that is sending ping every specified period to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeout and sending timeout close frame `fun CoroutineScope.pinger( outgoing: SendChannel<Frame>, periodMillis: Long, timeoutMillis: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool ): SendChannel<Pong>` Launch pinger coroutine on CoroutineScope that is sending ping every specified periodMillis to outgoing channel, waiting for and verifying client’s pong frames. It is also handling timeoutMillis and sending timeout close frame
ponger	`fun CoroutineScope.ponger( outgoing: SendChannel<Pong>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool ): SendChannel<Ping>` Launch a ponger actor job on the CoroutineScope sending pongs to outgoing channel. It is acting for every client’s ping frame and replying with corresponding pong
receive	`suspend fun <T> HttpClientCall.receive(): T` Tries to receive the payload of the response as an specific type T.
save	`suspend fun HttpClientCall.save(): HttpClientCall` Fetch data for HttpClientCall and close the origin.
startConnectionPipeline	`fun CoroutineScope.startConnectionPipeline( input: ByteReadChannel, output: ByteWriteChannel, timeout: WeakTimeoutQueue, handler: HttpRequestHandler ): Job` Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature
wrapWithContent	`fun HttpClientCall.wrapWithContent( content: ByteReadChannel, shouldCloseOrigin: Boolean ): HttpClientCall` `fun HttpClientCall.wrapWithContent( content: ByteReadChannel ): HttpClientCall` Wrap existing HttpClientCall with new content.
writeMultipleRanges	`fun CoroutineScope.writeMultipleRanges( channelProducer: (LongRange) -> ByteReadChannel, ranges: List<LongRange>, fullLength: Long?, boundary: String, contentType: String ): ByteReadChannel` Start multirange response writer coroutine