Uses of Class
org.springframework.messaging.simp.stomp.StompHeaders
Packages that use StompHeaders
Package
Description
Generic support for simple messaging protocols (like STOMP).
-
Uses of StompHeaders in org.springframework.messaging.simp.stomp
Methods in org.springframework.messaging.simp.stomp that return StompHeadersModifier and TypeMethodDescriptionStompSession.Subscription.getSubscriptionHeaders()Return the headers used on the SUBSCRIBE frame.protected StompHeadersStompClientSupport.processConnectHeaders(StompHeaders connectHeaders) Further initialize the StompHeaders, for example setting the heart-beat header if necessary.static StompHeadersStompHeaders.readOnlyStompHeaders(Map<String, List<String>> headers) Return aStompHeadersobject that can only be read, not written to.Methods in org.springframework.messaging.simp.stomp with parameters of type StompHeadersModifier and TypeMethodDescriptionDefaultStompSession.acknowledge(StompHeaders headers, boolean consumed) StompSession.acknowledge(StompHeaders headers, boolean consumed) An overloaded version ofStompSession.acknowledge(String, boolean)with fullStompHeadersinstead of just amessageId.voidStompSessionHandler.afterConnected(StompSession session, StompHeaders connectedHeaders) Invoked when the session is ready to use, i.e.voidStompSessionHandlerAdapter.afterConnected(StompSession session, StompHeaders connectedHeaders) This implementation is empty.org.springframework.util.concurrent.ListenableFuture<StompSession>ReactorNettyTcpStompClient.connect(StompHeaders connectHeaders, StompSessionHandler handler) Deprecated, for removal: This API element is subject to removal in a future version.ReactorNettyTcpStompClient.connectAsync(StompHeaders connectHeaders, StompSessionHandler handler) An overloaded version ofReactorNettyTcpStompClient.connectAsync(StompSessionHandler)that accepts headers to use for the STOMP CONNECT frame.protected ConnectionHandlingStompSessionStompClientSupport.createSession(StompHeaders connectHeaders, StompSessionHandler handler) Factory method for create and configure a new session.voidDefaultStompSession.disconnect(StompHeaders headers) voidStompSession.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.voidStompSessionHandler.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.voidStompSessionHandlerAdapter.handleException(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, Throwable exception) This implementation is empty.voidStompFrameHandler.handleFrame(StompHeaders headers, Object payload) Handle a STOMP frame with the payload converted to the target type returned fromStompFrameHandler.getPayloadType(StompHeaders).voidStompSessionHandlerAdapter.handleFrame(StompHeaders headers, Object payload) This implementation is empty.protected StompHeadersStompClientSupport.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 fullStompHeadersinstead of just a destination.DefaultStompSession.subscribe(StompHeaders headers, StompFrameHandler handler) StompSession.subscribe(StompHeaders headers, StompFrameHandler handler) An overloaded version ofStompSession.subscribe(String, StompFrameHandler)with fullStompHeadersinstead of just a destination.voidStompSession.Subscription.unsubscribe(StompHeaders headers) Alternative toStompSession.Subscription.unsubscribe()with additional custom headers to send to the server.Method parameters in org.springframework.messaging.simp.stomp with type arguments of type StompHeadersModifier and TypeMethodDescriptionvoidStompSession.Receiptable.addReceiptTask(Consumer<StompHeaders> task) Variant ofStompSession.Receiptable.addReceiptTask(Runnable)with aConsumerof the headers from theRECEIPTframe.Constructors in org.springframework.messaging.simp.stomp with parameters of type StompHeadersModifierConstructorDescriptionDefaultStompSession(StompSessionHandler sessionHandler, StompHeaders connectHeaders) Create a new session.
ReactorNettyTcpStompClient.connectAsync(StompHeaders, StompSessionHandler)