ktor-websockets/io.ktor.websocket/WebSocketDeflateExtension

WebSocketDeflateExtension

class WebSocketDeflateExtension : WebSocketExtension<WebSocketDeflateExtension.Config>

Compress and decompress WebSocket frames to reduce amount of transferred bytes.

Usage

install(WebSockets) {
    extensions {
        install(WebSocketDeflateExtension)
    }
}

Implements WebSocket deflate extension from RFC-7692. This implementation is using window size = 15 due to limitations of Deflater implementation.

Types

Companion

object Companion : WebSocketExtensionFactory<WebSocketDeflateExtension.Config, WebSocketDeflateExtension>

Config

class Config

WebSocket deflate extension configuration.

Properties

factory

open override val factory: WebSocketExtensionFactory<WebSocketDeflateExtension.Config, out WebSocketExtension<WebSocketDeflateExtension.Config>>

Reference to the WebSocketExtensionFactory, which produced this extension.

protocols

open override val protocols: List<WebSocketExtensionHeader>

List of WebSocket extension protocols which will be sent by client in headers. They are required to inform server that client wants to negotiate the current extension.

Functions

clientNegotiation

open override fun clientNegotiation(negotiatedProtocols: List<WebSocketExtensionHeader>): Boolean

This method is called only for the client, when it receives the WebSocket upgrade response.

processIncomingFrame

open override fun processIncomingFrame(frame: Frame): Frame

This method is called on each incoming frame before handling it in WebSocket session.

processOutgoingFrame

open override fun processOutgoingFrame(frame: Frame): Frame

This method is called on each outgoing frame and handle it before sending.

serverNegotiation

open override fun serverNegotiation(requestedProtocols: List<WebSocketExtensionHeader>): List<WebSocketExtensionHeader>

This method is called only for the server, when it receives WebSocket session.