com.solace.messaging.receiver

Interface AsyncReceiverSubscriptions

All Known Subinterfaces:

DirectMessageReceiver, PersistentMessageReceiver

@ProviderType
public interface AsyncReceiverSubscriptions

An interface for asynchronous non-blocking requests to subscribe and unsubscribe to and from additional message sources, respectively.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AsyncReceiverSubscriptions.SubscriptionChangeListener The listener for subscription change notifications.

Method Summary

Modifier and Type	Method and Description
void	addSubscriptionAsync(TopicSubscription topicSubscription, AsyncReceiverSubscriptions.SubscriptionChangeListener listener) Requests to subscribe asynchronously to a given topic subscription.
void	removeSubscriptionAsync(TopicSubscription topicSubscription, AsyncReceiverSubscriptions.SubscriptionChangeListener listener) Unsubscribe from a previously subscribed message source on a broker, so that no more messages will be received from it.

Method Detail

addSubscriptionAsync

void addSubscriptionAsync(TopicSubscription topicSubscription,
                          AsyncReceiverSubscriptions.SubscriptionChangeListener listener)
                   throws PubSubPlusClientException

Requests to subscribe asynchronously to a given topic subscription. Result of this request can be monitored using given SubscriptionChangeListener. Once a subscription is applied successfully, messages are expected to be received from matching topics.

Parameters:

topicSubscription - the subscription expression for which to subscribe

listener - the callback to use for notification processing of subscription changes or failures; null is an illegal value

Throws:

PubSubPlusClientException - if the operation could not be completed

Since:

1.0

removeSubscriptionAsync

void removeSubscriptionAsync(TopicSubscription topicSubscription,
                             AsyncReceiverSubscriptions.SubscriptionChangeListener listener)
                      throws PubSubPlusClientException

Unsubscribe from a previously subscribed message source on a broker, so that no more messages will be received from it. Result of this request can be monitored using given SubscriptionChangeListener.

Parameters:

topicSubscription - the topic subscription to be removed

listener - the callback to use to for the communication of subscription changes or failures; null is an illegal value

Throws:

PubSubPlusClientException - if the operation could not be completed.

Since:

1.0