ktor-http-cio

alltypes

class CIOHeaders : Headers

CIOHeaders(headers: HttpHeadersMap)
val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun get(name: String): String?
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>

class CIOMultipartDataBase : MultiPartData, CoroutineScope

CIOMultipartDataBase(coroutineContext: <ERROR CLASS>, channel: ByteReadChannel, contentType: CharSequence, contentLength: Long?, formFieldLimit: Int = 65536, inMemoryFileUploadLimit: Int = formFieldLimit)
val coroutineContext: <ERROR CLASS>
suspend fun readPart(): PartData?

data class CloseReason

CloseReason(code: Codes, message: String)
CloseReason(code: Short, message: String)
enum class Codes

CANNOT_ACCEPT
CLOSED_ABNORMALLY
GOING_AWAY
INTERNAL_ERROR
NORMAL
NOT_CONSISTENT
NO_EXTENSION
PROTOCOL_ERROR
SERVICE_RESTART
TOO_BIG
TRY_AGAIN_LATER
@JvmField val UNEXPECTED_CONDITION: Codes
VIOLATED_POLICY
fun byCode(code: Short): Codes?
val code: Short

val code: Short
val knownReason: Codes?
val message: String
fun toString(): String

class ConnectionOptions

ConnectionOptions(close: Boolean = false, keepAlive: Boolean = false, upgrade: Boolean = false, extraOptions: List<String> = emptyList())
val Close: ConnectionOptions
val KeepAlive: ConnectionOptions
val Upgrade: ConnectionOptions
val close: Boolean
fun equals(other: Any?): Boolean
val extraOptions: List<String>
fun hashCode(): Int
val keepAlive: Boolean
fun parse(connection: CharSequence?): ConnectionOptions?
fun toString(): String
val upgrade: Boolean

typealias DecoderJob = WriterJob
expect interface DefaultWebSocketSession : WebSocketSession

abstract val closeReason: Deferred<CloseReason?>
abstract var pingIntervalMillis: Long
abstract fun start(negotiatedExtensions: List<WebSocketExtension<*>> = emptyList()): Unit
abstract var timeoutMillis: Long

class DefaultWebSocketSessionImpl : DefaultWebSocketSession, WebSocketSession

DefaultWebSocketSessionImpl(raw: WebSocketSession, pingInterval: Long = -1L, timeoutMillis: Long = 15000L, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
val closeReason: Deferred<CloseReason?>
val coroutineContext: <ERROR CLASS>
val extensions: List<WebSocketExtension<*>>
suspend fun flush(): Unit
suspend fun goingAway(message: String = "Server is going down"): Unit
val incoming: ReceiveChannel<Frame>
var masking: Boolean
var maxFrameSize: Long
val outgoing: SendChannel<Frame>
var pingIntervalMillis: Long
fun start(negotiatedExtensions: List<WebSocketExtension<*>>): Unit
fun terminate(): Unit
var timeoutMillis: Long

typealias EncoderJob = ReaderJob
annotation class ExperimentalWebSocketExtensionApi

ExperimentalWebSocketExtensionApi()

sealed expect class Frame

class Binary : Frame

Binary(fin: Boolean, data: ByteArray)
Binary(fin: Boolean, packet: ByteReadPacket)
Binary(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false)
Binary(fin: Boolean, buffer: ByteBuffer)

class Close : Frame

Close(reason: CloseReason)
Close(packet: ByteReadPacket)
Close()
Close(data: ByteArray)
Close(buffer: ByteBuffer)

class Ping : Frame

Ping(packet: ByteReadPacket)
Ping(data: ByteArray)
Ping(buffer: ByteBuffer)

class Pong : Frame

Pong(packet: ByteReadPacket)
Pong(data: ByteArray, disposableHandle: DisposableHandle = NonDisposableHandle)
Pong(buffer: ByteBuffer, disposableHandle: DisposableHandle = NonDisposableHandle)
Pong(buffer: ByteBuffer)

class Text : Frame

Text(fin: Boolean, data: ByteArray)
Text(text: String)
Text(fin: Boolean, packet: ByteReadPacket)
Text(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false)
Text(fin: Boolean, buffer: ByteBuffer)

val buffer: ByteBuffer
fun byType(fin: Boolean, frameType: FrameType, data: ByteArray): Frame
fun byType(fin: Boolean, frameType: FrameType, data: ByteArray, rsv1: Boolean, rsv2: Boolean, rsv3: Boolean): Frame
fun byType(fin: Boolean, frameType: FrameType, buffer: ByteBuffer): Frame
fun copy(): Frame
val data: ByteArray
val disposableHandle: DisposableHandle
val fin: Boolean
val frameType: FrameType
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean
open fun toString(): String

class FrameParser

FrameParser()
enum class State

BODY
HEADER0
LENGTH
MASK_KEY

fun bodyComplete(): Unit
val bodyReady: Boolean
var fin: Boolean
fun frame(bb: ByteBuffer): Unit
val frameType: FrameType
var length: Long
var mask: Boolean
var maskKey: Int?
var rsv1: Boolean
var rsv2: Boolean
var rsv3: Boolean

enum class FrameType

BINARY
CLOSE
PING
PONG
TEXT
val controlFrame: Boolean
operator fun get(opcode: Int): FrameType?
val opcode: Int

class HttpHeadersMap

fun find(name: String, fromIndex: Int = 0): Int
operator fun get(name: String): CharSequence?
fun getAll(name: String): Sequence<CharSequence>
fun nameAt(idx: Int): CharSequence
fun put(nameHash: Int, valueHash: Int, nameStartIndex: Int, nameEndIndex: Int, valueStartIndex: Int, valueEndIndex: Int): Unit
fun release(): Unit
var size: Int
fun toString(): String
fun valueAt(idx: Int): CharSequence

abstract class HttpMessage

open fun close(): Unit
val headers: HttpHeadersMap
fun release(): Unit

typealias HttpRequestHandler = suspend ServerRequestScope.(request: Request) -> Unit
sealed class MultipartEvent

class Epilogue : MultipartEvent

Epilogue(body: ByteReadPacket)
val body: ByteReadPacket
fun release(): Unit

class MultipartPart : MultipartEvent

MultipartPart(headers: Deferred<HttpHeadersMap>, body: ByteReadChannel)
val body: ByteReadChannel
val headers: Deferred<HttpHeadersMap>
fun release(): Unit

class Preamble : MultipartEvent

Preamble(body: ByteReadPacket)
val body: ByteReadPacket
fun release(): Unit

abstract fun release(): Unit

class MutableRange

MutableRange(start: Int, end: Int)
var end: Int
var start: Int
fun toString(): String

class ParserException : Exception

ParserException(message: String)

class RawWebSocket : WebSocketSession

RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long = Int.MAX_VALUE.toLong(), masking: Boolean = false, coroutineContext: <ERROR CLASS>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
val coroutineContext: <ERROR CLASS>
val extensions: List<WebSocketExtension<*>>
suspend fun flush(): Unit
val incoming: ReceiveChannel<Frame>
var masking: Boolean
var maxFrameSize: Long
val outgoing: SendChannel<Frame>
fun terminate(): Unit

class Request : HttpMessage

val method: HttpMethod
val uri: CharSequence
val version: CharSequence

expect class RequestResponseBuilder

RequestResponseBuilder()
fun build(): ByteReadPacket
fun bytes(content: ByteArray, offset: Int = 0, length: Int = content.size): Unit
fun bytes(content: ByteBuffer): Unit
fun emptyLine(): Unit
fun headerLine(name: CharSequence, value: CharSequence): Unit
fun line(line: CharSequence): Unit
fun release(): Unit
fun requestLine(method: HttpMethod, uri: CharSequence, version: CharSequence): Unit
fun responseLine(version: CharSequence, status: Int, statusText: CharSequence): Unit

class Response : HttpMessage

val status: Int
val statusText: CharSequence
val version: CharSequence

class Serializer

Serializer()
fun enqueue(f: Frame): Unit
val hasOutstandingBytes: Boolean
var masking: Boolean
val remainingCapacity: Int
fun serialize(buffer: ByteBuffer): Unit

class ServerIncomingConnection

ServerIncomingConnection(input: ByteReadChannel, output: ByteWriteChannel, remoteAddress: SocketAddress?)
ServerIncomingConnection(input: ByteReadChannel, output: ByteWriteChannel, remoteAddress: SocketAddress?, localAddress: SocketAddress?)
val input: ByteReadChannel
val localAddress: SocketAddress?
val output: ByteWriteChannel
val remoteAddress: SocketAddress?

class ServerRequestScope : CoroutineScope

val coroutineContext: <ERROR CLASS>
val input: ByteReadChannel
val localAddress: SocketAddress?
val output: ByteWriteChannel
val remoteAddress: SocketAddress?
val upgraded: CompletableDeferred<Boolean>?
fun withContext(coroutineContext: <ERROR CLASS>): ServerRequestScope

class SimpleFrameCollector

SimpleFrameCollector()
fun handle(bb: ByteBuffer): Unit
val hasRemaining: Boolean
fun start(length: Int, bb: ByteBuffer): Unit
fun take(maskKey: Int?): ByteBuffer

class WeakTimeoutQueue

WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long = { System.currentTimeMillis() })
interface Registration : DisposableHandle

open fun invoke(cause: Throwable?): Unit

fun cancel(): Unit
fun process(): Unit
fun register(job: Job): Registration
val timeoutMillis: Long
suspend fun <T> withTimeout(block: suspend CoroutineScope.() -> T): T

class WebSocketDeflateExtension : WebSocketExtension<Config>

companion object Companion : WebSocketExtensionFactory<Config, WebSocketDeflateExtension>

fun install(config: Config.() -> Unit): WebSocketDeflateExtension
val key: AttributeKey<WebSocketDeflateExtension>
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean

class Config

Config()
var clientNoContextTakeOver: Boolean
fun compressIf(block: (frame: Frame) -> Boolean): Unit
fun compressIfBiggerThan(bytes: Int): Unit
var compressionLevel: Int
fun configureProtocols(block: (protocols: MutableList<WebSocketExtensionHeader>) -> Unit): Unit
var serverNoContextTakeOver: Boolean

fun clientNegotiation(negotiatedProtocols: List<WebSocketExtensionHeader>): Boolean
val factory: WebSocketExtensionFactory<Config, out WebSocketExtension<Config>>
fun install(config: Config.() -> Unit): WebSocketDeflateExtension
val key: AttributeKey<WebSocketDeflateExtension>
fun processIncomingFrame(frame: Frame): Frame
fun processOutgoingFrame(frame: Frame): Frame
val protocols: List<WebSocketExtensionHeader>
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean
fun serverNegotiation(requestedProtocols: List<WebSocketExtensionHeader>): List<WebSocketExtensionHeader>

interface WebSocketExtension<ConfigType : Any>

abstract fun clientNegotiation(negotiatedProtocols: List<WebSocketExtensionHeader>): Boolean
abstract val factory: WebSocketExtensionFactory<ConfigType, out WebSocketExtension<ConfigType>>
abstract fun processIncomingFrame(frame: Frame): Frame
abstract fun processOutgoingFrame(frame: Frame): Frame
abstract val protocols: List<WebSocketExtensionHeader>
abstract fun serverNegotiation(requestedProtocols: List<WebSocketExtensionHeader>): List<WebSocketExtensionHeader>

interface WebSocketExtensionFactory<ConfigType : Any, ExtensionType : WebSocketExtension<ConfigType>>

abstract fun install(config: ConfigType.() -> Unit): ExtensionType
abstract val key: AttributeKey<ExtensionType>
abstract val rsv1: Boolean
abstract val rsv2: Boolean
abstract val rsv3: Boolean

class WebSocketExtensionHeader

WebSocketExtensionHeader(name: String, parameters: List<String>)
val name: String
val parameters: List<String>
fun parseParameters(): Sequence<Pair<String, String>>
fun toString(): String

class WebSocketExtensionsConfig

WebSocketExtensionsConfig()
fun build(): List<WebSocketExtension<*>>
fun <ConfigType : Any> install(extension: WebSocketExtensionFactory<ConfigType, *>, config: ConfigType.() -> Unit = {}): Unit

annotation class WebSocketInternalAPI

WebSocketInternalAPI()

class WebSocketReader : CoroutineScope

WebSocketReader(byteChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>, maxFrameSize: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
class FrameTooBigException : Exception, CopyableThrowable<FrameTooBigException>

FrameTooBigException(frameSize: Long)
fun createCopy(): FrameTooBigException
val frameSize: Long
val message: String

val coroutineContext: <ERROR CLASS>
val incoming: ReceiveChannel<Frame>
var maxFrameSize: Long

expect interface WebSocketSession : CoroutineScope

abstract val extensions: List<WebSocketExtension<*>>
abstract suspend fun flush(): Unit
abstract val incoming: ReceiveChannel<Frame>
abstract var masking: Boolean
abstract var maxFrameSize: Long
abstract val outgoing: SendChannel<Frame>
abstract suspend fun send(frame: Frame): Unit
abstract fun terminate(): Unit

class WebSocketWriter : CoroutineScope

WebSocketWriter(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>, masking: Boolean = false, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
fun close(): Unit
val coroutineContext: <ERROR CLASS>
suspend fun flush(): Unit
var masking: Boolean
val outgoing: SendChannel<Frame>
val pool: ObjectPool<ByteBuffer>
suspend fun send(frame: Frame): Unit

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.decodeChunked(input: ByteReadChannel): DecoderJob
fun CoroutineScope.decodeChunked(input: ByteReadChannel, contentLength: Long): DecoderJob
fun CoroutineScope.parseMultipart(input: ByteReadChannel, headers: HttpHeadersMap): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long?): ReceiveChannel<MultipartEvent>
fun CoroutineScope.startConnectionPipeline(input: ByteReadChannel, output: ByteWriteChannel, timeout: WeakTimeoutQueue, handler: suspend CoroutineScope.(request: Request, input: ByteReadChannel, output: ByteWriteChannel, upgraded: CompletableDeferred<Boolean>?) -> Unit): Job

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, periodMillis: Long, timeoutMillis: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>
fun CoroutineScope.ponger(outgoing: SendChannel<Pong>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Ping>

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.startServerConnectionPipeline(connection: ServerIncomingConnection, timeout: WeakTimeoutQueue, handler: HttpRequestHandler): Job

package io.ktor.http.cio

class CIOHeaders : Headers

CIOHeaders(headers: HttpHeadersMap)
val caseInsensitiveName: Boolean
fun entries(): Set<Entry<String, List<String>>>
fun get(name: String): String?
fun getAll(name: String): List<String>?
fun isEmpty(): Boolean
fun names(): Set<String>

class CIOMultipartDataBase : MultiPartData, CoroutineScope

CIOMultipartDataBase(coroutineContext: <ERROR CLASS>, channel: ByteReadChannel, contentType: CharSequence, contentLength: Long?, formFieldLimit: Int = 65536, inMemoryFileUploadLimit: Int = formFieldLimit)
val coroutineContext: <ERROR CLASS>
suspend fun readPart(): PartData?

class ConnectionOptions

ConnectionOptions(close: Boolean = false, keepAlive: Boolean = false, upgrade: Boolean = false, extraOptions: List<String> = emptyList())
val Close: ConnectionOptions
val KeepAlive: ConnectionOptions
val Upgrade: ConnectionOptions
val close: Boolean
fun equals(other: Any?): Boolean
val extraOptions: List<String>
fun hashCode(): Int
val keepAlive: Boolean
fun parse(connection: CharSequence?): ConnectionOptions?
fun toString(): String
val upgrade: Boolean

typealias DecoderJob = WriterJob
typealias EncoderJob = ReaderJob
class HttpHeadersMap

fun find(name: String, fromIndex: Int = 0): Int
operator fun get(name: String): CharSequence?
fun getAll(name: String): Sequence<CharSequence>
fun nameAt(idx: Int): CharSequence
fun put(nameHash: Int, valueHash: Int, nameStartIndex: Int, nameEndIndex: Int, valueStartIndex: Int, valueEndIndex: Int): Unit
fun release(): Unit
var size: Int
fun toString(): String
fun valueAt(idx: Int): CharSequence

abstract class HttpMessage

open fun close(): Unit
val headers: HttpHeadersMap
fun release(): Unit

val HttpPipelineCoroutine: CoroutineName
val HttpPipelineWriterCoroutine: CoroutineName
typealias HttpRequestHandler = suspend ServerRequestScope.(request: Request) -> Unit
sealed class MultipartEvent

class Epilogue : MultipartEvent

Epilogue(body: ByteReadPacket)
val body: ByteReadPacket
fun release(): Unit

class MultipartPart : MultipartEvent

MultipartPart(headers: Deferred<HttpHeadersMap>, body: ByteReadChannel)
val body: ByteReadChannel
val headers: Deferred<HttpHeadersMap>
fun release(): Unit

class Preamble : MultipartEvent

Preamble(body: ByteReadPacket)
val body: ByteReadPacket
fun release(): Unit

abstract fun release(): Unit

class ParserException : Exception

ParserException(message: String)

class Request : HttpMessage

val method: HttpMethod
val uri: CharSequence
val version: CharSequence

val RequestHandlerCoroutine: CoroutineName
expect class RequestResponseBuilder

RequestResponseBuilder()
fun build(): ByteReadPacket
fun bytes(content: ByteArray, offset: Int = 0, length: Int = content.size): Unit
fun bytes(content: ByteBuffer): Unit
fun emptyLine(): Unit
fun headerLine(name: CharSequence, value: CharSequence): Unit
fun line(line: CharSequence): Unit
fun release(): Unit
fun requestLine(method: HttpMethod, uri: CharSequence, version: CharSequence): Unit
fun responseLine(version: CharSequence, status: Int, statusText: CharSequence): Unit

class Response : HttpMessage

val status: Int
val statusText: CharSequence
val version: CharSequence

suspend fun boundary(boundaryPrefixed: ByteBuffer, input: ByteReadChannel): Boolean
suspend fun copyMultipart(headers: HttpHeadersMap, input: ByteReadChannel, out: ByteWriteChannel): Unit
suspend fun decodeChunked(input: ByteReadChannel, out: ByteWriteChannel): Unit
suspend fun decodeChunked(input: ByteReadChannel, out: ByteWriteChannel, contentLength: Long): Unit
fun HttpHeadersMap.dumpTo(indent: String, out: Appendable): Unit
suspend fun encodeChunked(output: ByteWriteChannel, coroutineContext: <ERROR CLASS>): EncoderJob
suspend fun encodeChunked(output: ByteWriteChannel, input: ByteReadChannel): Unit
fun expectHttpBody(method: HttpMethod, contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, contentType: CharSequence?): Boolean
fun expectHttpBody(request: Request): Boolean
fun expectHttpUpgrade(method: HttpMethod, upgrade: CharSequence?, connectionOptions: ConnectionOptions?): Boolean
fun expectHttpUpgrade(request: Request): Boolean
fun expectMultipart(headers: HttpHeadersMap): Boolean
kotlinx.coroutines.CoroutineScope

fun CoroutineScope.decodeChunked(input: ByteReadChannel): DecoderJob
fun CoroutineScope.decodeChunked(input: ByteReadChannel, contentLength: Long): DecoderJob
fun CoroutineScope.parseMultipart(input: ByteReadChannel, headers: HttpHeadersMap): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent>
fun CoroutineScope.parseMultipart(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long?): ReceiveChannel<MultipartEvent>
fun CoroutineScope.startConnectionPipeline(input: ByteReadChannel, output: ByteWriteChannel, timeout: WeakTimeoutQueue, handler: suspend CoroutineScope.(request: Request, input: ByteReadChannel, output: ByteWriteChannel, upgraded: CompletableDeferred<Boolean>?) -> Unit): Job

fun lastHttpRequest(http11: Boolean, connectionOptions: ConnectionOptions?): Boolean
fun parseBoundary(contentType: CharSequence): ByteBuffer
suspend fun parseHeaders(input: ByteReadChannel): HttpHeadersMap
suspend fun parseHttpBody(contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, input: ByteReadChannel, out: ByteWriteChannel): Unit
suspend fun parseHttpBody(headers: HttpHeadersMap, input: ByteReadChannel, out: ByteWriteChannel): Unit
fun parseMultipart(coroutineContext: <ERROR CLASS>, input: ByteReadChannel, headers: HttpHeadersMap): ReceiveChannel<MultipartEvent>
fun parseMultipart(coroutineContext: <ERROR CLASS>, input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent>
fun parseMultipart(coroutineContext: <ERROR CLASS>, boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long?): ReceiveChannel<MultipartEvent>
suspend fun parsePart(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, limit: Long = Long.MAX_VALUE): Pair<HttpHeadersMap, Long>
suspend fun parsePartBody(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, headers: HttpHeadersMap, limit: Long = Long.MAX_VALUE): Long
suspend fun parsePartHeaders(input: ByteReadChannel): HttpHeadersMap
suspend fun parsePreamble(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: BytePacketBuilder, limit: Long = Long.MAX_VALUE): Long
suspend fun parseRequest(input: ByteReadChannel): Request?
suspend fun parseResponse(input: ByteReadChannel): Response?

package io.ktor.http.cio.internals

class MutableRange

MutableRange(start: Int, end: Int)
var end: Int
var start: Int
fun toString(): String

class WeakTimeoutQueue

WeakTimeoutQueue(timeoutMillis: Long, clock: () -> Long = { System.currentTimeMillis() })
interface Registration : DisposableHandle

open fun invoke(cause: Throwable?): Unit

fun cancel(): Unit
fun process(): Unit
fun register(job: Job): Registration
val timeoutMillis: Long
suspend fun <T> withTimeout(block: suspend CoroutineScope.() -> T): T

package io.ktor.http.cio.websocket

data class CloseReason

CloseReason(code: Codes, message: String)
CloseReason(code: Short, message: String)
enum class Codes

CANNOT_ACCEPT
CLOSED_ABNORMALLY
GOING_AWAY
INTERNAL_ERROR
NORMAL
NOT_CONSISTENT
NO_EXTENSION
PROTOCOL_ERROR
SERVICE_RESTART
TOO_BIG
TRY_AGAIN_LATER
@JvmField val UNEXPECTED_CONDITION: Codes
VIOLATED_POLICY
fun byCode(code: Short): Codes?
val code: Short

val code: Short
val knownReason: Codes?
val message: String
fun toString(): String

expect fun DefaultWebSocketSession(session: WebSocketSession, pingInterval: Long, timeoutMillis: Long): DefaultWebSocketSession
expect interface DefaultWebSocketSession : WebSocketSession

abstract val closeReason: Deferred<CloseReason?>
abstract var pingIntervalMillis: Long
abstract fun start(negotiatedExtensions: List<WebSocketExtension<*>> = emptyList()): Unit
abstract var timeoutMillis: Long

class DefaultWebSocketSessionImpl : DefaultWebSocketSession, WebSocketSession

DefaultWebSocketSessionImpl(raw: WebSocketSession, pingInterval: Long = -1L, timeoutMillis: Long = 15000L, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
val closeReason: Deferred<CloseReason?>
val coroutineContext: <ERROR CLASS>
val extensions: List<WebSocketExtension<*>>
suspend fun flush(): Unit
suspend fun goingAway(message: String = "Server is going down"): Unit
val incoming: ReceiveChannel<Frame>
var masking: Boolean
var maxFrameSize: Long
val outgoing: SendChannel<Frame>
var pingIntervalMillis: Long
fun start(negotiatedExtensions: List<WebSocketExtension<*>>): Unit
fun terminate(): Unit
var timeoutMillis: Long

annotation class ExperimentalWebSocketExtensionApi

ExperimentalWebSocketExtensionApi()

sealed expect class Frame

class Binary : Frame

Binary(fin: Boolean, data: ByteArray)
Binary(fin: Boolean, packet: ByteReadPacket)
Binary(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false)
Binary(fin: Boolean, buffer: ByteBuffer)

class Close : Frame

Close(reason: CloseReason)
Close(packet: ByteReadPacket)
Close()
Close(data: ByteArray)
Close(buffer: ByteBuffer)

class Ping : Frame

Ping(packet: ByteReadPacket)
Ping(data: ByteArray)
Ping(buffer: ByteBuffer)

class Pong : Frame

Pong(packet: ByteReadPacket)
Pong(data: ByteArray, disposableHandle: DisposableHandle = NonDisposableHandle)
Pong(buffer: ByteBuffer, disposableHandle: DisposableHandle = NonDisposableHandle)
Pong(buffer: ByteBuffer)

class Text : Frame

Text(fin: Boolean, data: ByteArray)
Text(text: String)
Text(fin: Boolean, packet: ByteReadPacket)
Text(fin: Boolean, data: ByteArray, rsv1: Boolean = false, rsv2: Boolean = false, rsv3: Boolean = false)
Text(fin: Boolean, buffer: ByteBuffer)

val buffer: ByteBuffer
fun byType(fin: Boolean, frameType: FrameType, data: ByteArray): Frame
fun byType(fin: Boolean, frameType: FrameType, data: ByteArray, rsv1: Boolean, rsv2: Boolean, rsv3: Boolean): Frame
fun byType(fin: Boolean, frameType: FrameType, buffer: ByteBuffer): Frame
fun copy(): Frame
val data: ByteArray
val disposableHandle: DisposableHandle
val fin: Boolean
val frameType: FrameType
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean
open fun toString(): String

class FrameParser

FrameParser()
enum class State

BODY
HEADER0
LENGTH
MASK_KEY

fun bodyComplete(): Unit
val bodyReady: Boolean
var fin: Boolean
fun frame(bb: ByteBuffer): Unit
val frameType: FrameType
var length: Long
var mask: Boolean
var maskKey: Int?
var rsv1: Boolean
var rsv2: Boolean
var rsv3: Boolean

enum class FrameType

BINARY
CLOSE
PING
PONG
TEXT
val controlFrame: Boolean
operator fun get(opcode: Int): FrameType?
val opcode: Int

class RawWebSocket : WebSocketSession

RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long = Int.MAX_VALUE.toLong(), masking: Boolean = false, coroutineContext: <ERROR CLASS>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
val coroutineContext: <ERROR CLASS>
val extensions: List<WebSocketExtension<*>>
suspend fun flush(): Unit
val incoming: ReceiveChannel<Frame>
var masking: Boolean
var maxFrameSize: Long
val outgoing: SendChannel<Frame>
fun terminate(): Unit

class Serializer

Serializer()
fun enqueue(f: Frame): Unit
val hasOutstandingBytes: Boolean
var masking: Boolean
val remainingCapacity: Int
fun serialize(buffer: ByteBuffer): Unit

class SimpleFrameCollector

SimpleFrameCollector()
fun handle(bb: ByteBuffer): Unit
val hasRemaining: Boolean
fun start(length: Int, bb: ByteBuffer): Unit
fun take(maskKey: Int?): ByteBuffer

class WebSocketDeflateExtension : WebSocketExtension<Config>

companion object Companion : WebSocketExtensionFactory<Config, WebSocketDeflateExtension>

fun install(config: Config.() -> Unit): WebSocketDeflateExtension
val key: AttributeKey<WebSocketDeflateExtension>
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean

class Config

Config()
var clientNoContextTakeOver: Boolean
fun compressIf(block: (frame: Frame) -> Boolean): Unit
fun compressIfBiggerThan(bytes: Int): Unit
var compressionLevel: Int
fun configureProtocols(block: (protocols: MutableList<WebSocketExtensionHeader>) -> Unit): Unit
var serverNoContextTakeOver: Boolean

fun clientNegotiation(negotiatedProtocols: List<WebSocketExtensionHeader>): Boolean
val factory: WebSocketExtensionFactory<Config, out WebSocketExtension<Config>>
fun install(config: Config.() -> Unit): WebSocketDeflateExtension
val key: AttributeKey<WebSocketDeflateExtension>
fun processIncomingFrame(frame: Frame): Frame
fun processOutgoingFrame(frame: Frame): Frame
val protocols: List<WebSocketExtensionHeader>
val rsv1: Boolean
val rsv2: Boolean
val rsv3: Boolean
fun serverNegotiation(requestedProtocols: List<WebSocketExtensionHeader>): List<WebSocketExtensionHeader>

interface WebSocketExtension<ConfigType : Any>

abstract fun clientNegotiation(negotiatedProtocols: List<WebSocketExtensionHeader>): Boolean
abstract val factory: WebSocketExtensionFactory<ConfigType, out WebSocketExtension<ConfigType>>
abstract fun processIncomingFrame(frame: Frame): Frame
abstract fun processOutgoingFrame(frame: Frame): Frame
abstract val protocols: List<WebSocketExtensionHeader>
abstract fun serverNegotiation(requestedProtocols: List<WebSocketExtensionHeader>): List<WebSocketExtensionHeader>

interface WebSocketExtensionFactory<ConfigType : Any, ExtensionType : WebSocketExtension<ConfigType>>

abstract fun install(config: ConfigType.() -> Unit): ExtensionType
abstract val key: AttributeKey<ExtensionType>
abstract val rsv1: Boolean
abstract val rsv2: Boolean
abstract val rsv3: Boolean

class WebSocketExtensionHeader

WebSocketExtensionHeader(name: String, parameters: List<String>)
val name: String
val parameters: List<String>
fun parseParameters(): Sequence<Pair<String, String>>
fun toString(): String

class WebSocketExtensionsConfig

WebSocketExtensionsConfig()
fun build(): List<WebSocketExtension<*>>
fun <ConfigType : Any> install(extension: WebSocketExtensionFactory<ConfigType, *>, config: ConfigType.() -> Unit = {}): Unit

annotation class WebSocketInternalAPI

WebSocketInternalAPI()

class WebSocketReader : CoroutineScope

WebSocketReader(byteChannel: ByteReadChannel, coroutineContext: <ERROR CLASS>, maxFrameSize: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
class FrameTooBigException : Exception, CopyableThrowable<FrameTooBigException>

FrameTooBigException(frameSize: Long)
fun createCopy(): FrameTooBigException
val frameSize: Long
val message: String

val coroutineContext: <ERROR CLASS>
val incoming: ReceiveChannel<Frame>
var maxFrameSize: Long

expect interface WebSocketSession : CoroutineScope

abstract val extensions: List<WebSocketExtension<*>>
abstract suspend fun flush(): Unit
abstract val incoming: ReceiveChannel<Frame>
abstract var masking: Boolean
abstract var maxFrameSize: Long
abstract val outgoing: SendChannel<Frame>
abstract suspend fun send(frame: Frame): Unit
abstract fun terminate(): Unit

class WebSocketWriter : CoroutineScope

WebSocketWriter(writeChannel: ByteWriteChannel, coroutineContext: <ERROR CLASS>, masking: Boolean = false, pool: ObjectPool<ByteBuffer> = KtorDefaultPool)
fun close(): Unit
val coroutineContext: <ERROR CLASS>
suspend fun flush(): Unit
var masking: Boolean
val outgoing: SendChannel<Frame>
val pool: ObjectPool<ByteBuffer>
suspend fun send(frame: Frame): Unit

suspend fun WebSocketSession.close(reason: CloseReason = CloseReason(CloseReason.Codes.NORMAL, "")): Unit
suspend fun WebSocketSession.close(cause: Throwable?): Unit
suspend fun WebSocketSession.closeExceptionally(cause: Throwable): Unit
fun <T : WebSocketExtension<*>> WebSocketSession.extension(extension: WebSocketExtensionFactory<*, T>): T
fun <T : WebSocketExtension<*>> WebSocketSession.extensionOrNull(extension: WebSocketExtensionFactory<*, T>): T?
kotlinx.coroutines.CoroutineScope

fun CoroutineScope.pinger(outgoing: SendChannel<Frame>, periodMillis: Long, timeoutMillis: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Pong>
fun CoroutineScope.ponger(outgoing: SendChannel<Pong>, pool: ObjectPool<ByteBuffer> = KtorDefaultPool): SendChannel<Ping>

fun parseWebSocketExtensions(value: String): List<WebSocketExtensionHeader>
fun Frame.readBytes(): ByteArray
fun Close.readReason(): CloseReason?
@JvmName("readReason") fun Close.readReason0(): CloseReason?
fun Text.readText(): String
suspend fun DefaultWebSocketSession.run(handler: suspend DefaultWebSocketSession.() -> Unit): Unit
suspend fun WebSocketSession.send(content: String): Unit
suspend fun WebSocketSession.send(content: ByteArray): Unit
suspend fun RawWebSocket.start(handler: suspend WebSocketSession.() -> Unit): Unit

package io.ktor.server.cio.backend

class ServerIncomingConnection

ServerIncomingConnection(input: ByteReadChannel, output: ByteWriteChannel, remoteAddress: SocketAddress?)
ServerIncomingConnection(input: ByteReadChannel, output: ByteWriteChannel, remoteAddress: SocketAddress?, localAddress: SocketAddress?)
val input: ByteReadChannel
val localAddress: SocketAddress?
val output: ByteWriteChannel
val remoteAddress: SocketAddress?

class ServerRequestScope : CoroutineScope

val coroutineContext: <ERROR CLASS>
val input: ByteReadChannel
val localAddress: SocketAddress?
val output: ByteWriteChannel
val remoteAddress: SocketAddress?
val upgraded: CompletableDeferred<Boolean>?
fun withContext(coroutineContext: <ERROR CLASS>): ServerRequestScope

kotlinx.coroutines.CoroutineScope

fun CoroutineScope.startServerConnectionPipeline(connection: ServerIncomingConnection, timeout: WeakTimeoutQueue, handler: HttpRequestHandler): Job