WebSocketExtension
interface WebSocketExtension<ConfigType : Any>
WebSocket extension instance. This instance is created for each WebSocket request, for every installed extension by WebSocketExtensionFactory.
Properties
abstract val factory: WebSocketExtensionFactory<ConfigType, out WebSocketExtension<ConfigType>> Reference to the WebSocketExtensionFactory, which produced this extension. |
|
abstract 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 current extension. |
Functions
abstract fun clientNegotiation( This method is called only for a client, when it receives the WebSocket upgrade response. |
|
This method is called on each incoming frame before handling it in WebSocket session. |
|
This method is called on each outgoing frame and handle it before sending. |
|
abstract fun serverNegotiation( This method is called only for a server, when it receives websocket session. |
Inheritors
class WebSocketDeflateExtension : WebSocketExtension<Config> Compress and decompress WebSocket frames to reduce amount of transferred bytes. |