ktor-http/io.ktor.http.content/OutgoingContent

OutgoingContent

sealed class OutgoingContent

Information about the content to be sent to the peer, recognized by a client or server engine

Inheritors

Types

ByteArrayContent

abstract class ByteArrayContent : OutgoingContent

Variant of a OutgoingContent with payload represented as ByteArray

ContentWrapper

abstract class ContentWrapper(delegate: OutgoingContent) : OutgoingContent

Variant of an OutgoingContent which delegates to provided OutgoingContent

NoContent

abstract class NoContent : OutgoingContent

Variant of a OutgoingContent without a payload

ProtocolUpgrade

abstract class ProtocolUpgrade : OutgoingContent

Variant of a OutgoingContent for upgrading an HTTP connection

ReadChannelContent

abstract class ReadChannelContent : OutgoingContent

Variant of a OutgoingContent with payload read from ByteReadChannel

WriteChannelContent

abstract class WriteChannelContent : OutgoingContent

Variant of a OutgoingContent with payload written to ByteWriteChannel

Properties

caching

var OutgoingContent.caching: CachingOptions?

Gets or sets the CacheControl instance as an extension property on this content.

contentLength

open val contentLength: Long?

Specifies content length in bytes for this resource.

contentType

open val contentType: ContentType?

Specifies ContentType for this resource.

headers

open val headers: Headers

Headers to set when sending this content

status

open val status: HttpStatusCode?

Status code to set when sending this content

versions

var OutgoingContent.versions: List<Version>

Gets or sets a list of Version instances as an extension property on this content.

Functions

compressed

fun OutgoingContent.compressed(contentEncoder: ContentEncoder, coroutineContext: CoroutineContext = EmptyCoroutineContext): OutgoingContent?

Returns OutgoingContent compressed with contentEncoder if possible.

getProperty

open fun <T : Any> getProperty(key: AttributeKey<T>): T?

Gets an extension property for this content

isEmpty

fun OutgoingContent.isEmpty(): Boolean

Check if current OutgoingContent doesn't contain content

setProperty

open fun <T : Any> setProperty(key: AttributeKey<T>, value: T?)

Sets an extension property for this content

trailers

open fun trailers(): Headers?

Trailers to set when sending this content, will be ignored if request is not in HTTP2 mode