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

StompConnectedHeaders

interface StompConnectedHeaders : StompHeaders

The headers of a StompFrame.Connected frame.

Inheritors

StompConnectedHeadersBuilder

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.

heartBeat

abstract val heartBeat: HeartBeat?

The heart-beating settings desired by the server (the effective heartbeats are the result of a negotiation).

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.

server

abstract val server: ServerInfo?

Information about the STOMP server.

session

abstract val session: String?

A session identifier that uniquely identifies the session.

version

abstract val version: String

The version of the STOMP protocol the session will be using.

Functions

asMap

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

Returns a Map view of these headers.

copy

fun StompConnectedHeaders.copy(transform: StompConnectedHeadersBuilder.() -> Unit = {}): StompConnectedHeaders

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.