Package com.tangosol.net

Interface PagedTopicService

All Superinterfaces:

CacheService, ClassLoaderAware, Controllable, DistributedCacheService, PartitionedService, Service, Service, TopicService

public interface PagedTopicService
extends TopicService, DistributedCacheService

A TopicService which provides globally ordered topics.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.net.CacheService

CacheService.CacheAction

Nested classes/interfaces inherited from interface com.tangosol.net.PartitionedService

PartitionedService.PartitionedAction, PartitionedService.PartitionRecoveryAction

Nested classes/interfaces inherited from interface com.tangosol.net.Service

Service.MemberJoinAction

Field Summary

Fields inherited from interface com.tangosol.net.CacheService

TYPE_DISTRIBUTED, TYPE_LOCAL, TYPE_OPTIMISTIC, TYPE_PAGED_TOPIC, TYPE_REMOTE, TYPE_REMOTE_GRPC, TYPE_REPLICATED

Fields inherited from interface com.tangosol.net.TopicService

TYPE_PAGED_TOPIC, TYPE_REMOTE, TYPE_REMOTE_GRPC

Method Summary

Modifier and Type	Method	Description
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.
void	destroySubscription(long lSubscriptionId)	Remove an existing subscriber group.
void	destroySubscription(long lSubscriptionId, Subscriber.Id subscriberId)	Remove an existing subscriber from a subscriber group.
void	ensureSubscription(String sTopicName, long lSubscription, Subscriber.Id subscriberId)	Ensure the specified subscriber is subscribed to a subscription.
void	ensureSubscription(String sTopicName, long lSubscription, Subscriber.Id subscriberId, boolean fForceReconnect)	Ensure the specified subscriber is subscribed to a subscription.
void	ensureSubscription(String sTopicName, long lSubscription, Subscriber.Id subscriberId, boolean fForceReconnect, int[] anChannel)	Ensure the specified subscriber is subscribed to a subscription.
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.
long	ensureSubscription(String sTopicName, com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId, Subscriber.Id subscriberId, Filter<?> filter, ValueExtractor<?,?> extractor, int[] anChannel)	Ensure the specified subscriber is created in a subscription.
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 .
com.tangosol.internal.net.topic.impl.paged.model.PagedTopicSubscription	getSubscription(long lSubscriptionId)	Return a PagedTopicSubscription.
long	getSubscriptionCount(String sTopicName)	Returns the count of subscriptions for the specified topic.
long	getSubscriptionId(String sTopicName, com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId)	Return the subscription id for a subscriber group.
com.tangosol.internal.net.topic.impl.paged.statistics.PagedTopicStatistics	getTopicStatistics(String sTopicName)	Returns the PagedTopicStatistics for a topic.
boolean	hasSubscribers(String sTopicName)	Returns true if the specified topic has subscribers or subscriber groups.
boolean	hasSubscription(long lSubscriptionId)	Determine whether a subscriber group exists.
boolean	isSubscriptionDestroyed(long lSubscriptionId)	Determine whether a subscriber group has been destroyed.
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.

Methods inherited from interface com.tangosol.net.CacheService

destroyCache, ensureCache, getBackingMapManager, getCacheNames, releaseCache, setBackingMapManager

Methods inherited from interface com.tangosol.io.ClassLoaderAware

getContextClassLoader, setContextClassLoader

Methods inherited from interface com.tangosol.util.Controllable

configure, isRunning, shutdown, start, stop

Methods inherited from interface com.tangosol.net.DistributedCacheService

getStorageEnabledMembers, isLocalStorageEnabled

Methods inherited from interface com.tangosol.net.PartitionedService

addPartitionListener, getBackupCount, getBackupOwner, getBackupStrength, getBackupStrengthName, getKeyAssociator, getKeyOwner, getKeyPartitioningStrategy, getOwnedPartitions, getOwnedPartitions, getOwnershipEnabledMembers, getOwnershipSenior, getOwnershipVersion, getPartitionAssignmentStrategy, getPartitionCount, getPartitionOwner, getPersistenceMode, instantiateKeyToBinaryConverter, removePartitionListener

Methods inherited from interface com.tangosol.net.Service

addMemberListener, getCluster, getDependencies, getInfo, getMinimumServiceVersion, getResourceRegistry, getSerializer, getUserContext, isSuspended, isVersionCompatible, isVersionCompatible, isVersionCompatible, isVersionCompatible, removeMemberListener, setDependencies, setUserContext

Methods inherited from interface com.tangosol.util.Service

addServiceListener, removeServiceListener

Methods inherited from interface com.tangosol.net.TopicService

destroyTopic, ensureChannelCount, ensureChannelCount, ensureTopic, getChannelCount, getSubscriberGroups, getTopicBackingMapManager, getTopicNames, releaseTopic, setTopicBackingMapManager

Method Details

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

long ensureSubscription(String sTopicName,
 com.tangosol.internal.net.topic.impl.paged.model.SubscriberGroupId groupId,
 Subscriber.Id subscriberId,
 Filter<?> filter,
 ValueExtractor<?,?> extractor,
 int[] anChannel)

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

anChannel - the channels to manually allocate to the subscriber

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

ensureSubscription

void ensureSubscription(String sTopicName,
 long lSubscription,
 Subscriber.Id subscriberId,
 boolean fForceReconnect,
 int[] anChannel)

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

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

hasSubscribers

boolean hasSubscribers(String sTopicName)

Returns true if the specified topic has subscribers or subscriber groups.

Parameters:

sTopicName - the name of the topic

Returns:

true if the specified topic has subscribers or subscriber groups

getSubscriptionCount

long getSubscriptionCount(String sTopicName)

Returns the count of subscriptions for the specified topic.

Parameters:

sTopicName - the name of the topic

Returns:

the count of subscriptions for the specified 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