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

ProtocolUpgrade

abstract class ProtocolUpgrade : OutgoingContent

Variant of a OutgoingContent for upgrading an HTTP connection

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
var OutgoingContent.caching: CachingOptions?

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

Link copied to clipboard
open val contentLength: Long?

Specifies content length in bytes for this resource.

Link copied to clipboard
open val contentType: ContentType?

Specifies ContentType for this resource.

Link copied to clipboard
open val headers: Headers

Headers to set when sending this content

Link copied to clipboard
override val status: HttpStatusCode

Status code to set when sending this content

Link copied to clipboard
var OutgoingContent.versions: List<Version>

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

Functions

Link copied to clipboard
fun OutgoingContent.compressed(contentEncoder: ContentEncoder, coroutineContext: CoroutineContext = EmptyCoroutineContext): OutgoingContent?

Returns OutgoingContent compressed with contentEncoder if possible.

Link copied to clipboard
open fun <T : Any> getProperty(key: AttributeKey<T>): T?

Gets an extension property for this content

Link copied to clipboard
fun OutgoingContent.isEmpty(): Boolean

Check if current OutgoingContent doesn't contain content

Link copied to clipboard
open fun <T : Any> setProperty(key: AttributeKey<T>, value: T?)

Sets an extension property for this content

Link copied to clipboard
open fun trailers(): Headers?

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

Link copied to clipboard
abstract suspend fun upgrade(input: ByteReadChannel, output: ByteWriteChannel, engineContext: CoroutineContext, userContext: CoroutineContext): Job

Upgrades an HTTP connection