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

Package-level declarations

Types

Represents possible values for the ack header.

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

Declarations annotated with this annotation are unstable and may be changed or removed at any time without a major version bump.

HeaderNames

object HeaderNames

All STOMP header names constants.

InvalidAckHeaderException

class InvalidAckHeaderException(val invalidText: String) : Exception

An exception thrown when an unknown value of AckMode is found in an ack header.

InvalidEscapeException

class InvalidEscapeException(val invalidSequence: String, message: String = "Invalid header escape sequence '") : IllegalArgumentException

InvalidServerHeaderException

class InvalidServerHeaderException(message: String, val invalidText: String) : Exception

An exception thrown when an invalid value is found in a server header. Such values must be of the form name ["/" version] *(comment).

ServerInfo

data class ServerInfo(val name: String, val version: String?, val comments: List<String> = emptyList())

Represents information about the STOMP server.

StompAbortHeaders

interface StompAbortHeaders : StompHeaders

The headers of a StompFrame.Abort frame.

StompAbortHeadersBuilder

interface StompAbortHeadersBuilder : StompAbortHeaders, StompHeadersBuilder

A temporary mutable representation of StompAbortHeaders to ease their construction (or copy with modification).

StompAckHeaders

interface StompAckHeaders : StompHeaders

The headers of a StompFrame.Ack frame.

StompAckHeadersBuilder

interface StompAckHeadersBuilder : StompAckHeaders, StompHeadersBuilder

A temporary mutable representation of StompAckHeaders to ease their construction (or copy with modification).

StompBeginHeaders

interface StompBeginHeaders : StompHeaders

The headers of a StompFrame.Begin frame.

StompBeginHeadersBuilder

interface StompBeginHeadersBuilder : StompBeginHeaders, StompHeadersBuilder

A temporary mutable representation of StompBeginHeaders to ease their construction (or copy with modification).

StompCommitHeaders

interface StompCommitHeaders : StompHeaders

The headers of a StompFrame.Commit frame.

StompCommitHeadersBuilder

interface StompCommitHeadersBuilder : StompCommitHeaders, StompHeadersBuilder

A temporary mutable representation of StompCommitHeaders to ease their construction (or copy with modification).

StompConnectedHeaders

interface StompConnectedHeaders : StompHeaders

The headers of a StompFrame.Connected frame.

StompConnectedHeadersBuilder

interface StompConnectedHeadersBuilder : StompConnectedHeaders, StompHeadersBuilder

A temporary mutable representation of StompConnectedHeaders to ease their construction (or copy with modification).

StompConnectHeaders

interface StompConnectHeaders : StompHeaders

The headers of a StompFrame.Connect frame.

StompConnectHeadersBuilder

interface StompConnectHeadersBuilder : StompConnectHeaders, StompHeadersBuilder

A temporary mutable representation of StompConnectHeaders to ease their construction (or copy with modification).

StompDisconnectHeaders

interface StompDisconnectHeaders : StompHeaders

The headers of a StompFrame.Disconnect frame.

StompDisconnectHeadersBuilder

interface StompDisconnectHeadersBuilder : StompDisconnectHeaders, StompHeadersBuilder

A temporary mutable representation of StompDisconnectHeaders to ease their construction (or copy with modification).

StompErrorHeaders

interface StompErrorHeaders : StompHeaders

The headers of a StompFrame.Error frame.

StompErrorHeadersBuilder

interface StompErrorHeadersBuilder : StompErrorHeaders, StompHeadersBuilder

A temporary mutable representation of StompErrorHeaders to ease their construction (or copy with modification).

StompHeaders

sealed interface StompHeaders

The headers of a STOMP frame.

StompHeadersBuilder

sealed interface StompHeadersBuilder : StompHeaders

A temporary mutable representation of StompHeaders to ease their construction (or copy with modification).

StompMessageHeaders

interface StompMessageHeaders : StompHeaders

The headers of a StompFrame.Message frame.

StompMessageHeadersBuilder

interface StompMessageHeadersBuilder : StompMessageHeaders, StompHeadersBuilder

A temporary mutable representation of StompMessageHeaders to ease their construction (or copy with modification).

StompNackHeaders

interface StompNackHeaders : StompHeaders

The headers of a StompFrame.Nack frame.

StompNackHeadersBuilder

interface StompNackHeadersBuilder : StompNackHeaders, StompHeadersBuilder

A temporary mutable representation of StompNackHeaders to ease their construction (or copy with modification).

StompReceiptHeaders

sealed interface StompReceiptHeaders : StompHeaders

The headers of a StompFrame.Receipt frame.

StompReceiptHeadersBuilder

sealed interface StompReceiptHeadersBuilder : StompReceiptHeaders, StompHeadersBuilder

A temporary mutable representation of StompReceiptHeaders to ease their construction (or copy with modification).

StompSendHeaders

sealed interface StompSendHeaders : StompHeaders

The headers of a StompFrame.Send frame.

StompSendHeadersBuilder

sealed interface StompSendHeadersBuilder : StompSendHeaders, StompHeadersBuilder

A temporary mutable representation of StompSendHeaders to ease their construction (or copy with modification).

StompSubscribeHeaders

sealed interface StompSubscribeHeaders : StompHeaders

The headers of a StompFrame.Subscribe frame.

StompSubscribeHeadersBuilder

sealed interface StompSubscribeHeadersBuilder : StompSubscribeHeaders, StompHeadersBuilder

A temporary mutable representation of StompSubscribeHeaders to ease their construction (or copy with modification).

StompUnsubscribeHeaders

sealed interface StompUnsubscribeHeaders : StompHeaders

The headers of a StompFrame.Unsubscribe frame.

StompUnsubscribeHeadersBuilder

sealed interface StompUnsubscribeHeadersBuilder : StompUnsubscribeHeaders, StompHeadersBuilder

A temporary mutable representation of StompUnsubscribeHeaders to ease their construction (or copy with modification).

Functions

copy

fun StompAbortHeaders.copy(transform: StompAbortHeadersBuilder.() -> Unit = {}): StompAbortHeaders

fun StompAckHeaders.copy(transform: StompAckHeadersBuilder.() -> Unit = {}): StompAckHeaders

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

fun StompCommitHeaders.copy(transform: StompCommitHeadersBuilder.() -> Unit = {}): StompCommitHeaders

fun StompConnectHeaders.copy(transform: StompConnectHeadersBuilder.() -> Unit = {}): StompConnectHeaders

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

fun StompDisconnectHeaders.copy(transform: StompDisconnectHeadersBuilder.() -> Unit = {}): StompDisconnectHeaders

fun StompErrorHeaders.copy(transform: StompErrorHeadersBuilder.() -> Unit = {}): StompErrorHeaders

fun StompMessageHeaders.copy(transform: StompMessageHeadersBuilder.() -> Unit = {}): StompMessageHeaders

fun StompNackHeaders.copy(transform: StompNackHeadersBuilder.() -> Unit = {}): StompNackHeaders

fun StompReceiptHeaders.copy(transform: StompReceiptHeadersBuilder.() -> Unit = {}): StompReceiptHeaders

fun StompSendHeaders.copy(transform: StompSendHeadersBuilder.() -> Unit = {}): StompSendHeaders

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

fun StompUnsubscribeHeaders.copy(transform: StompUnsubscribeHeadersBuilder.() -> Unit = {}): StompUnsubscribeHeaders

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

StompAbortHeaders

fun StompAbortHeaders(transaction: String, configure: StompAbortHeadersBuilder.() -> Unit = {}): StompAbortHeaders

Creates an instance of StompAbortHeaders with the given transaction header. Extra headers can be configured using the configure lambda.

StompAckHeaders

fun StompAckHeaders(id: String, configure: StompAckHeadersBuilder.() -> Unit = {}): StompAckHeaders

Creates an instance of StompAckHeaders with the given id header. Optional headers can be configured using the configure lambda.

fun ~~StompAckHeaders~~(id: String, transaction: String? = null): StompAckHeaders

StompBeginHeaders

fun StompBeginHeaders(transaction: String, configure: StompBeginHeadersBuilder.() -> Unit = {}): StompBeginHeaders

Creates an instance of StompBeginHeaders with the given transaction header. Extra headers can be configured using the configure lambda.

StompCommitHeaders

fun StompCommitHeaders(transaction: String, configure: StompCommitHeadersBuilder.() -> Unit = {}): StompCommitHeaders

Creates an instance of StompCommitHeaders with the given transaction header. Extra headers can be configured using the configure lambda.

StompConnectedHeaders

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

Creates an instance of StompConnectedHeaders. All headers are optional and can be configured using the configure lambda.

fun ~~StompConnectedHeaders~~(version: String = "1.2", session: String? = null, server: String? = null, heartBeat: HeartBeat? = null): StompConnectedHeaders

StompConnectHeaders

fun StompConnectHeaders(host: String?, configure: StompConnectHeadersBuilder.() -> Unit = {}): StompConnectHeaders

Creates an instance of StompConnectHeaders with the given host header. Optional headers can be configured using the configure lambda.

fun ~~StompConnectHeaders~~(host: String?, acceptVersion: List<String> = StompVersion.preferredOrder.map { it.headerValue }, login: String? = null, passcode: String? = null, heartBeat: HeartBeat? = null, customHeaders: Map<String, String> = emptyMap()): StompConnectHeaders

StompDisconnectHeaders

fun StompDisconnectHeaders(configure: StompDisconnectHeadersBuilder.() -> Unit = {}): StompDisconnectHeaders

Creates an instance of StompDisconnectHeaders. Extra headers can be configured using the configure lambda.

fun ~~StompDisconnectHeaders~~(receipt: String? = null): StompDisconnectHeaders

StompErrorHeaders

fun StompErrorHeaders(configure: StompErrorHeadersBuilder.() -> Unit = {}): StompErrorHeaders

Creates an instance of StompErrorHeaders. All headers are optional and can be configured using the configure lambda.

fun ~~StompErrorHeaders~~(message: String? = null, receiptId: String? = null, customHeaders: Map<String, String> = emptyMap()): StompErrorHeaders

StompMessageHeaders

fun StompMessageHeaders(destination: String, messageId: String, subscription: String, configure: StompMessageHeadersBuilder.() -> Unit = {}): StompMessageHeaders

Creates an instance of StompMessageHeaders with the given destination, messageId, and subscription. Optional headers can be configured using the configure lambda.

fun ~~StompMessageHeaders~~(destination: String, messageId: String, subscription: String, ack: String? = null, customHeaders: Map<String, String> = emptyMap()): StompMessageHeaders

StompNackHeaders

fun StompNackHeaders(id: String, configure: StompNackHeadersBuilder.() -> Unit = {}): StompNackHeaders

Creates an instance of StompNackHeaders with the given id header. Optional headers can be configured using the configure lambda.

fun ~~StompNackHeaders~~(id: String, transaction: String? = null): StompNackHeaders

StompReceiptHeaders

fun StompReceiptHeaders(receiptId: String, configure: StompReceiptHeadersBuilder.() -> Unit = {}): StompReceiptHeaders

Creates an instance of StompReceiptHeaders with the given receiptId header. Extra headers can be configured using the configure lambda.

StompSendHeaders

fun StompSendHeaders(destination: String, configure: StompSendHeadersBuilder.() -> Unit = {}): StompSendHeaders

Creates an instance of StompSendHeaders with the given destination. Optional headers can be configured using the configure lambda.

fun ~~StompSendHeaders~~(destination: String, transaction: String? = null, receipt: String? = null, customHeaders: Map<String, String> = emptyMap()): StompSendHeaders

StompSubscribeHeaders

fun StompSubscribeHeaders(destination: String, configure: StompSubscribeHeadersBuilder.() -> Unit = {}): StompSubscribeHeaders

Creates an instance of StompSubscribeHeaders with the given destination header. Optional headers can be configured using the configure lambda.

fun ~~StompSubscribeHeaders~~(destination: String, id: String? = null, ack: AckMode = AckMode.AUTO, receipt: String? = null, customHeaders: Map<String, String> = emptyMap()): StompSubscribeHeaders

StompUnsubscribeHeaders

fun StompUnsubscribeHeaders(id: String, configure: StompUnsubscribeHeadersBuilder.() -> Unit = {}): StompUnsubscribeHeaders

Creates an instance of StompUnsubscribeHeaders with the given id header. Extra headers can be configured using the configure lambda.