krossbow-stomp-core/org.hildan.krossbow.stomp.config/StompConfig

StompConfig

class StompConfig(source)

Configuration for the STOMP client.

Constructors

StompConfig

constructor()

Properties

autoContentLength

var autoContentLength: Boolean

Whether to automatically compute and add the content-length header in sent frames.

autoReceipt

var autoReceipt: Boolean

Whether to automatically attach a receipt header to the sent frames in order to track receipts.

connectionTimeout

var connectionTimeout: Duration

Defines how long to wait for the websocket+STOMP connection to be established before throwing an exception.

connectWithStompCommand

var connectWithStompCommand: Boolean

Whether to use the STOMP command instead of CONNECT to establish the connection.

defaultSessionCoroutineContext

var defaultSessionCoroutineContext: CoroutineContext

An additional coroutine context used for the collection and decoding of the STOMP frames within StompSessions created by this client.

disconnectTimeout

var disconnectTimeout: Duration

Like receiptTimeout but only for the receipt of the DISCONNECT frame. This is ignored if gracefulDisconnect is disabled.

failOnStompVersionMismatch

var failOnStompVersionMismatch: Boolean

Whether the connection fails if the version of the STOMP protocol is negotiated to different values at the web socket handshake level (via subprotocol), and at STOMP level (in the CONNECT/CONNECTED frames).

gracefulDisconnect

var gracefulDisconnect: Boolean

Enables graceful disconnect.

heartBeat

var heartBeat: HeartBeat

The HeartBeat to request for the STOMP sessions.

heartBeatTolerance

var heartBeatTolerance: HeartBeatTolerance

Defines tolerance for heart beats.

instrumentation

var instrumentation: KrossbowInstrumentation?

A set of hooks that are called in different places of the internal execution of Krossbow. The instrumentation can be used for monitoring, logging or debugging purposes.

receiptTimeout

var receiptTimeout: Duration

Defines how long to wait for a RECEIPT frame from the server before throwing a LostReceiptException. Only crashes when a receipt header was actually present in the sent frame (and thus a RECEIPT was expected). Such header is always present if autoReceipt is enabled.

subscriptionCompletionTimeout

var subscriptionCompletionTimeout: Duration

When the session is disconnected or when an error occurs, subscription flows complete or throw an exception. This timeout defines how long the STOMP session will wait for subscribers to reach this completion/error before cancelling them along with internal coroutines.