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
Deprecated.Use Akka gRPC instead, see https://doc.akka.io/libraries/akka-core/2.6/cluster-client.html#migration-to-akka-grpc. Since 2.6.0.ClusterClient
connects to this actor to retrieve. TheClusterReceptionist
is supposed to be started on all nodes, or all nodes with specified role, in the cluster. The receptionist can be started with theClusterClientReceptionist
or as an ordinary actor (use the factory methodprops(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 theDistributedPubSubMediator
. Messages from the client are wrapped inDistributedPubSubMediator.Send
,DistributedPubSubMediator.SendToAll
orDistributedPubSubMediator.Publish
with the semantics described inDistributedPubSubMediator
.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. Thesender()
of the response messages, as seen by the client, isdeadLetters
since the client should normally send subsequent messages via theClusterClient
. 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 Description static class
ClusterReceptionist.Internal$
Deprecated.INTERNAL API-
Nested classes/interfaces inherited from interface akka.actor.Actor
Actor.emptyBehavior$, Actor.ignoringBehavior$
-
-
Constructor Summary
Constructors Constructor Description ClusterReceptionist(ActorRef pubSubMediator, ClusterReceptionistSettings settings)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
Deprecated.Scala API: Stores the context for this actor, including self, and sender.protected void
akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)
Deprecated.The 'self' field holds the ActorRef for this actor.Cancellable
checkDeadlinesTask()
Deprecated.scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector>
clientInteractions()
Deprecated.void
clientInteractions_$eq(scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector> x$1)
Deprecated.scala.collection.immutable.HashSet<ActorRef>
clientsPublished()
Deprecated.void
clientsPublished_$eq(scala.collection.immutable.HashSet<ActorRef> x$1)
Deprecated.Cluster
cluster()
Deprecated.ConsistentHash<Address>
consistentHash()
Deprecated.void
consistentHash_$eq(ConsistentHash<Address> x$1)
Deprecated.ActorContext
context()
Deprecated.Scala API: Stores the context for this actor, including self, and sender.boolean
matchingRole(Member m)
Deprecated.scala.collection.immutable.SortedSet<Address>
nodes()
Deprecated.void
nodes_$eq(scala.collection.immutable.SortedSet<Address> x$1)
Deprecated.void
postStop()
Deprecated.User overridable callback.void
preStart()
Deprecated.User overridable callback.static Props
props(ActorRef pubSubMediator, ClusterReceptionistSettings settings)
Deprecated.Scala API: Factory method forClusterReceptionist
Props
.void
publishClientsUnreachable()
Deprecated.scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>
receive()
Deprecated.Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.ActorRef
responseTunnel(ActorRef client)
Deprecated.ActorRef
self()
Deprecated.The 'self' field holds the ActorRef for this actor.scala.collection.immutable.Vector<ActorRef>
subscribers()
Deprecated.void
subscribers_$eq(scala.collection.immutable.Vector<ActorRef> x$1)
Deprecated.void
updateClientInteractions(ActorRef client)
Deprecated.boolean
verboseHeartbeat()
Deprecated.int
virtualNodesFactor()
Deprecated.-
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_$eq, log
-
-
-
-
Constructor Detail
-
ClusterReceptionist
public ClusterReceptionist(ActorRef pubSubMediator, ClusterReceptionistSettings settings)
Deprecated.
-
-
Method Detail
-
props
public static Props props(ActorRef pubSubMediator, ClusterReceptionistSettings settings)
Deprecated.Scala API: Factory method forClusterReceptionist
Props
.
-
context
public ActorContext context()
Deprecated.Description copied from interface:Actor
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such asforward
.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 aAbstractActor.ActorContext
, which is the Java API of the actor context.
-
self
public final ActorRef self()
Deprecated.Description copied from interface:Actor
The 'self' field holds the ActorRef for this actor. Can be used to send messages to itself:self ! message
-
akka$actor$Actor$_setter_$context_$eq
protected void akka$actor$Actor$_setter_$context_$eq(ActorContext x$1)
Deprecated.Description copied from interface:Actor
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such asforward
.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 aAbstractActor.ActorContext
, which is the Java API of the actor context.- Specified by:
akka$actor$Actor$_setter_$context_$eq
in interfaceActor
-
akka$actor$Actor$_setter_$self_$eq
protected final void akka$actor$Actor$_setter_$self_$eq(ActorRef x$1)
Deprecated.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:
akka$actor$Actor$_setter_$self_$eq
in interfaceActor
-
cluster
public Cluster cluster()
Deprecated.
-
verboseHeartbeat
public boolean verboseHeartbeat()
Deprecated.
-
nodes
public scala.collection.immutable.SortedSet<Address> nodes()
Deprecated.
-
nodes_$eq
public void nodes_$eq(scala.collection.immutable.SortedSet<Address> x$1)
Deprecated.
-
virtualNodesFactor
public int virtualNodesFactor()
Deprecated.
-
consistentHash
public ConsistentHash<Address> consistentHash()
Deprecated.
-
consistentHash_$eq
public void consistentHash_$eq(ConsistentHash<Address> x$1)
Deprecated.
-
clientInteractions
public scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector> clientInteractions()
Deprecated.
-
clientInteractions_$eq
public void clientInteractions_$eq(scala.collection.immutable.HashMap<ActorRef,DeadlineFailureDetector> x$1)
Deprecated.
-
clientsPublished
public scala.collection.immutable.HashSet<ActorRef> clientsPublished()
Deprecated.
-
clientsPublished_$eq
public void clientsPublished_$eq(scala.collection.immutable.HashSet<ActorRef> x$1)
Deprecated.
-
subscribers
public scala.collection.immutable.Vector<ActorRef> subscribers()
Deprecated.
-
subscribers_$eq
public void subscribers_$eq(scala.collection.immutable.Vector<ActorRef> x$1)
Deprecated.
-
checkDeadlinesTask
public Cancellable checkDeadlinesTask()
Deprecated.
-
preStart
public void preStart()
Deprecated.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.
-
postStop
public void postStop()
Deprecated.Description copied from interface:Actor
User overridable callback. Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
-
matchingRole
public boolean matchingRole(Member m)
Deprecated.
-
receive
public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()
Deprecated.Description copied from interface:Actor
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
-
updateClientInteractions
public void updateClientInteractions(ActorRef client)
Deprecated.
-
publishClientsUnreachable
public void publishClientsUnreachable()
Deprecated.
-
-