akka.cluster.client

Class ClusterClientReceptionist

java.lang.Object

akka.cluster.client.ClusterClientReceptionist

All Implemented Interfaces:

Extension

public final class ClusterClientReceptionist
extends java.lang.Object
implements Extension

Extension that starts ClusterReceptionist and accompanying DistributedPubSubMediator with settings defined in config section akka.cluster.client.receptionist. The DistributedPubSubMediator is started by the DistributedPubSub extension.

Constructor Summary

Constructors

Constructor and Description
ClusterClientReceptionist(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
static ClusterClientReceptionist	createExtension(ExtendedActorSystem system)
static ClusterClientReceptionist	get(ActorSystem system)
boolean	isTerminated() Returns true if this member is not tagged with the role configured for the receptionist.
static ClusterClientReceptionist$	lookup()
void	registerService(ActorRef actor) Register an actor that should be reachable for the clients.
void	registerSubscriber(java.lang.String topic, ActorRef actor) Register an actor that should be reachable for the clients to a named topic.
ActorRef	underlying() Returns the underlying receptionist actor, particularly so that its events can be observed via subscribe/unsubscribe.
void	unregisterService(ActorRef actor) A registered actor will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.
void	unregisterSubscriber(java.lang.String topic, ActorRef actor) A registered subscriber will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterClientReceptionist

public ClusterClientReceptionist(ExtendedActorSystem system)

Method Detail

get

public static ClusterClientReceptionist get(ActorSystem system)

lookup

public static ClusterClientReceptionist$ lookup()

createExtension

public static ClusterClientReceptionist createExtension(ExtendedActorSystem system)

isTerminated

public boolean isTerminated()

Returns true if this member is not tagged with the role configured for the receptionist.

Returns:

(undocumented)

registerService

public void registerService(ActorRef actor)

Register an actor that should be reachable for the clients. The clients can send messages to this actor with Send or SendToAll using the path elements of the ActorRef, e.g. "/user/myservice".

Parameters:

actor - (undocumented)

unregisterService

public void unregisterService(ActorRef actor)

A registered actor will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Parameters:

actor - (undocumented)

registerSubscriber

public void registerSubscriber(java.lang.String topic,
                               ActorRef actor)

Register an actor that should be reachable for the clients to a named topic. Several actors can be registered to the same topic name, and all will receive published messages. The client can publish messages to this topic with Publish.

Parameters:

topic - (undocumented)

actor - (undocumented)

unregisterSubscriber

public void unregisterSubscriber(java.lang.String topic,
                                 ActorRef actor)

A registered subscriber will be automatically unregistered when terminated, but it can also be explicitly unregistered before termination.

Parameters:

topic - (undocumented)

actor - (undocumented)

underlying

public ActorRef underlying()

Returns the underlying receptionist actor, particularly so that its events can be observed via subscribe/unsubscribe.

Returns:

(undocumented)