krossbow-websocket-core/org.hildan.krossbow.websocket

Package-level declarations

Types

An adapter similar to WebSocketListenerFlowAdapter, but with an unlimited buffer and non-suspending callback functions. This is useful for bridging implementations that do not support backpressure (like the browser WebSocket API).

WebSocketClient

interface WebSocketClient

A web socket client.

WebSocketCloseCodes

object WebSocketCloseCodes

Web socket close codes as defined in the WebSocket Protocol specification.

WebSocketConnection

interface WebSocketConnection

Represents a web socket connection to another endpoint.

WebSocketConnectionClosedException

class WebSocketConnectionClosedException(val url: String, val code: Int, val reason: String?) : WebSocketConnectionException

An exception thrown when the server closed the connection unexpectedly during the handshake.

WebSocketConnectionException

open class WebSocketConnectionException(val url: String, val httpStatusCode: Int? = null, val additionalInfo: String? = null, message: String = defaultMessage(url, httpStatusCode, additionalInfo), cause: Throwable? = null) : WebSocketException

An exception thrown when something went wrong during the web socket connection.

WebSocketConnectionWithPing

interface WebSocketConnectionWithPing : WebSocketConnection

WebSocketConnectionWithPingPong

interface WebSocketConnectionWithPingPong : WebSocketConnectionWithPing

WebSocketException

open class WebSocketException(message: String, cause: Throwable? = null) : Exception

An exception thrown when something went wrong at web socket level.

WebSocketFrame

sealed class WebSocketFrame

A web socket frame.

WebSocketListenerFlowAdapter

class WebSocketListenerFlowAdapter(bufferSize: Int = Channel.BUFFERED, onBufferOverflow: BufferOverflow = BufferOverflow.SUSPEND)

Adapter between listener calls and a web socket "incoming" frames flow. This is to make it easier to bridge listener-based APIs with the flow-based API of Krossbow. Methods of this listener never fail, but can send failure through the frames channel to the consumers.

Properties

CLOSE_REASON_MAX_LENGTH_BYTES

const val CLOSE_REASON_MAX_LENGTH_BYTES: Int = 123

The maximum number of UTF-8 bytes allowed by the web socket protocol for the "reason" in close frames. This limit is defined in section 5.5 of the RFC-6455.

Functions

truncateToCloseFrameReasonLength

fun String.truncateToCloseFrameReasonLength(): String

Truncates this string to 123 bytes (CLOSE_REASON_MAX_LENGTH_BYTES), for it to be suitable as web socket close reason.

truncateUtf8BytesLengthTo

fun String.truncateUtf8BytesLengthTo(maxLength: Int): String

Returns the biggest prefix of this string that can be represented with at most maxLength UTF-8 bytes.