io.ktor.http.cio.websocket -

Package io.ktor.http.cio.websocket

Types

CloseReason	`data class CloseReason` Websocket close reason
DefaultWebSocketSession	`expect interface DefaultWebSocketSession : WebSocketSession` Default websocket session with ping-pong and timeout processing and built-in closeReason population
DefaultWebSocketSessionImpl	`class DefaultWebSocketSessionImpl : DefaultWebSocketSession, WebSocketSession` Default web socket session implementation that handles ping-pongs, close sequence and frame fragmentation
Frame	`sealed expect class Frame` A frame received or ready to be sent. It is not reusable and not thread-safe
FrameParser	`class FrameParser`
FrameType	`enum class FrameType` Frame types enum
RawWebSocket	`class RawWebSocket : WebSocketSession` Represents a RAW web socket session
Serializer	`class Serializer`
SimpleFrameCollector	`class SimpleFrameCollector`
WebSocketDeflateExtension	`class WebSocketDeflateExtension : WebSocketExtension<Config>` Compress and decompress WebSocket frames to reduce amount of transferred bytes.
WebSocketExtension	`interface WebSocketExtension<ConfigType : Any>` WebSocket extension instance. This instance is created for each WebSocket request, for every installed extension by WebSocketExtensionFactory.
WebSocketExtensionFactory	`interface WebSocketExtensionFactory<ConfigType : Any, ExtensionType : WebSocketExtension<ConfigType>>` Factory that defines WebSocket extension. The factory is used in pair with WebSocketExtensionsConfig.install method to install WebSocket extension in client or server.
WebSocketExtensionHeader	`class WebSocketExtensionHeader` Parsed `Sec-WebSocket-Accept` header item representation.
WebSocketExtensionsConfig	`class WebSocketExtensionsConfig` Extensions configuration for WebSocket client and server features.
WebSocketReader	`class WebSocketReader : CoroutineScope` Class that continuously reads a byteChannel and converts into Websocket Frame exposing them in incoming.
WebSocketSession	`expect interface WebSocketSession : CoroutineScope` Represents a web socket session between two peers
WebSocketWriter	`class WebSocketWriter : CoroutineScope` Class that processes written outgoing Websocket Frame, serializes them and writes the bits into the writeChannel.

Annotations

ExperimentalWebSocketExtensionApi	`annotation class ExperimentalWebSocketExtensionApi` WebSocket extensions API is experimental according to KTOR-688 To get more information about Ktor experimental guarantees consult with KTOR-1035.
WebSocketInternalAPI	`annotation class WebSocketInternalAPI` API marked with this annotation is internal and not intended to be used outside of ktor It is not recommended to use it as it may be changed in the future without notice or it may be too low-level so could damage your data.

Extensions for External Classes

kotlinx.coroutines.CoroutineScope

Properties

pingInterval	`var DefaultWebSocketServerSession.pingInterval: Duration?` Ping interval or `null` to disable pinger. Please note that pongs will be handled despite of this setting. `val WebSockets.pingInterval: Duration?`
pingPeriod	`var WebSocketOptions.pingPeriod: Duration?`
timeout	`var DefaultWebSocketServerSession.timeout: Duration` A timeout to wait for pong reply to ping otherwise the session will be terminated immediately. It doesn’t have any effect if pingInterval is `null` (pinger is disabled). `val WebSockets.timeout: Duration` `var WebSocketOptions.timeout: Duration`

Functions

DefaultWebSocketSession	`expect fun DefaultWebSocketSession( session: WebSocketSession, pingInterval: Long, timeoutMillis: Long ): DefaultWebSocketSession` Create DefaultWebSocketSession from session.
WebSockets	`fun WebSockets( pingInterval: Duration?, timeout: Duration, maxFrameSize: Long, masking: Boolean ): WebSockets`
close	`suspend fun WebSocketSession.close( reason: CloseReason = CloseReason(CloseReason.Codes.NORMAL, "") ): Unit` Send a close frame with the specified reason. May suspend if outgoing channel is full. The specified reason could be ignored if there was already close frame sent (for example in reply to a peer close frame). It also may do nothing when a session or an outgoing channel is already closed due to any reason. `suspend fun WebSocketSession.close(cause: Throwable?): Unit` Closes with reason depending on cause or normally if cause is `null`. This is going to be removed. Close with a particular reason or terminate instead.
closeExceptionally	`suspend fun WebSocketSession.closeExceptionally( cause: Throwable ): Unit` Closes session with normal or error close reason, depending on whether cause is cancellation or not.
extension	`fun <T : WebSocketExtension<>> WebSocketSession.extension( extension: WebSocketExtensionFactory<, T> ): T` Find the extensions using WebSocketExtensionFactory.
extensionOrNull	`fun <T : WebSocketExtension<>> WebSocketSession.extensionOrNull( extension: WebSocketExtensionFactory<, T> ): T?` Search the extensions using WebSocketExtensionFactory.
parseWebSocketExtensions	`fun parseWebSocketExtensions( value: String ): List<WebSocketExtensionHeader>` Parse `Sec-WebSocket-Accept` header.
readBytes	`fun Frame.readBytes(): ByteArray` Read binary content from a frame. For fragmented frames only returns this fragment.
readReason	`fun Close.readReason(): CloseReason?` Read close reason from close frame or null if no close reason provided
readReason0	`fun Close.readReason0(): CloseReason?`
readText	`fun Text.readText(): String` Read text content from text frame. Shouldn’t be used for fragmented frames: such frames need to be reassembled first
run	`suspend fun DefaultWebSocketSession.run( handler: suspend DefaultWebSocketSession.() -> Unit ): Unit`
send	`suspend fun WebSocketSession.send(content: String): Unit` Enqueues a text frame for sending with the specified content. `suspend fun WebSocketSession.send(content: ByteArray): Unit` Enqueues a final binary frame for sending with the specified content.
start	`suspend fun RawWebSocket.start( handler: suspend WebSocketSession.() -> Unit ): Unit`