akka.cluster.client

Class ClusterReceptionist

java.lang.Object

akka.cluster.client.ClusterReceptionist

All Implemented Interfaces:

Actor, ActorLogging

public final class ClusterReceptionist
extends java.lang.Object
implements Actor, ActorLogging

ClusterClient connects to this actor to retrieve. The ClusterReceptionist is supposed to be started on all nodes, or all nodes with specified role, in the cluster. The receptionist can be started with the ClusterClientReceptionist or as an ordinary actor (use the factory method props(akka.actor.ActorRef, akka.cluster.client.ClusterReceptionistSettings)).

The receptionist forwards messages from the client to the associated DistributedPubSubMediator, i.e. the client can send messages to any actor in the cluster that is registered in the DistributedPubSubMediator. Messages from the client are wrapped in DistributedPubSubMediator.Send, DistributedPubSubMediator.SendToAll or DistributedPubSubMediator.Publish with the semantics described in DistributedPubSubMediator.

Response messages from the destination actor are tunneled via the receptionist to avoid inbound connections from other cluster nodes to the client, i.e. the sender(), as seen by the destination actor, is not the client itself. The sender() of the response messages, as seen by the client, is deadLetters since the client should normally send subsequent messages via the ClusterClient. It is possible to pass the original sender inside the reply messages if the client is supposed to communicate directly to the actor in the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterReceptionist.Internal$ INTERNAL API

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
ClusterReceptionist(ActorRef pubSubMediator, ClusterReceptionistSettings settings)

Method Summary

Modifier and Type	Method and Description
protected abstract static void	akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
protected abstract static void	akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)
static void	akka$actor$ActorLogging$$_log_$eq(LoggingAdapter x$1)
static LoggingAdapter	akka$actor$ActorLogging$$_log()
protected static void	aroundPostRestart(java.lang.Throwable reason)
protected static void	aroundPostStop()
protected static void	aroundPreRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)
protected static void	aroundPreStart()
protected static void	aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive, java.lang.Object msg)
Cancellable	checkDeadlinesTask()
scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector>	clientInteractions()
scala.collection.immutable.HashSet<ActorRef>	clientsPublished()
Cluster	cluster()
ConsistentHash<Address>	consistentHash()
ActorContext	context() Stores the context for this actor, including self, and sender.
static LoggingAdapter	log()
boolean	matchingRole(Member m)
scala.collection.immutable.SortedSet<Address>	nodes()
static void	postRestart(java.lang.Throwable reason)
void	postStop() User overridable callback.
static void	preRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message)
void	preStart() User overridable callback.
static Props	props(ActorRef pubSubMediator, ClusterReceptionistSettings settings) Scala API: Factory method for ClusterReceptionist Props.
void	publishClientsUnreachable()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
ActorRef	responseTunnel(ActorRef client)
ActorRef	self() The 'self' field holds the ActorRef for this actor.
static ActorRef	sender()
scala.collection.immutable.Vector<ActorRef>	subscribers()
static SupervisorStrategy	supervisorStrategy()
static void	unhandled(java.lang.Object message)
void	updateClientInteractions(ActorRef client)
boolean	verboseHeartbeat()
int	virtualNodesFactor()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, preRestart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

ClusterReceptionist

public ClusterReceptionist(ActorRef pubSubMediator,
                           ClusterReceptionistSettings settings)

Method Detail

props

public static Props props(ActorRef pubSubMediator,
                          ClusterReceptionistSettings settings)

Scala API: Factory method for ClusterReceptionist Props.

Parameters:

pubSubMediator - (undocumented)

settings - (undocumented)

Returns:

(undocumented)

sender

public static final ActorRef sender()

aroundReceive

protected static void aroundReceive(scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive,
                                    java.lang.Object msg)

aroundPreStart

protected static void aroundPreStart()

aroundPostStop

protected static void aroundPostStop()

aroundPreRestart

protected static void aroundPreRestart(java.lang.Throwable reason,
                                       scala.Option<java.lang.Object> message)

aroundPostRestart

protected static void aroundPostRestart(java.lang.Throwable reason)

supervisorStrategy

public static SupervisorStrategy supervisorStrategy()

preRestart

public static void preRestart(java.lang.Throwable reason,
                              scala.Option<java.lang.Object> message)
                       throws java.lang.Exception

Throws:

java.lang.Exception

postRestart

public static void postRestart(java.lang.Throwable reason)
                        throws java.lang.Exception

Throws:

java.lang.Exception

unhandled

public static void unhandled(java.lang.Object message)

akka$actor$Actor$_setter_$context_$eq

protected abstract static void akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)

akka$actor$Actor$_setter_$self_$eq

protected abstract static void akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)

akka$actor$ActorLogging$$_log

public static LoggingAdapter akka$actor$ActorLogging$$_log()

akka$actor$ActorLogging$$_log_$eq

public static void akka$actor$ActorLogging$$_log_$eq(LoggingAdapter x$1)

log

public static LoggingAdapter log()

context

public ActorContext context()

Description copied from interface: Actor

Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a UntypedActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

cluster

public Cluster cluster()

verboseHeartbeat

public boolean verboseHeartbeat()

nodes

public scala.collection.immutable.SortedSet<Address> nodes()

virtualNodesFactor

public int virtualNodesFactor()

consistentHash

public ConsistentHash<Address> consistentHash()

clientInteractions

public scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector> clientInteractions()

clientsPublished

public scala.collection.immutable.HashSet<ActorRef> clientsPublished()

subscribers

public scala.collection.immutable.Vector<ActorRef> subscribers()

checkDeadlinesTask

public Cancellable checkDeadlinesTask()

preStart

public void preStart()

Description copied from interface: Actor

User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

Specified by:

preStart in interface Actor

postStop

public void postStop()

Description copied from interface: Actor

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Specified by:

postStop in interface Actor

matchingRole

public boolean matchingRole(Member m)

responseTunnel

public ActorRef responseTunnel(ActorRef client)

receive

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Returns:

(undocumented)

updateClientInteractions

public void updateClientInteractions(ActorRef client)

publishClientsUnreachable

public void publishClientsUnreachable()