Uses of Class
org.springframework.messaging.simp.stomp.StompHeaders

Packages that use StompHeaders

Package	Description
org.springframework.messaging.simp.stomp	Generic support for simple messaging protocols (like STOMP).
org.springframework.web.socket.messaging	WebSocket integration for Spring's messaging module.

Uses of StompHeaders in org.springframework.messaging.simp.stomp

Methods in org.springframework.messaging.simp.stomp that return StompHeaders

Modifier and Type	Method	Description
StompHeaders	StompSession.Subscription.getSubscriptionHeaders()	Return the headers used on the SUBSCRIBE frame.
protected StompHeaders	StompClientSupport.processConnectHeaders(@Nullable StompHeaders connectHeaders)	Further initialize the StompHeaders, for example setting the heart-beat header if necessary.
static StompHeaders	StompHeaders.readOnlyStompHeaders(@Nullable Map<String, List<String>> headers)	Return a StompHeaders object that can only be read, not written to.

Methods in org.springframework.messaging.simp.stomp with parameters of type StompHeaders

Modifier and Type	Method	Description
StompSession.Receiptable	DefaultStompSession.acknowledge(StompHeaders headers, boolean consumed)
StompSession.Receiptable	StompSession.acknowledge(StompHeaders headers, boolean consumed)	An overloaded version of StompSession.acknowledge(String, boolean) with full StompHeaders instead of just a messageId.
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.
CompletableFuture<StompSession>	ReactorNettyTcpStompClient.connectAsync(@Nullable StompHeaders connectHeaders, StompSessionHandler handler)	An overloaded version of ReactorNettyTcpStompClient.connectAsync(StompSessionHandler) that accepts headers to use for the STOMP CONNECT frame.
protected ConnectionHandlingStompSession	StompClientSupport.createSession(@Nullable StompHeaders connectHeaders, StompSessionHandler handler)	Factory method for create and configure a new session.
void	DefaultStompSession.disconnect(@Nullable StompHeaders headers)
void	StompSession.disconnect(StompHeaders headers)	Variant of StompSession.disconnect() with headers.
Type	StompFrameHandler.getPayloadType(StompHeaders headers)	Invoked before StompFrameHandler.handleFrame(StompHeaders, Object) to determine the type of Object the payload should be converted to.
Type	StompSessionHandlerAdapter.getPayloadType(StompHeaders headers)	This implementation returns String as the expected payload type for STOMP ERROR frames.
void	StompSessionHandler.handleException(StompSession session, @Nullable 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 application StompFrameHandler.
void	StompSessionHandlerAdapter.handleException(StompSession session, @Nullable StompCommand command, StompHeaders headers, byte[] payload, Throwable exception)	This implementation is empty.
void	StompFrameHandler.handleFrame(StompHeaders headers, @Nullable Object payload)	Handle a STOMP frame with the payload converted to the target type returned from StompFrameHandler.getPayloadType(StompHeaders).
void	StompSessionHandlerAdapter.handleFrame(StompHeaders headers, @Nullable Object payload)	This implementation is empty.
protected StompHeaders	StompClientSupport.processConnectHeaders(@Nullable StompHeaders connectHeaders)	Further initialize the StompHeaders, for example setting the heart-beat header if necessary.
StompSession.Receiptable	DefaultStompSession.send(StompHeaders headers, Object payload)
StompSession.Receiptable	StompSession.send(StompHeaders headers, Object payload)	An overloaded version of StompSession.send(String, Object) with full StompHeaders instead of just a destination.
StompSession.Subscription	DefaultStompSession.subscribe(StompHeaders headers, StompFrameHandler handler)
StompSession.Subscription	StompSession.subscribe(StompHeaders headers, StompFrameHandler handler)	An overloaded version of StompSession.subscribe(String, StompFrameHandler) with full StompHeaders instead of just a destination.
StompSession.Receiptable	StompSession.Subscription.unsubscribe(@Nullable StompHeaders headers)	Alternative to StompSession.Subscription.unsubscribe() with additional custom headers to send to the server.

Method parameters in org.springframework.messaging.simp.stomp with type arguments of type StompHeaders

Modifier and Type	Method	Description
void	StompSession.Receiptable.addReceiptTask(Consumer<StompHeaders> task)	Variant of StompSession.Receiptable.addReceiptTask(Runnable) with a Consumer of the headers from the RECEIPT frame.

Constructors in org.springframework.messaging.simp.stomp with parameters of type StompHeaders

Modifier	Constructor	Description
	DefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders)	Create a new session.

Uses of StompHeaders in org.springframework.web.socket.messaging

Methods in org.springframework.web.socket.messaging that return StompHeaders

Modifier and Type	Method	Description
protected StompHeaders	WebSocketStompClient.processConnectHeaders(@Nullable StompHeaders connectHeaders)

Methods in org.springframework.web.socket.messaging with parameters of type StompHeaders

Modifier and Type	Method	Description
CompletableFuture<StompSession>	WebSocketStompClient.connectAsync(String url, @Nullable WebSocketHttpHeaders handshakeHeaders, @Nullable StompHeaders connectHeaders, StompSessionHandler handler, @Nullable Object... uriVariables)	An overloaded version of WebSocketStompClient.connectAsync(String, StompSessionHandler, Object...) that also accepts WebSocketHttpHeaders to use for the WebSocket handshake and StompHeaders for the STOMP CONNECT frame.
CompletableFuture<StompSession>	WebSocketStompClient.connectAsync(URI url, @Nullable WebSocketHttpHeaders handshakeHeaders, @Nullable StompHeaders connectHeaders, StompSessionHandler sessionHandler)	An overloaded version of WebSocketStompClient.connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...) that accepts a fully prepared URI.
protected StompHeaders	WebSocketStompClient.processConnectHeaders(@Nullable StompHeaders connectHeaders)