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

StompSubscribeHeaders

sealed interface StompSubscribeHeaders : StompHeaders

The headers of a StompFrame.Subscribe frame.

Inheritors

StompSubscribeHeadersBuilder

Properties

ack

abstract val ack: AckMode

The acknowledgment mode for messages in this subscription. Defaults to AckMode.AUTO.

contentLength

abstract val contentLength: Int?

This header is an octet count for the length of the message body.

contentType

abstract val contentType: String?

If this header is set, its value MUST be a MIME type that describes the format of the body. Otherwise, the receiver SHOULD consider the body to be a binary blob.

destination

abstract val destination: String

The destination to subscribe to.

abstract val id: String

The ID to define for this new subscription.

receipt

abstract val receipt: String?

Any client frame other than CONNECT MAY specify a receipt header with an arbitrary value. This will cause the server to acknowledge the processing of the client frame with a RECEIPT frame.

Functions

asMap

abstract fun asMap(): Map<String, String>

Returns a Map view of these headers.

copy

fun StompSubscribeHeaders.copy(transform: StompSubscribeHeadersBuilder.() -> Unit = {}): StompSubscribeHeaders

Creates a copy of these headers with the given transform applied.

get

abstract operator fun get(headerName: String): String?

Gets the header with the given headerName, or null if it's not present. Usually, headers should be accessed via type-safe properties, but this is useful to access custom headers.