Interface StompSession.Subscription

All Superinterfaces:

StompSession.Receiptable

Enclosing interface:

StompSession

public static interface StompSession.Subscription
extends StompSession.Receiptable

A handle to use to unsubscribe or to track a receipt.

Since:

4.2

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
StompHeaders	getSubscriptionHeaders()	Return the headers used on the SUBSCRIBE frame.
@Nullable String	getSubscriptionId()	Return the id for the subscription.
StompSession.Receiptable	unsubscribe()	Remove the subscription by sending an UNSUBSCRIBE frame.
StompSession.Receiptable	unsubscribe(@Nullable StompHeaders headers)	Alternative to unsubscribe() with additional custom headers to send to the server.

Methods inherited from interface org.springframework.messaging.simp.stomp.StompSession.Receiptable

addReceiptLostTask, addReceiptTask, addReceiptTask, getReceiptId

Method Details

getSubscriptionId

@Nullable String getSubscriptionId()

Return the id for the subscription.

getSubscriptionHeaders

StompHeaders getSubscriptionHeaders()

Return the headers used on the SUBSCRIBE frame.

Since:

5.0

unsubscribe

StompSession.Receiptable unsubscribe()

Remove the subscription by sending an UNSUBSCRIBE frame.

As of 7.0, this method returns StompSession.Receiptable.

unsubscribe

StompSession.Receiptable unsubscribe(@Nullable StompHeaders headers)

Alternative to unsubscribe() with additional custom headers to send to the server. Note, however, there is no need to set the subscription id.

As of 7.0, this method returns StompSession.Receiptable.

Parameters:

headers - the custom headers, if any

Since:

5.0