krossbow-stomp-kxserialization/org.hildan.krossbow.stomp.conversions.kxserialization/StompSessionWithKxSerialization

StompSessionWithKxSerialization

interface StompSessionWithKxSerialization : StompSession(source)

A StompSession with additional methods to serialize/deserialize message bodies using Kotlinx Serialization.

Properties

serializersModule

abstract val serializersModule: SerializersModule

The Kotlinx Serialization's SerializersModule used to provide serializers at runtime.

Functions

abort

abstract suspend fun abort(transactionId: String)

ack

abstract suspend fun ack(ackId: String, transactionId: String?)

begin

abstract suspend fun begin(transactionId: String)

commit

abstract suspend fun commit(transactionId: String)

convertAndSend

abstract suspend fun <T : Any> convertAndSend(headers: StompSendHeaders, body: T? = null, serializer: SerializationStrategy<T>): StompReceipt?

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

convertAndSend

inline suspend fun <T : Any> StompSessionWithKxSerialization.convertAndSend(destination: String, body: T? = null): StompReceipt?

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

inline suspend fun <T : Any> StompSessionWithKxSerialization.convertAndSend(headers: StompSendHeaders, body: T? = null): StompReceipt?

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

suspend fun <T : Any> StompSessionWithKxSerialization.convertAndSend(destination: String, body: T? = null, serializer: SerializationStrategy<T>): StompReceipt?

Sends a SEND frame to the given destination with the given body, converted appropriately using the provided serializer.

disconnect

abstract suspend fun disconnect()

nack

abstract suspend fun nack(ackId: String, transactionId: String?)

send

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

abstract suspend fun subscribe(headers: StompSubscribeHeaders): Flow<StompFrame.Message>

abstract suspend fun <T : Any> subscribe(headers: StompSubscribeHeaders, deserializer: DeserializationStrategy<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.

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

suspend fun <T : Any> StompSessionWithKxSerialization.subscribe(destination: String, deserializer: DeserializationStrategy<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.

subscribeOptional

abstract suspend fun <T : Any> subscribeOptional(headers: StompSubscribeHeaders, deserializer: DeserializationStrategy<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.

subscribeOptional

inline suspend fun <T : Any> StompSessionWithKxSerialization.subscribeOptional(destination: String): Flow<T?>

suspend fun <T : Any> StompSessionWithKxSerialization.subscribeOptional(destination: String, deserializer: DeserializationStrategy<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.

withBinaryConversions

fun StompSession.withBinaryConversions(format: BinaryFormat, mediaType: String): StompSessionWithKxSerialization

Wraps this StompSession to add methods that can convert message bodies using the provided Kotlinx Serialization's BinaryFormat.

withTextConversions

fun StompSession.withTextConversions(format: StringFormat, mediaType: String): StompSessionWithKxSerialization

Wraps this StompSession to add methods that can convert message bodies using the provided Kotlinx Serialization's StringFormat.