Spring Framework 6.1.4 · org.springframework.messaging.simp.stomp.DefaultStompSession

Modifier and Type	Class and Description
private class	DefaultStompSession.DefaultSubscription
private class	DefaultStompSession.ReadInactivityTask
private class	DefaultStompSession.ReceiptHandler
private class	DefaultStompSession.WriteInactivityTask

Modifier and Type	Field and Description
private volatile boolean	autoReceiptEnabled
private volatile boolean	clientSideClose
private final StompHeaders	connectHeaders
private volatile TcpConnection<byte[]>	connection
private MessageConverter	converter
public static final byte[]	EMPTY_PAYLOAD An empty payload.
private static final Message<byte[]>	HEARTBEAT
private static final long	HEARTBEAT_MULTIPLIER
private static final IdGenerator	idGenerator
private static final Log	logger
private final Map<String, DefaultStompSession.ReceiptHandler>	receiptHandlers
private final AtomicInteger	receiptIndex
private long	receiptTimeLimit
private final CompletableFuture<StompSession>	sessionFuture
private final StompSessionHandler	sessionHandler
private final String	sessionId
private final AtomicInteger	subscriptionIndex
private final Map<String, DefaultStompSession.DefaultSubscription>	subscriptions
private TaskScheduler	taskScheduler
private volatile String	version

Access	Constructor and Description
public	DefaultStompSession(StompSessionHandler the application handler for the session sessionHandler, StompHeaders headers for the STOMP CONNECT frame connectHeaders) Create a new session.

Method Summary

Modifier and Type	Method and Description
public StompSession.Receiptable	acknowledge(String the id of the message messageId, boolean whether the message was consumed or not consumed) Implements org.springframework.messaging.simp.stomp.StompSession.acknowledge. Send an acknowledgement whether a message was consumed or not resulting in an ACK or NACK frame respectively.
public StompSession.Receiptable	acknowledge(StompHeaders the headers for the ACK or NACK message frame headers, boolean whether the message was consumed or not consumed) Implements org.springframework.messaging.simp.stomp.StompSession.acknowledge. An overloaded version of `acknowledge(String, boolean)` with full `StompHeaders` instead of just a `messageId`.
public void	afterConnected(TcpConnection<byte[]> the connection connection) Implements org.springframework.messaging.tcp.TcpConnectionHandler.afterConnected. Invoked after a connection is successfully established.
public void	afterConnectFailure(Throwable the exception ex) Implements org.springframework.messaging.tcp.TcpConnectionHandler.afterConnectFailure. Invoked on failure to connect.
public void	afterConnectionClosed() Implements org.springframework.messaging.tcp.TcpConnectionHandler.afterConnectionClosed. Invoked after the connection is closed.
private String	checkOrAddReceipt(StompHeaders headers)
private StompHeaderAccessor	createHeaderAccessor(StompCommand command)
private Message<byte[]>	createMessage(StompHeaderAccessor accessor, Object payload)
public void	disconnect() Implements org.springframework.messaging.simp.stomp.StompSession.disconnect. Disconnect the session by sending a DISCONNECT frame.
public void	disconnect(StompHeaders the headers for the disconnect message frame headers) Implements org.springframework.messaging.simp.stomp.StompSession.disconnect. Variant of `disconnect()` with headers.
private void	execute(Message<byte[]> message)
public StompHeaderAccessor	getConnectHeaders() Implements org.springframework.messaging.simp.stomp.StompTcpConnectionHandler.getConnectHeaders. Return the headers that will be sent in the STOMP CONNECT frame.
public MessageConverter	getMessageConverter() Return the configured `MessageConverter`.
public long	getReceiptTimeLimit() Return the configured time limit before a receipt expires.
public CompletableFuture<StompSession>	getSession() Implements org.springframework.messaging.simp.stomp.ConnectionHandlingStompSession.getSession. Return a future that will complete when the session is ready for use.
public StompSessionHandler	getSessionHandler() Return the configured session handler.
public String	getSessionId() Implements org.springframework.messaging.simp.stomp.StompSession.getSessionId, org.springframework.messaging.simp.stomp.StompTcpConnectionHandler.getSessionId. Return the id for the session.
public TaskScheduler	getTaskScheduler() Return the configured TaskScheduler to use for receipt tracking.
public void	handleFailure(Throwable the exception ex) Implements org.springframework.messaging.tcp.TcpConnectionHandler.handleFailure. Handle a failure on the connection.
public void	handleMessage(Message<byte[]> the message message) Implements org.springframework.messaging.tcp.TcpConnectionHandler.handleMessage. Handle a message received from the remote host.
private void	initHeartbeatTasks(StompHeaders connectedHeaders)
private void	invokeHandler(StompFrameHandler handler, Message<byte[]> message, StompHeaders headers)
public boolean	isAutoReceiptEnabled() Whether receipt headers should be automatically added.
public boolean	isConnected() Implements org.springframework.messaging.simp.stomp.StompSession.isConnected. Whether the session is connected.
private void	resetConnection()
public StompSession.Receiptable	send(String the destination to send a message to destination, Object the message payload payload) Implements org.springframework.messaging.simp.stomp.StompSession.send. Send a message to the specified destination, converting the payload to a `byte[]` with the help of a `MessageConverter`.
public StompSession.Receiptable	send(StompHeaders the message headers headers, Object the message payload payload) Implements org.springframework.messaging.simp.stomp.StompSession.send. An overloaded version of `send(String, Object)` with full `StompHeaders` instead of just a destination.
public void	setAutoReceipt(boolean autoReceiptEnabled) Implements org.springframework.messaging.simp.stomp.StompSession.setAutoReceipt. When enabled, a receipt header is automatically added to future `send` and `subscribe` operations on this session, which causes the server to return a RECEIPT.
public void	setMessageConverter(MessageConverter the message converter to use messageConverter) 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.
public void	setReceiptTimeLimit(long receiptTimeLimit) Configure the time in milliseconds before a receipt expires.
public void	setTaskScheduler(TaskScheduler taskScheduler) Configure the TaskScheduler to use for receipt tracking.
public StompSession.Subscription	subscribe(String the destination to subscribe to destination, StompFrameHandler the handler for received messages handler) Implements org.springframework.messaging.simp.stomp.StompSession.subscribe. Subscribe to the given destination by sending a SUBSCRIBE frame and handle received messages with the specified `StompFrameHandler`.
public StompSession.Subscription	subscribe(StompHeaders the headers for the subscribed message frame headers, StompFrameHandler the handler for received messages handler) Implements org.springframework.messaging.simp.stomp.StompSession.subscribe. An overloaded version of `subscribe(String, StompFrameHandler)` with full `StompHeaders` instead of just a destination.
private void	unsubscribe(String id, StompHeaders headers)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class DefaultStompSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary