WebSocketExtensionFactory

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

Properties

Link copied to clipboard

A key used to locate an extension.

Link copied to clipboard
abstract val rsv1: Boolean

The first extension bit used by the current extension.

Link copied to clipboard
abstract val rsv2: Boolean

A second extension bit used by the current extension.

Link copied to clipboard
abstract val rsv3: Boolean

A third extension bit used by the current extension.

Functions

Link copied to clipboard
abstract fun install(config: ConfigType.() -> Unit): ExtensionType

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