spring-framework / org.springframework.messaging.simp.stomp / DefaultStompSession

DefaultStompSession

open class DefaultStompSession : ConnectionHandlingStompSession

Default implementation of ConnectionHandlingStompSession.

Author
Rossen Stoyanchev

Since
4.2

Constructors

<init>

DefaultStompSession(sessionHandler: StompSessionHandler, connectHeaders: StompHeaders)

Create a new session.

Properties

EMPTY_PAYLOAD

static val EMPTY_PAYLOAD: ByteArray

Functions

acknowledge	`open fun acknowledge(messageId: String, consumed: Boolean): Receiptable`
afterConnectFailure	`open fun afterConnectFailure(ex: Throwable): Unit`
afterConnected	`open fun afterConnected(connection: TcpConnection<ByteArray>): Unit`
afterConnectionClosed	`open fun afterConnectionClosed(): Unit`
disconnect	`open fun disconnect(): Unit`
getMessageConverter	`open fun getMessageConverter(): MessageConverter` Return the configured MessageConverter.
getReceiptTimeLimit	`open fun getReceiptTimeLimit(): Long` Return the configured time limit before a receipt expires.
getSessionFuture	`open fun getSessionFuture(): ListenableFuture<StompSession>`
getSessionHandler	`open fun getSessionHandler(): StompSessionHandler` Return the configured session handler.
getSessionId	`open fun getSessionId(): String`
getTaskScheduler	`open fun getTaskScheduler(): TaskScheduler` Return the configured TaskScheduler to use for receipt tracking.
handleFailure	`open fun handleFailure(ex: Throwable): Unit`
handleMessage	`open fun handleMessage(message: Message<ByteArray>): Unit`
isAutoReceiptEnabled	`open fun isAutoReceiptEnabled(): Boolean` Whether receipt headers should be automatically added.
isConnected	`open fun isConnected(): Boolean`
send	`open fun send(destination: String, payload: Any): Receiptable` `open fun send(stompHeaders: StompHeaders, payload: Any): Receiptable`
setAutoReceipt	`open fun setAutoReceipt(autoReceiptEnabled: Boolean): Unit`
setMessageConverter	`open fun setMessageConverter(messageConverter: MessageConverter): Unit` Set the MessageConverter to use to convert the payload of incoming and outgoing messages to and from `byte[]` based on object type, or expected object type, and the "content-type" header. By default, SimpleMessageConverter is configured.
setReceiptTimeLimit	`open fun setReceiptTimeLimit(receiptTimeLimit: Long): Unit` Configure the time in milliseconds before a receipt expires. By default set to 15,000 (15 seconds).
setTaskScheduler	`open fun setTaskScheduler(taskScheduler: TaskScheduler): Unit` Configure the TaskScheduler to use for receipt tracking.
subscribe	`open fun subscribe(destination: String, handler: StompFrameHandler): Subscription` `open fun subscribe(stompHeaders: StompHeaders, handler: StompFrameHandler): Subscription`