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

StompConnectHeaders

interface StompConnectHeaders : StompHeaders

The headers of a StompFrame.Connect frame.

Inheritors

Properties

abstract val acceptVersion: List<String>

A list of versions of the protocol supported by this client. By default, Krossbow sets what it supports, but this can be made more strict if desired.

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

host

abstract val host: String?

The name of the host server to connect to.

abstract val login: String?

An optional login to connect to the server.

passcode

abstract val passcode: String?

An optional passcode to connect to the server.

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 StompConnectHeaders.copy(transform: StompConnectHeadersBuilder.() -> Unit = {}): StompConnectHeaders

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.