com.hazelcast.topic.impl

Class TopicService

java.lang.Object

com.hazelcast.topic.impl.TopicService

All Implemented Interfaces:

ManagedService, RemoteService, StatisticsAwareService<LocalTopicStats>, EventPublishingService

public class TopicService
extends Object
implements ManagedService, RemoteService, EventPublishingService, StatisticsAwareService<LocalTopicStats>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ORDERING_LOCKS_LENGTH
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
TopicService()

Method Summary

Modifier and Type	Method and Description
UUID	addMessageListener(String name, MessageListener listener, boolean localOnly)
ITopic	createDistributedObject(String name, boolean local) Creates a distributed object on the local member only (when local is true), else cluster-wide.
void	destroyDistributedObject(String objectId, boolean local) Destroys a distributed object.
void	dispatchEvent(Object event, Object listener) Notifies the service of a published event.
LocalTopicStatsImpl	getLocalTopicStats(String name)
Lock	getOrderLock(String key)
Map<String,LocalTopicStats>	getStats() Return the service statistics for the local instance.
ConcurrentMap<String,LocalTopicStatsImpl>	getStatsMap()
void	incrementPublishes(String topicName) Increments the number of published messages on the ITopic with the name topicName.
void	incrementReceivedMessages(String topicName) Increments the number of received messages on the ITopic with the name topicName.
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	publishMessage(String topicName, Object payload, boolean multithreaded)
boolean	removeMessageListener(String name, UUID registrationId)
void	reset() Resets this service back to its initial state.
void	shutdown(boolean terminate) Shuts down this service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hazelcast.internal.services.RemoteService

createDistributedObject, destroyDistributedObject

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

ORDERING_LOCKS_LENGTH

public static final int ORDERING_LOCKS_LENGTH

See Also:

Constant Field Values

Constructor Detail

TopicService

public TopicService()

Method Detail

init

public void init(NodeEngine nodeEngine,
                 Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

getStatsMap

public ConcurrentMap<String,LocalTopicStatsImpl> getStatsMap()

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service

getOrderLock

public Lock getOrderLock(String key)

createDistributedObject

public ITopic createDistributedObject(String name,
                                      boolean local)

Description copied from interface: RemoteService

Creates a distributed object on the local member only (when local is true), else cluster-wide.

Specified by:

createDistributedObject in interface RemoteService

Parameters:

name - the name for the created distributed object

local - when true then only perform required proxy creation actions on the local member, otherwise perform cluster-wide proxy creation.

Returns:

the created distributed object

destroyDistributedObject

public void destroyDistributedObject(String objectId,
                                     boolean local)

Description copied from interface: RemoteService

Destroys a distributed object.

Specified by:

destroyDistributedObject in interface RemoteService

Parameters:

objectId - the name of the distributed object to destroy

dispatchEvent

public void dispatchEvent(Object event,
                          Object listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService

Parameters:

event - the published event

listener - the listener registered for this event

getLocalTopicStats

public LocalTopicStatsImpl getLocalTopicStats(String name)

incrementPublishes

public void incrementPublishes(String topicName)

Increments the number of published messages on the ITopic with the name topicName.

Parameters:

topicName - the name of the ITopic

incrementReceivedMessages

public void incrementReceivedMessages(String topicName)

Increments the number of received messages on the ITopic with the name topicName.

Parameters:

topicName - the name of the ITopic

publishMessage

public void publishMessage(String topicName,
                           Object payload,
                           boolean multithreaded)

addMessageListener

@Nonnull
public UUID addMessageListener(@Nonnull
                                        String name,
                                        @Nonnull
                                        MessageListener listener,
                                        boolean localOnly)

removeMessageListener

public boolean removeMessageListener(@Nonnull
                                     String name,
                                     @Nonnull
                                     UUID registrationId)

getStats

public Map<String,LocalTopicStats> getStats()

Description copied from interface: StatisticsAwareService

Return the service statistics for the local instance.

Specified by:

getStats in interface StatisticsAwareService<LocalTopicStats>

Returns:

the statistics, grouped by distributed object name