Package-level declarations
Types
A WebSocket close reason.
A default WebSocket session with ping-pong and timeout processing and built-in closeReason population.
A frame received or ready to be sent. It is not reusable and not thread-safe.
A frame received or ready to be sent. It is not reusable and not thread-safe
A frame received or ready to be sent. It is not reusable and not thread-safe
A frame received or ready to be sent. It is not reusable and not thread-safe
Raised when the frame is bigger than allowed in a current WebSocket session.
Raised when peers send frames which violate the Websocket RFC
Compress and decompress WebSocket frames to reduce amount of transferred bytes.
A WebSocket extension instance. This instance is created for each WebSocket request, for every installed extension by 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.
A parsed Sec-WebSocket-Accept header item representation.
Extensions configuration for the WebSocket client and server plugins.
Class that continuously reads a byteChannel and converts into Websocket Frame exposing them in incoming.
A WebSocket session between two peers.
Class that processes written outgoing Websocket Frame, serializes them and writes the bits into the writeChannel.
Properties
Ping interval meaning pinger is disabled.
Ping interval or null to disable pinger. Note that pongs will be handled despite this setting.
A timeout to wait for pong reply to ping, otherwise the session will be terminated immediately. It doesn't have any effect if pingInterval is null (pinger is disabled).
Functions
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.
Closes a session with normal or error close reason, depending on whether cause is cancellation or not.
Creates DefaultWebSocketSession from a session.
Finds the extensions using WebSocketExtensionFactory.
Searches the extensions using WebSocketExtensionFactory.
Parses the Sec-WebSocket-Accept header.
Creates a RAW web socket session from connection.
Creates a RAW web socket session from connection
Creates a RAW web socket session from connection
Creates a RAW web socket session from connection
Reads bits from ByteReadChannel and converts into a WebSocket Frame.
Reads the close reason from the close frame or null if no close reason is provided.
Reads text content from the text frame. Shouldn't be used for fragmented frames: such frames need to be reassembled first.
Serializes WebSocket Frame and writes the bits into the ByteWriteChannel. If masking is true, then data will be masked with random mask