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

TypedStompSession

interface TypedStompSession : StompSession(source)

A StompSession with additional methods to serialize/deserialize message bodies based on a KClass.

Functions

abort

open suspend fun abort(transactionId: String)

Sends an ABORT frame with the given transactionId.

ack

open suspend fun ack(ackId: String, transactionId: String? = null)

Sends an ACK frame with the given ackId.

begin

open suspend fun begin(transactionId: String)

Sends a BEGIN frame with the given transactionId.

commit

open suspend fun commit(transactionId: String)

Sends a COMMIT frame with the given transactionId.

convertAndSend

abstract suspend fun <T> convertAndSend(headers: StompSendHeaders, body: T, bodyType: KTypeRef<T>): StompReceipt?

Sends a SEND frame to the server with the given headers and the given body, converted appropriately based on bodyType.

convertAndSend

inline suspend fun <T> TypedStompSession.convertAndSend(destination: String, body: T): StompReceipt?

Sends a SEND frame to the server at the given destination with the given body, converted appropriately.

inline suspend fun <T> TypedStompSession.convertAndSend(headers: StompSendHeaders, body: T): StompReceipt?

Sends a SEND frame to the server with the given headers and body, converted appropriately.

disconnect

abstract suspend fun disconnect()

If graceful disconnect is enabled (which is the default), sends a DISCONNECT frame to close the session, waits for the relevant RECEIPT frame, and then closes the connection. Otherwise, force-closes the connection.

nack

open suspend fun nack(ackId: String, transactionId: String? = null)

Sends a NACK frame with the given ackId.

send

abstract suspend fun send(headers: StompSendHeaders, body: FrameBody?): StompReceipt?

Sends a SEND frame to the server with the given headers and the given body.

sendBinary

suspend fun StompSession.sendBinary(destination: String, body: ByteString?): 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.

sendRawFrameAndMaybeAwaitReceipt

abstract suspend fun sendRawFrameAndMaybeAwaitReceipt(frame: StompFrame): StompReceipt?

Sends the given frame as-is, without modifications to its headers, regardless of the configuration.

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.

abstract suspend fun subscribe(headers: StompSubscribeHeaders): 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.

abstract suspend fun <T> subscribe(headers: StompSubscribeHeaders, type: KTypeRef<T>): Flow<T>

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

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.

inline suspend fun <T> TypedStompSession.subscribe(destination: String): Flow<T>

Subscribes to the given destination and returns a Flow of messages of type T 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<ByteString>

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.

withTextConversions

fun StompSession.withTextConversions(converter: TextMessageConverter): TypedStompSession

Wraps this StompSession to add methods that can convert message bodies using the provided converter.

withTransaction

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

Executes the given block as part of a transaction.