ktor-websockets/io.ktor.websocket/WebSocketExtensionFactory

WebSocketExtensionFactory

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

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.

Usually this interface is implemented in companion object of the origin WebSocketExtension.

Inheritors

Companion

Properties

key

abstract val key: AttributeKey<ExtensionType>

A key used to locate an extension.

rsv1

abstract val rsv1: Boolean

The first extension bit used by the current extension.

rsv2

abstract val rsv2: Boolean

A second extension bit used by the current extension.

rsv3

abstract val rsv3: Boolean

A third extension bit used by the current extension.

Functions

install

abstract fun install(config: ConfigType.() -> Unit): ExtensionType

Creates an extension instance using config block. The extension instance is created for each WebSocket request.