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.

Constructors

WebSocketListenerFlowAdapter

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

Properties

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(bytes: ByteArray, isLast: Boolean = true)

Callback for binary messages (potentially partial frames).

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

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

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.

suspend fun onPing(bytes: ByteArray)

Sends a WebSocketFrame.Ping frame to the incomingFrames flow.

suspend fun onPong(bytes: ByteArray)

Sends a WebSocketFrame.Pong frame to the incomingFrames flow.

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

Callback for text messages (potentially partial frames).