Uses of Class
org.springframework.messaging.simp.stomp.StompHeaders
Package
Description
Generic support for simple messaging protocols (like STOMP).
WebSocket integration for Spring's messaging module.
-
Uses of StompHeaders in org.springframework.messaging.simp.stomp
Modifier and TypeMethodDescriptionStompSession.Subscription.getSubscriptionHeaders()
Return the headers used on the SUBSCRIBE frame.protected StompHeaders
StompClientSupport.processConnectHeaders
(StompHeaders connectHeaders) Further initialize the StompHeaders, for example setting the heart-beat header if necessary.static StompHeaders
StompHeaders.readOnlyStompHeaders
(Map<String, List<String>> headers) Return aStompHeaders
object that can only be read, not written to.Modifier and TypeMethodDescriptionDefaultStompSession.acknowledge
(StompHeaders headers, boolean consumed) StompSession.acknowledge
(StompHeaders headers, boolean consumed) An overloaded version ofStompSession.acknowledge(String, boolean)
with fullStompHeaders
instead of just amessageId
.void
StompSessionHandler.afterConnected
(StompSession session, StompHeaders connectedHeaders) Invoked when the session is ready to use, i.e.void
StompSessionHandlerAdapter.afterConnected
(StompSession session, StompHeaders connectedHeaders) This implementation is empty.ReactorNettyTcpStompClient.connect
(StompHeaders connectHeaders, StompSessionHandler handler) Deprecated.ReactorNettyTcpStompClient.connectAsync
(StompHeaders connectHeaders, StompSessionHandler handler) An overloaded version ofReactorNettyTcpStompClient.connectAsync(StompSessionHandler)
that accepts headers to use for the STOMP CONNECT frame.protected ConnectionHandlingStompSession
StompClientSupport.createSession
(StompHeaders connectHeaders, StompSessionHandler handler) Factory method for create and configure a new session.void
DefaultStompSession.disconnect
(StompHeaders headers) void
StompSession.disconnect
(StompHeaders headers) Variant ofStompSession.disconnect()
with headers.StompFrameHandler.getPayloadType
(StompHeaders headers) Invoked beforeStompFrameHandler.handleFrame(StompHeaders, Object)
to determine the type of Object the payload should be converted to.StompSessionHandlerAdapter.getPayloadType
(StompHeaders headers) This implementation returns String as the expected payload type for STOMP ERROR frames.void
StompSessionHandler.handleException
(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception) Handle any exception arising while processing a STOMP frame such as a failure to convert the payload or an unhandled exception in the applicationStompFrameHandler
.void
StompSessionHandlerAdapter.handleException
(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception) This implementation is empty.void
StompFrameHandler.handleFrame
(StompHeaders headers, Object payload) Handle a STOMP frame with the payload converted to the target type returned fromStompFrameHandler.getPayloadType(StompHeaders)
.void
StompSessionHandlerAdapter.handleFrame
(StompHeaders headers, Object payload) This implementation is empty.protected StompHeaders
StompClientSupport.processConnectHeaders
(StompHeaders connectHeaders) Further initialize the StompHeaders, for example setting the heart-beat header if necessary.DefaultStompSession.send
(StompHeaders headers, Object payload) StompSession.send
(StompHeaders headers, Object payload) An overloaded version ofStompSession.send(String, Object)
with fullStompHeaders
instead of just a destination.DefaultStompSession.subscribe
(StompHeaders headers, StompFrameHandler handler) StompSession.subscribe
(StompHeaders headers, StompFrameHandler handler) An overloaded version ofStompSession.subscribe(String, StompFrameHandler)
with fullStompHeaders
instead of just a destination.void
StompSession.Subscription.unsubscribe
(StompHeaders headers) Alternative toStompSession.Subscription.unsubscribe()
with additional custom headers to send to the server.Modifier and TypeMethodDescriptionvoid
StompSession.Receiptable.addReceiptTask
(Consumer<StompHeaders> task) Variant ofStompSession.Receiptable.addReceiptTask(Runnable)
with aConsumer
of the headers from theRECEIPT
frame.ModifierConstructorDescriptionDefaultStompSession
(StompSessionHandler sessionHandler, StompHeaders connectHeaders) Create a new session. -
Uses of StompHeaders in org.springframework.web.socket.messaging
Modifier and TypeMethodDescriptionprotected StompHeaders
WebSocketStompClient.processConnectHeaders
(StompHeaders connectHeaders) Modifier and TypeMethodDescriptionWebSocketStompClient.connect
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) Deprecated.WebSocketStompClient.connect
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) Deprecated.WebSocketStompClient.connectAsync
(String url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler handler, Object... uriVariables) An overloaded version ofWebSocketStompClient.connect(String, StompSessionHandler, Object...)
that also acceptsWebSocketHttpHeaders
to use for the WebSocket handshake andStompHeaders
for the STOMP CONNECT frame.WebSocketStompClient.connectAsync
(URI url, WebSocketHttpHeaders handshakeHeaders, StompHeaders connectHeaders, StompSessionHandler sessionHandler) An overloaded version ofWebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully preparedURI
.protected StompHeaders
WebSocketStompClient.processConnectHeaders
(StompHeaders connectHeaders)
ReactorNettyTcpStompClient.connectAsync(StompHeaders, StompSessionHandler)