ktor-server-core/io.ktor.server.engine/BaseApplicationResponse

BaseApplicationResponse

abstract class BaseApplicationResponse(val call: PipelineCall) : PipelineResponse

Constructors

constructor(call: PipelineCall)

Types

class BodyLengthIsTooLong(expected: Long) : IllegalStateException, CopyableThrowable<BaseApplicationResponse.BodyLengthIsTooLong>

Content's body size doesn't match the provided one in Content-Length header

BodyLengthIsTooSmall

class BodyLengthIsTooSmall(expected: Long, actual: Long) : IllegalStateException, CopyableThrowable<BaseApplicationResponse.BodyLengthIsTooSmall>

Content's body size doesn't match the provided one in Content-Length header

Companion

object Companion

InvalidHeaderForContent

class InvalidHeaderForContent(name: String, content: String) : IllegalStateException, CopyableThrowable<BaseApplicationResponse.InvalidHeaderForContent>

OutgoingContent is trying to set some header that is not allowed for this content type. For example, only upgrade content can set Upgrade header.

ResponseAlreadySentException

class ResponseAlreadySentException : IllegalStateException

Thrown when there was already response sent but we are trying to respond again

Properties

call

override val call: PipelineCall

An PipelineCall instance this PipelineResponse is attached to.

open override val cookies: ResponseCookies

Provides access to cookies for this response.

headers

abstract val headers: ResponseHeaders

Provides access to headers for the current response.

isCommitted

open override val isCommitted: Boolean

Indicates that this response is already committed and no further changes are allowed.

isSent

override var isSent: Boolean

Indicates that this response is already fully sent to the client.

pipeline

override val pipeline: ApplicationSendPipeline

A pipeline for sending content.

responseType

var ApplicationResponse.responseType: TypeInfo?

A type of response object that is passed in the respond function. Can be useful for custom serializations.

Functions

cacheControl

fun ApplicationResponse.cacheControl(value: CacheControl)

Appends the Cache-Control header with the specified value to a response.

contentRange

fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: RangeUnits)

fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken)

Appends the Content-Range header with the specified range and fullLength to a response.

etag

fun ApplicationResponse.etag(value: String)

Appends the E-Tag header with the specified value to a response.

header

fun ApplicationResponse.header(name: String, value: Int)

fun ApplicationResponse.header(name: String, value: Long)

fun ApplicationResponse.header(name: String, value: String)

Appends a header with the specified name and value to a response.

link

fun ApplicationResponse.link(header: LinkHeader)

Append Link header to HTTP response

fun ApplicationResponse.link(uri: String, vararg rel: String)

Append Link header to HTTP response with specified uri and rel

push

open override fun push(builder: ResponsePushBuilder)

Produces HTTP/2 push from a server to a client or sets an HTTP/1.x hint header or does nothing. Exact behaviour is up to engine implementation.

status

open override fun status(): HttpStatusCode?

Returns a response status code or null if a status code is not set.

open override fun status(value: HttpStatusCode)

Specifies a status code for a response.