Interface PagedTopicService

    • Method Detail

      • ensureSubscriberGroup

        default long ensureSubscriberGroup​(String sTopicName,
                                           String sGroupName)
        Ensure the specified subscriber group is created in a subscription.
        Parameters:
        sTopicName - the name of the topic
        sGroupName - the name of the subscriber group
        Returns:
        the unique identifier of the subscriber group or -1 if the cluster is not version compatible and cannot create subscriptions
      • ensureSubscriberGroup

        default long ensureSubscriberGroup​(String sTopicName,
                                           String sGroupName,
                                           Filter<?> filter,
                                           ValueExtractor<?,​?> extractor)
        Ensure the specified subscriber group is created in a subscription.
        Parameters:
        sTopicName - the name of the topic
        sGroupName - the name of the subscriber group
        filter - the Filter to use to filter messages sent to subscribers
        extractor - the ValueExtractor to use to convert messages sent to subscribers
        Returns:
        the unique identifier of the subscriber group or -1 if the cluster is not version compatible and cannot create subscriptions
      • destroySubscriberGroup

        void destroySubscriberGroup​(String sTopicName,
                                    String sGroupName)
        Destroy an existing subscriber group.
        Parameters:
        sTopicName - the name of the topic
        sGroupName - the name of the subscriber group
      • ensureSubscription

        long ensureSubscription​(String sTopicName,
                                com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId,
                                Subscriber.Id subscriberId,
                                Filter<?> filter,
                                ValueExtractor<?,​?> extractor)
        Ensure the specified subscriber is created in a subscription.
        Parameters:
        sTopicName - the name of the topic
        groupId - the id of the subscriber group
        subscriberId - the Subscriber.Id
        filter - the Filter to use to filter messages sent to subscribers
        extractor - the ValueExtractor to use to convert messages sent to subscribers
        Returns:
        the unique identifier of the subscriber group the Subscriber is subscribed to, of -1 if the cluster is not version compatible and cannot create subscriptions
      • ensureSubscription

        void ensureSubscription​(String sTopicName,
                                long lSubscription,
                                Subscriber.Id subscriberId)
        Ensure the specified subscriber is subscribed to a subscription.
        Parameters:
        sTopicName - the name of the topic
        lSubscription - the unique id of the subscriber group
        subscriberId - the Subscriber.Id
      • ensureSubscription

        void ensureSubscription​(String sTopicName,
                                long lSubscription,
                                Subscriber.Id subscriberId,
                                boolean fForceReconnect)
        Ensure the specified subscriber is subscribed to a subscription.
        Parameters:
        sTopicName - the name of the topic
        lSubscription - the unique id of the subscriber group
        subscriberId - the Subscriber.Id
        fForceReconnect - force a reconnection even if the subscriber is known to the service
      • destroySubscription

        void destroySubscription​(long lSubscriptionId,
                                 Subscriber.Id subscriberId)
        Remove an existing subscriber from a subscriber group.
        Parameters:
        lSubscriptionId - the subscription identifier
        subscriberId - the Subscriber.Id
      • destroySubscription

        void destroySubscription​(long lSubscriptionId)
        Remove an existing subscriber group.
        Parameters:
        lSubscriptionId - the subscription identifier
      • hasSubscription

        boolean hasSubscription​(long lSubscriptionId)
        Determine whether a subscriber group exists.
        Parameters:
        lSubscriptionId - the id of the subscription to return
        Returns:
        true if the group exists
      • isSubscriptionDestroyed

        boolean isSubscriptionDestroyed​(long lSubscriptionId)
        Determine whether a subscriber group has been destroyed.
        Parameters:
        lSubscriptionId - the unique identifier of the subscriber group
        Returns:
        true if the group has been destroyed
      • getSubscription

        com.tangosol.internal.net.topic.impl.paged.model.PagedTopicSubscription getSubscription​(long lSubscriptionId)
        Return a PagedTopicSubscription.
        Parameters:
        lSubscriptionId - the id of the subscription to return
        Returns:
        the specified PagedTopicSubscription or null if the subscription does not exist.
      • getSubscriptionId

        long getSubscriptionId​(String sTopicName,
                               com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId)
        Return the subscription id for a subscriber group.
        Parameters:
        sTopicName - the name of the topic
        groupId - the identifier for the subscriber group
        Returns:
        the subscription id for a subscriber group or zero if the subscription does not exist.
      • getTopicStatistics

        com.tangosol.internal.net.topic.impl.paged.statistics.PagedTopicStatistics getTopicStatistics​(String sTopicName)
        Returns the PagedTopicStatistics for a topic.
        Parameters:
        sTopicName - the name of the topic
        Returns:
        the PagedTopicStatistics for the topic or null if no statistics exist for the topic
      • getSubscriberGroups

        Set<com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId> getSubscriberGroups​(String sTopicName)
        Returns the subscriber groups for a topic known to this service.
        Returns:
        the subscriber groups for a topic known to this service
      • getSubscribers

        Set<com.tangosol.internal.net.topic.impl.paged.model.SubscriberId> getSubscribers​(String sTopicName,
                                                                                          com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId)
        Returns the subscriber ids known to this service and subscribed to a subscriber group for a topic .
        Returns:
        the subscriber ids known to this service and subscribed to a subscriber group for a topic
      • addSubscriptionListener

        void addSubscriptionListener​(com.tangosol.internal.net.topic.impl.paged.model.PagedTopicSubscription.Listener listener)
        Add a listener that will be notified when changes are made to topic subscriptions.
        Parameters:
        listener - the listener to add
      • removeSubscriptionListener

        void removeSubscriptionListener​(com.tangosol.internal.net.topic.impl.paged.model.PagedTopicSubscription.Listener listener)
        Remove a listener that was being notified when changes are made to topic subscriptions.
        Parameters:
        listener - the listener to remove