krossbow-stomp-core/org.hildan.krossbow.stomp

Package org.hildan.krossbow.stomp

Types

ConnectionException

open class ConnectionException( val url: String, message: String, cause: Throwable? = null) : Exception

Exception thrown when something went wrong during the connection.

ConnectionTimeout

class ConnectionTimeout(val url: String, timeout: Duration) : ConnectionException

Exception thrown when the websocket connection + STOMP connection takes too much time.

LostReceiptException

class LostReceiptException( val receiptId: String, val configuredTimeout: Duration, val frame: StompFrame) : Exception

An exception thrown when a RECEIPT frame was expected from the server, but not received in the configured time limit.

MissingHeartBeatException

class MissingHeartBeatException(val expectedPeriod: Duration) : Exception

An exception thrown when expected heart beats are not received.

StompClient

class StompClient(webSocketClient: WebSocketClient, config: StompConfig)

A STOMP 1.2 client based on web sockets. A custom web socket implementation can be passed in as a constructor parameter.

StompConnectionException

class StompConnectionException(val host: String?, cause: Throwable? = null) : ConnectionException

Exception thrown when the connection attempt failed at STOMP protocol level.

StompErrorFrameReceived

class StompErrorFrameReceived(val frame: StompFrame.Error) : Exception

An exception thrown when a STOMP ERROR frame is received. It is usually thrown through subscription channels.

StompReceipt

data class StompReceipt(val id: String)

A STOMP receipt, as defined in the STOMP specification.

StompSession

interface StompSession

A coroutine-based STOMP session. This interface defines interactions with a STOMP server.

WebSocketClosedUnexpectedly

class WebSocketClosedUnexpectedly(val code: Int, val reason: String?) : Exception

An exception thrown when the underlying websocket connection was closed at an inappropriate time.

WebSocketConnectionException

open class WebSocketConnectionException( val url: String, message: String = "Failed to connect at web socket level to ", cause: Throwable? = null) : ConnectionException

Exception thrown when the connection attempt failed at web socket level.

Functions

sendBinary

suspend fun StompSession.sendBinary(destination: String, body: ByteArray?): StompReceipt?

Sends a SEND frame to the server at the given destination with the given binary body.

sendEmptyMsg

suspend fun StompSession.sendEmptyMsg(destination: String): StompReceipt?

Sends a SEND frame to the server at the given destination without body.

sendText

suspend fun StompSession.sendText(destination: String, body: String?): StompReceipt?

Sends a SEND frame to the server at the given destination with the given textual body.

stomp

suspend fun WebSocketConnection.stomp( config: StompConfig, host: String? = this.host, login: String? = null, passcode: String? = null, customHeaders: Map<String, String> = emptyMap(), sessionCoroutineContext: CoroutineContext = EmptyCoroutineContext): StompSession

Establishes a STOMP session over an existing WebSocketConnection.

suspend fun StompSession.subscribe(destination: String): Flow<StompFrame.Message>

Subscribes and returns a Flow of MESSAGE frames that unsubscribes automatically when the collector is done or cancelled. The returned flow can be collected only once.

subscribeBinary

suspend fun StompSession.subscribeBinary(destination: String): Flow<ByteArray>

Subscribes and returns a Flow of binary message bodies that unsubscribes automatically when the collector is done or cancelled. The returned flow can be collected only once.

subscribeText

suspend fun StompSession.subscribeText(destination: String): Flow<String>

Subscribes and returns a Flow of text message bodies that unsubscribes automatically when the collector is done or cancelled. The returned flow can be collected only once.

use

inline suspend fun <S : StompSession, R> S.use(block: (S) -> R): R

Executes the given block on this StompSession, and disconnects from the session whether the block terminated normally or exceptionally.

withTransaction

suspend fun <T> StompSession.withTransaction(block: suspend StompSession.(transactionId: String) -> T): T

Executes the given block as part of a transaction.