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.

Annotations
@deprecated
Deprecated

(Since version 2.6.0) Use Akka gRPC instead, see https://doc.akka.io/docs/akka/2.6/cluster-client.html#migration-to-akka-grpc

Source
ClusterClient.scala
Linear Supertypes
ActorLogging, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterReceptionist
  2. ActorLogging
  3. Actor
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClusterReceptionist(pubSubMediator: ActorRef, settings: ClusterReceptionistSettings)

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toany2stringadd[ClusterReceptionist] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterReceptionist, B)
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toArrowAssoc[ClusterReceptionist] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPostStop(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPreStart(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  10. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. val checkDeadlinesTask: Cancellable
  13. var clientInteractions: HashMap[ActorRef, DeadlineFailureDetector]
  14. var clientsPublished: HashSet[ActorRef]
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. val cluster: Cluster
  17. var consistentHash: ConsistentHash[Address]
  18. implicit val context: ActorContext
    Definition Classes
    Actor
  19. def ensuring(cond: (ClusterReceptionist) => Boolean, msg: => Any): ClusterReceptionist
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toEnsuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (ClusterReceptionist) => Boolean): ClusterReceptionist
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toEnsuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: => Any): ClusterReceptionist
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toEnsuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): ClusterReceptionist
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toEnsuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toStringFormat[ClusterReceptionist] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  30. def matchingRole(m: Member): Boolean
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. var nodes: SortedSet[Address]
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  36. def postStop(): Unit
    Definition Classes
    ClusterReceptionist → Actor
  37. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  38. def preStart(): Unit
    Definition Classes
    ClusterReceptionist → Actor
  39. def publishClientsUnreachable(): Unit
  40. def receive: PartialFunction[Any, Unit]
    Definition Classes
    ClusterReceptionist → Actor
  41. def responseTunnel(client: ActorRef): ActorRef
  42. implicit final val self: ActorRef
    Definition Classes
    Actor
  43. final def sender(): ActorRef
    Definition Classes
    Actor
  44. var subscribers: Vector[ActorRef]
  45. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  49. def updateClientInteractions(client: ActorRef): Unit
  50. val verboseHeartbeat: Boolean
  51. val virtualNodesFactor: Int
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def →[B](y: B): (ClusterReceptionist, B)
    Implicit
    This member is added by an implicit conversion from ClusterReceptionist toArrowAssoc[ClusterReceptionist] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterReceptionist to any2stringadd[ClusterReceptionist]

Inherited by implicit conversion StringFormat fromClusterReceptionist to StringFormat[ClusterReceptionist]

Inherited by implicit conversion Ensuring fromClusterReceptionist to Ensuring[ClusterReceptionist]

Inherited by implicit conversion ArrowAssoc fromClusterReceptionist to ArrowAssoc[ClusterReceptionist]

Ungrouped