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

abstract 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.

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.

Extensions

convertAndSend

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> 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.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.

Sources

common source