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

Package org.hildan.krossbow.stomp.conversions

Types

KTypeRef

class KTypeRef<T>

Wraps a KType instance with a generic type parameter, to ensure type-safe usages.

StompSessionWithClassConversions

~~interface~~ ~~StompSessionWithClassConversions~~ : ~~StompSession~~

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

TextMessageConverter

~~interface~~ ~~TextMessageConverter~~

Converts between text and objects based on a KClass.

TypedStompSession

interface TypedStompSession : StompSession

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

Functions

convertAndSend

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

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

~~suspend~~ ~~fun~~ <T : Any> StompSessionWithClassConversions.~~convertAndSend~~( destination: String, body: T? = null, bodyType: KClass<T>): StompReceipt?

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

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

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.

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

suspend fun <T : Any> StompSessionWithClassConversions.subscribe(destination: String, clazz: KClass<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> 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.

subscribeOptional

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

suspend fun <T : Any> StompSessionWithClassConversions.subscribeOptional(destination: String, clazz: KClass<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.

typeRefOf

inline fun <T> typeRefOf(): KTypeRef<T>

Creates a KTypeRef representing the given type T.

withTextConversions

~~fun~~ StompSession.~~withTextConversions~~(converter: TextMessageConverter): StompSessionWithClassConversions

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