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

StompBeginHeaders

interface StompBeginHeaders : StompHeaders

The headers of a StompFrame.Begin frame.

Inheritors

StompBeginHeadersBuilder

Properties

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.

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.

transaction

abstract val transaction: String

The ID to define for the new transaction that we begin.

Functions

asMap

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

Returns a Map view of these headers.

copy

fun StompBeginHeaders.copy(transform: StompBeginHeadersBuilder.() -> Unit = {}): StompBeginHeaders

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.