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.
|
Modifier and Type | Method and Description |
---|---|
StompHeaders |
StompSession.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 a
StompHeaders object that can only be read, not written to. |
Modifier and Type | Method and Description |
---|---|
StompSession.Receiptable |
StompSession.acknowledge(StompHeaders headers,
boolean consumed)
An overloaded version of
StompSession.acknowledge(String, boolean) with
full StompHeaders instead of just a messageId . |
StompSession.Receiptable |
DefaultStompSession.acknowledge(StompHeaders headers,
boolean consumed) |
void |
StompSessionHandlerAdapter.afterConnected(StompSession session,
StompHeaders connectedHeaders)
This implementation is empty.
|
void |
StompSessionHandler.afterConnected(StompSession session,
StompHeaders connectedHeaders)
Invoked when the session is ready to use, i.e.
|
ListenableFuture<StompSession> |
ReactorNettyTcpStompClient.connect(StompHeaders connectHeaders,
StompSessionHandler handler)
An overloaded version of
ReactorNettyTcpStompClient.connect(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.
|
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 |
StompSessionHandlerAdapter.handleException(StompSession session,
StompCommand command,
StompHeaders headers,
byte[] payload,
Throwable exception)
This implementation is empty.
|
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
application
StompFrameHandler . |
void |
StompFrameHandler.handleFrame(StompHeaders headers,
Object payload)
Handle a STOMP frame with the payload converted to the target type returned
from
StompFrameHandler.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.
|
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.Receiptable |
DefaultStompSession.send(StompHeaders headers,
Object payload) |
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.Subscription |
DefaultStompSession.subscribe(StompHeaders headers,
StompFrameHandler handler) |
void |
StompSession.Subscription.unsubscribe(StompHeaders headers)
Alternative to
StompSession.Subscription.unsubscribe() with additional custom headers
to send to the server. |
Constructor and Description |
---|
DefaultStompSession(StompSessionHandler sessionHandler,
StompHeaders connectHeaders)
Create a new session.
|
Modifier and Type | Method and Description |
---|---|
protected StompHeaders |
WebSocketStompClient.processConnectHeaders(StompHeaders connectHeaders) |
Modifier and Type | Method and Description |
---|---|
ListenableFuture<StompSession> |
WebSocketStompClient.connect(String url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler handler,
Object... uriVariables)
An overloaded version of
WebSocketStompClient.connect(String, StompSessionHandler, Object...) that also accepts
WebSocketHttpHeaders to use for the WebSocket handshake and
StompHeaders for the STOMP CONNECT frame. |
ListenableFuture<StompSession> |
WebSocketStompClient.connect(URI url,
WebSocketHttpHeaders handshakeHeaders,
StompHeaders connectHeaders,
StompSessionHandler sessionHandler)
An overloaded version of
WebSocketStompClient.connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)
that accepts a fully prepared URI . |
protected StompHeaders |
WebSocketStompClient.processConnectHeaders(StompHeaders connectHeaders) |