public interface StompSession
Modifier and Type | Interface and Description |
---|---|
static interface |
StompSession.Receiptable
A handle to use to track receipts.
|
static interface |
StompSession.Subscription
A handle to use to unsubscribe or to track a receipt.
|
Modifier and Type | Method and Description |
---|---|
StompSession.Receiptable |
acknowledge(StompHeaders headers,
boolean consumed)
An overloaded version of
acknowledge(String, boolean) with
full StompHeaders instead of just a messageId . |
StompSession.Receiptable |
acknowledge(java.lang.String messageId,
boolean consumed)
Send an acknowledgement whether a message was consumed or not resulting
in an ACK or NACK frame respectively.
|
void |
disconnect()
Disconnect the session by sending a DISCONNECT frame.
|
java.lang.String |
getSessionId()
Return the id for the session.
|
boolean |
isConnected()
Whether the session is connected.
|
StompSession.Receiptable |
send(StompHeaders headers,
java.lang.Object payload)
An overloaded version of
send(String, Object) with full
StompHeaders instead of just a destination. |
StompSession.Receiptable |
send(java.lang.String destination,
java.lang.Object payload)
Send a message to the specified destination, converting the payload to a
byte[] with the help of a
MessageConverter . |
void |
setAutoReceipt(boolean enabled)
When enabled, a receipt header is automatically added to future
send and subscribe operations on this session, which
causes the server to return a RECEIPT. |
StompSession.Subscription |
subscribe(StompHeaders headers,
StompFrameHandler handler)
An overloaded version of
subscribe(String, StompFrameHandler)
with full StompHeaders instead of just a destination. |
StompSession.Subscription |
subscribe(java.lang.String destination,
StompFrameHandler handler)
Subscribe to the given destination by sending a SUBSCRIBE frame and handle
received messages with the specified
StompFrameHandler . |
java.lang.String getSessionId()
boolean isConnected()
void setAutoReceipt(boolean enabled)
send
and subscribe
operations on this session, which
causes the server to return a RECEIPT. An application can then use
the Receiptable
returned from the
operation to track the receipt.
A receipt header can also be added manually through the overloaded
methods that accept StompHeaders
.
StompSession.Receiptable send(java.lang.String destination, java.lang.Object payload)
byte[]
with the help of a
MessageConverter
.destination
- the destination to send a message topayload
- the message payloadStompSession.Receiptable send(StompHeaders headers, java.lang.Object payload)
send(String, Object)
with full
StompHeaders
instead of just a destination. The headers must
contain a destination and may also have other headers such as
"content-type" or custom headers for the broker to propagate to
subscribers, or broker-specific, non-standard headers..headers
- the message headerspayload
- the message payloadStompSession.Subscription subscribe(java.lang.String destination, StompFrameHandler handler)
StompFrameHandler
.destination
- the destination to subscribe tohandler
- the handler for received messagesStompSession.Subscription subscribe(StompHeaders headers, StompFrameHandler handler)
subscribe(String, StompFrameHandler)
with full StompHeaders
instead of just a destination.headers
- the headers for the subscribe message framehandler
- the handler for received messagesStompSession.Receiptable acknowledge(java.lang.String messageId, boolean consumed)
Note: to use this when subscribing you must set the
ack
header to "client" or
"client-individual" in order ot use this.
messageId
- the id of the messageconsumed
- whether the message was consumed or notStompSession.Receiptable acknowledge(StompHeaders headers, boolean consumed)
acknowledge(String, boolean)
with
full StompHeaders
instead of just a messageId
.headers
- the headers for the ACK or NACK message frameconsumed
- whether the message was consumed or notvoid disconnect()