Package | Description |
---|---|
org.springframework.messaging.simp.stomp |
Generic support for simple messaging protocols (like STOMP).
|
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 |
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.
|
org.springframework.util.concurrent.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.
|
void |
StompSession.disconnect(StompHeaders headers)
Variant of
StompSession.disconnect() with headers. |
void |
DefaultStompSession.disconnect(StompHeaders 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,
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,
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
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.
|