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

WebSocketListenerFlowAdapter

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

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.

Note: this class is not thread-safe. The callbacks must not be called concurrently.

Constructors

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

Properties

incomingFrames

val incomingFrames: Flow<WebSocketFrame>

The flow of incoming web socket frames. This flow completes when the web socket connection is closed or an error occurs.

Functions

onBinaryMessage

suspend fun onBinaryMessage(isLast: Boolean = true, writeData: Sink.() -> Unit)

suspend fun onBinaryMessage(bytes: ByteString, isLast: Boolean = true)

Callback for binary messages (potentially partial frames).

onClose

suspend fun onClose(code: Int, reason: String?)

Sends a WebSocketFrame.Close to the incomingFrames flow, and completes it normally.

onError

fun onError(message: String)

Fails the incomingFrames flow with a WebSocketException with the given message.

fun onError(error: Throwable?)

Fails the incomingFrames flow with a WebSocketException with the given error as cause.

onPing

suspend fun onPing(bytes: ByteString)

Sends a WebSocketFrame.Ping frame with the given bytes to the incomingFrames flow.

onPong

suspend fun onPong(bytes: ByteString)

Sends a WebSocketFrame.Pong frame with the given bytes to the incomingFrames flow.

onTextMessage

suspend fun onTextMessage(isLast: Boolean = true, writeData: Sink.() -> Unit)

suspend fun onTextMessage(text: String, isLast: Boolean = true)

Callback for text messages (potentially partial frames).