io.ktor.http.content

Class OutgoingContent.ProtocolUpgrade

OutgoingContent

io.ktor.http.content.OutgoingContent.ProtocolUpgrade

Enclosing class:

OutgoingContent

public static class OutgoingContent.ProtocolUpgrade
extends OutgoingContent

Variant of a class OutgoingContent for upgrading an HTTP connection

See Also:

class OutgoingContent

Nested Class Summary

Nested classes/interfaces inherited from class io.ktor.http.content.OutgoingContent

OutgoingContent.ByteArrayContent, OutgoingContent.NoContent, OutgoingContent.ProtocolUpgrade, OutgoingContent.ReadChannelContent, OutgoingContent.WriteChannelContent

Constructor Summary

Constructors

Constructor and Description
ProtocolUpgrade() Variant of a class OutgoingContent for upgrading an HTTP connection

Method Summary

Modifier and Type	Method and Description
HttpStatusCode	getStatus() Status code to set when sending this content
java.lang.Object	upgrade(kotlinx.coroutines.io.ByteReadChannel input, kotlinx.coroutines.io.ByteWriteChannel output, NonExistentClass engineContext, NonExistentClass userContext, kotlin.coroutines.experimental.Continuation<? super kotlinx.coroutines.Job> p) Upgrades an HTTP connection

Methods inherited from class io.ktor.http.content.OutgoingContent

getContentLength, getContentType, getHeaders, getProperty, getStatus, setProperty

Constructor Detail

ProtocolUpgrade

public ProtocolUpgrade()

Variant of a class OutgoingContent for upgrading an HTTP connection

See Also:

class OutgoingContent

Method Detail

getStatus

public HttpStatusCode getStatus()

Status code to set when sending this content

upgrade

public java.lang.Object upgrade(kotlinx.coroutines.io.ByteReadChannel input,
                                kotlinx.coroutines.io.ByteWriteChannel output,
                                NonExistentClass engineContext,
                                NonExistentClass userContext,
                                kotlin.coroutines.experimental.Continuation<? super kotlinx.coroutines.Job> p)

Upgrades an HTTP connection

Parameters:

input - is a ByteReadChannel for an upgraded connection

output - is a ByteWriteChannel for an upgraded connection

engineContext - is a CoroutineContext to execute non-blocking code, such as parsing or processing

userContext - is a CoroutineContext to execute user-provided callbacks or code potentially blocking