Package org.springframework.messaging.simp.stomp

Interface ConnectionHandlingStompSession

All Superinterfaces:

StompSession, StompTcpConnectionHandler<byte[]>, TcpConnectionHandler<byte[]>

All Known Implementing Classes:

DefaultStompSession

public interface ConnectionHandlingStompSession
extends StompSession, StompTcpConnectionHandler<byte[]>

A StompSession that implements TcpConnectionHandler in order to send and receive messages.

A ConnectionHandlingStompSession can be used with any TCP or WebSocket library that is adapted to the TcpConnectionHandler contract.

Since:

4.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.messaging.simp.stomp.StompSession

StompSession.Receiptable, StompSession.Subscription

Method Summary

Modifier and Type	Method	Description
CompletableFuture<StompSession>	getSession()	Return a future that will complete when the session is ready for use.
default ListenableFuture<StompSession>	getSessionFuture()	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.0, in favor of getSession()

Methods inherited from interface org.springframework.messaging.simp.stomp.StompSession

acknowledge, acknowledge, disconnect, disconnect, getSessionId, isConnected, send, send, setAutoReceipt, subscribe, subscribe

Methods inherited from interface org.springframework.messaging.simp.stomp.StompTcpConnectionHandler

getConnectHeaders, getSessionId

Methods inherited from interface org.springframework.messaging.tcp.TcpConnectionHandler

afterConnected, afterConnectFailure, afterConnectionClosed, handleFailure, handleMessage

Method Details

getSessionFuture

@Deprecated(since="6.0",
            forRemoval=true)
default ListenableFuture<StompSession> getSessionFuture()

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.0, in favor of getSession()

Return a future that will complete when the session is ready for use.

getSession

CompletableFuture<StompSession> getSession()

Return a future that will complete when the session is ready for use.

Since:

6.0