final class ClusterReceptionist extends Actor with 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 ClusterReceptionist#props).
The receptionist forwards messages from the client to the associated akka.cluster.pubsub.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
akka.cluster.pubsub.DistributedPubSubMediator.Send, akka.cluster.pubsub.DistributedPubSubMediator.SendToAll
or akka.cluster.pubsub.DistributedPubSubMediator.Publish with the semantics described in
akka.cluster.pubsub.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.
- Source
- ClusterClient.scala
- Alphabetic
- By Inheritance
- ClusterReceptionist
- ActorLogging
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ClusterReceptionist(pubSubMediator: ActorRef, settings: ClusterReceptionistSettings)
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Value Members
- val checkDeadlinesTask: Cancellable
- var clientInteractions: HashMap[ActorRef, DeadlineFailureDetector]
- var clientsPublished: HashSet[ActorRef]
- val cluster: Cluster
- var consistentHash: ConsistentHash[Address]
-
implicit
val
context: ActorContext
Scala API: Stores the context for this actor, including self, and sender.
Scala API: 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!
akka.actor.ActorContext is the Scala API.
getContextreturns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
- def matchingRole(m: Member): Boolean
- var nodes: SortedSet[Address]
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart().User overridable callback: By default it calls
preStart().- reason
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- ClusterReceptionist → Actor
-
def
preRestart(reason: Throwable, message: Option[Any]): Unit
Scala API: User overridable callback: By default it disposes of all children and then calls
postStop().Scala API: User overridable callback: By default it disposes of all children and then calls
postStop().- reason
the Throwable that caused the restart to happen
- message
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preStart(): Unit
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
- Definition Classes
- ClusterReceptionist → Actor
- def publishClientsUnreachable(): Unit
-
def
receive: PartialFunction[Any, Unit]
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
- Definition Classes
- ClusterReceptionist → Actor
- def responseTunnel(client: ActorRef): ActorRef
-
implicit final
val
self: ActorRef
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
The reference sender Actor of the last received message.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else
deadLettersin akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
- var subscribers: Vector[ActorRef]
-
def
supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- Actor
-
def
unhandled(message: Any): Unit
User overridable callback.
User overridable callback.
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream
- Definition Classes
- Actor
- def updateClientInteractions(client: ActorRef): Unit
- val verboseHeartbeat: Boolean
- val virtualNodesFactor: Int