接口 StompSession

方法详细资料

• getSessionId

  String getSessionId()

  Return the id for the session.

• isConnected

  boolean isConnected()

  Whether the session is connected.

• setAutoReceipt

  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. 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.

• send

  StompSession.Receiptable send​(String destination,
                                Object payload)

  Send a message to the specified destination, converting the payload to a byte[] with the help of a MessageConverter.

  参数:

  destination - the destination to send a message to

  payload - the message payload

  返回:

  a Receiptable for tracking receipts

• send

  StompSession.Receiptable send​(StompHeaders headers,
                                Object payload)

  An overloaded version of 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 headers

  payload - the message payload

  返回:

  a Receiptable for tracking receipts

• subscribe

  StompSession.Subscription subscribe​(String destination,
                                      StompFrameHandler handler)

  Subscribe to the given destination by sending a SUBSCRIBE frame and handle received messages with the specified StompFrameHandler.

  参数:

  destination - the destination to subscribe to

  handler - the handler for received messages

  返回:

  a handle to use to unsubscribe and/or track receipts

• subscribe

  StompSession.Subscription subscribe​(StompHeaders headers,
                                      StompFrameHandler handler)

  An overloaded version of subscribe(String, StompFrameHandler) with full StompHeaders instead of just a destination.

  参数:

  headers - the headers for the subscribe message frame

  handler - the handler for received messages

  返回:

  a handle to use to unsubscribe and/or track receipts

• acknowledge

  StompSession.Receiptable acknowledge​(String messageId,
                                       boolean consumed)

  Send an acknowledgement whether a message was consumed or not resulting in an ACK or NACK frame respectively.

  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 message

  consumed - whether the message was consumed or not

  返回:

  a Receiptable for tracking receipts

  从以下版本开始:

  4.3

• disconnect

  void disconnect()

  Disconnect the session by sending a DISCONNECT frame.