HttpResponse
abstract class HttpResponse : HttpMessage, CoroutineScope
A response for HttpClient, second part of HttpClientCall.
Constructors
HttpResponse() A response for HttpClient, second part of HttpClientCall. |
Properties
abstract val call: HttpClientCall The associated HttpClientCall containing both the underlying HttpClientCall.request and HttpClientCall.response. |
|
abstract val content: ByteReadChannel ByteReadChannel with the payload of the response. |
|
abstract val requestTime: GMTDate GMTDate of the request start. |
|
abstract val responseTime: GMTDate GMTDate of the response start. |
|
abstract val status: HttpStatusCode The HttpStatusCode returned by the server. It includes both, the HttpStatusCode.description and the HttpStatusCode.value (code). |
|
abstract val version: HttpProtocolVersion HTTP version. Usually HttpProtocolVersion.HTTP_1_1 or HttpProtocolVersion.HTTP_2_0. |
Inherited Properties
abstract val headers: Headers Message Headers |
Functions
open fun toString(): String |
Extension Properties
val HttpResponse.request: HttpRequest HttpRequest associated with this response. |
|
val HttpResponse. |
Extension Functions
fun HttpMessage.cacheControl(): List<HeaderValue> Parse |
|
fun HttpMessage.charset(): Charset? Parse charset from |
|
fun HttpResponse. |
|
fun HttpMessage.contentLength(): Long? Parse |
|
fun HttpMessage.contentType(): ContentType? Parse |
|
fun HttpMessage.date(): Date? Parse |
|
fun CoroutineScope. fun CoroutineScope.decodeChunked( Start a chunked stream decoder coroutine |
|
suspend fun HttpResponse.discardRemaining(): Unit Efficiently discards the remaining bytes of HttpResponse.content. |
|
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> CoroutineScope.embeddedServer( Creates an embedded server with the given factory, listening on host:port |
|
fun HttpMessage.etag(): String? Parse |
|
fun HttpMessage.expires(): Date? Parse |
|
fun CoroutineScope.httpServer( Start an http server with settings invoking handler for every request |
|
fun CoroutineScope. Start an http server with settings invoking handler for every request |
|
fun HttpMessage.lastModified(): Date? Parse |
|
fun CoroutineScope.mapEngineExceptions( Returns ByteReadChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException. fun CoroutineScope.mapEngineExceptions( Returns ByteWriteChannel with ByteChannel.close handler that returns SocketTimeoutException instead of SocketTimeoutException. |
|
fun CoroutineScope.parseMultipart( fun CoroutineScope.parseMultipart( fun CoroutineScope.parseMultipart( Starts a multipart parser coroutine producing multipart events |
|
fun CoroutineScope.pinger( 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( 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 |
|
fun CoroutineScope.pinger( 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.ponger( 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 |
|
suspend fun HttpResponse.readBytes(count: Int): ByteArray Exactly reads count bytes of the HttpResponse.content. suspend fun HttpResponse.readBytes(): ByteArray Reads the whole HttpResponse.content if Content-Length was specified. Otherwise it just reads one byte. |
|
suspend fun HttpResponse.readText( Read the HttpResponse.content as a String. You can pass an optional charset to specify a charset in the case no one is specified as part of the Content-Type response. If no charset specified either as parameter or as part of the response, io.ktor.client.features.HttpPlainText settings will be used. |
|
fun CoroutineScope.reader( fun CoroutineScope.reader( |
|
suspend fun <T> HttpResponse.receive(): T Tries to receive the payload of the response as an specific type T. |
|
fun HttpMessage.setCookie(): List<Cookie> Parse |
|
fun CoroutineScope. Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |
|
fun CoroutineScope.startServerConnectionPipeline( Start connection HTTP pipeline invoking handler for every request. Note that handler could be invoked multiple times concurrently due to HTTP pipeline nature |
|
fun HttpResponse. |
|
fun HttpMessage.vary(): List<String>? Parse |
|
fun CoroutineScope.writeMultipleRanges( Start multirange response writer coroutine |
|
fun CoroutineScope.writer( fun CoroutineScope.writer( |
Inheritors
class DefaultHttpResponse : HttpResponse |