A factory that defines a WebSocket extension. The factory is used in pair with the WebSocketExtensionsConfig.install method to install the WebSocket extension in client or server.

WebSocketExtensionHeader

class WebSocketExtensionHeader(val name: String, val parameters: List<String>)

A parsed Sec-WebSocket-Accept header item representation.

WebSocketExtensionsConfig

class WebSocketExtensionsConfig

Extensions configuration for the WebSocket client and server plugins.

WebSocketReader

class WebSocketReader(byteChannel: ByteReadChannel, val coroutineContext: CoroutineContext, var maxFrameSize: Long, pool: ObjectPool<ByteBuffer> = KtorDefaultPool) : CoroutineScope

Class that continuously reads a byteChannel and converts into Websocket Frame exposing them in incoming.

WebSocketSession

interface WebSocketSession : CoroutineScope

A WebSocket session between two peers.

WebSocketWriter

class WebSocketWriter(writeChannel: ByteWriteChannel, val coroutineContext: CoroutineContext, var masking: Boolean = false, val pool: ObjectPool<ByteBuffer> = KtorDefaultPool) : CoroutineScope

Class that processes written outgoing Websocket Frame, serializes them and writes the bits into the writeChannel.

Functions

suspend fun WebSocketSession.close(reason: CloseReason = CloseReason(CloseReason.Codes.NORMAL, ""))

Sends a close frame with the specified reason. May suspend if the 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?)

Closes with the reason depending on cause or normally if the cause is null.

closeExceptionally

suspend fun WebSocketSession.closeExceptionally(cause: Throwable)

Closes a session with normal or error close reason, depending on whether cause is cancellation or not.

DefaultWebSocketSession

fun DefaultWebSocketSession(session: WebSocketSession, pingInterval: Long = -1L, timeoutMillis: Long = 15000): DefaultWebSocketSession

Creates DefaultWebSocketSession from a session.

extension

fun <T : WebSocketExtension<*>> WebSocketSession.extension(extension: WebSocketExtensionFactory<*, T>): T

Finds the extensions using WebSocketExtensionFactory.

extensionOrNull

fun <T : WebSocketExtension<*>> WebSocketSession.extensionOrNull(extension: WebSocketExtensionFactory<*, T>): T?

Searches the extensions using WebSocketExtensionFactory.

parseWebSocketExtensions

fun parseWebSocketExtensions(value: String): List<WebSocketExtensionHeader>

Parses the Sec-WebSocket-Accept header.

RawWebSocket

expect fun RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long = Int.MAX_VALUE.toLong(), masking: Boolean = false, coroutineContext: CoroutineContext): WebSocketSession

Creates a RAW web socket session from connection.

actual fun RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long, masking: Boolean, coroutineContext: CoroutineContext): WebSocketSession

Creates a RAW web socket session from connection

actual fun RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long, masking: Boolean, coroutineContext: CoroutineContext): WebSocketSession

Creates a RAW web socket session from connection

actual fun RawWebSocket(input: ByteReadChannel, output: ByteWriteChannel, maxFrameSize: Long, masking: Boolean, coroutineContext: CoroutineContext): WebSocketSession

Creates a RAW web socket session from connection

readBytes

fun Frame.readBytes(): ByteArray

Reads binary content from the frame. For fragmented frames only returns this fragment.

readFrame

suspend fun ByteReadChannel.readFrame(maxFrameSize: Long, lastOpcode: Int): Frame

Reads bits from ByteReadChannel and converts into a WebSocket Frame.

readReason

fun Frame.Close.readReason(): CloseReason?

Reads the close reason from the close frame or null if no close reason is provided.

readText

fun Frame.Text.readText(): String

Reads text content from the text frame. Shouldn't be used for fragmented frames: such frames need to be reassembled first.

send

suspend fun WebSocketSession.send(content: ByteArray)

Enqueues a final binary frame for sending with the specified content.

suspend fun WebSocketSession.send(content: String)

Enqueues a text frame for sending with the specified content.

writeFrame

suspend fun ByteWriteChannel.writeFrame(frame: Frame, masking: Boolean)

Serializes WebSocket Frame and writes the bits into the ByteWriteChannel. If masking is true, then data will be masked with random mask