ClusterReceptionist

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

Linear Supertypes

ActorLogging, Actor, AnyRef, Any

Type Hierarchy

Instance Constructors

new ClusterReceptionist(pubSubMediator: ActorRef, settings: ClusterReceptionistSettings)

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to any2stringadd[ClusterReceptionist] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ClusterReceptionist, B)

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to ArrowAssoc[ClusterReceptionist] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
final def asInstanceOf[T0]: T0

Definition Classes
Any
val checkDeadlinesTask: Cancellable
var clientInteractions: HashMap[ActorRef, DeadlineFailureDetector]
var clientsPublished: HashSet[ActorRef]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cluster: Cluster
var consistentHash: ConsistentHash[Address]
implicit val context: ActorContext

Definition Classes
Actor
def ensuring(cond: (ClusterReceptionist) ⇒ Boolean, msg: ⇒ Any): ClusterReceptionist

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to Ensuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ClusterReceptionist) ⇒ Boolean): ClusterReceptionist

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to Ensuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ClusterReceptionist

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to Ensuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ClusterReceptionist

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to Ensuring[ClusterReceptionist] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to StringFormat[ClusterReceptionist] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def log: LoggingAdapter

Definition Classes
ActorLogging
def matchingRole(m: Member): Boolean
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
var nodes: SortedSet[Address]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
ClusterReceptionist → Actor
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
ClusterReceptionist → Actor
def publishClientsUnreachable(): Unit
def receive: PartialFunction[Any, Unit]

Definition Classes
ClusterReceptionist → Actor
def responseTunnel(client: ActorRef): ActorRef
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
var subscribers: Vector[ActorRef]
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unhandled(message: Any): Unit

Definition Classes
Actor
def updateClientInteractions(client: ActorRef): Unit
val verboseHeartbeat: Boolean
val virtualNodesFactor: Int
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (ClusterReceptionist, B)

Implicit information
This member is added by an implicit conversion from ClusterReceptionist to ArrowAssoc[ClusterReceptionist] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object ClusterReceptionist | package client

final class ClusterReceptionist extends Actor with ActorLogging

Instance Constructors

new ClusterReceptionist(pubSubMediator: ActorRef, settings: ClusterReceptionistSettings)

Type Members

type Receive = PartialFunction[Any, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ClusterReceptionist, B)

final def ==(arg0: Any): Boolean

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

val checkDeadlinesTask: Cancellable

var clientInteractions: HashMap[ActorRef, DeadlineFailureDetector]

var clientsPublished: HashSet[ActorRef]

def clone(): AnyRef

val cluster: Cluster

var consistentHash: ConsistentHash[Address]

implicit val context: ActorContext

def ensuring(cond: (ClusterReceptionist) ⇒ Boolean, msg: ⇒ Any): ClusterReceptionist

def ensuring(cond: (ClusterReceptionist) ⇒ Boolean): ClusterReceptionist

def ensuring(cond: Boolean, msg: ⇒ Any): ClusterReceptionist

def ensuring(cond: Boolean): ClusterReceptionist

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def log: LoggingAdapter

def matchingRole(m: Member): Boolean

final def ne(arg0: AnyRef): Boolean

var nodes: SortedSet[Address]

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def publishClientsUnreachable(): Unit

def receive: PartialFunction[Any, Unit]

def responseTunnel(client: ActorRef): ActorRef

implicit final val self: ActorRef

final def sender(): ActorRef

var subscribers: Vector[ActorRef]

def supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unhandled(message: Any): Unit

def updateClientInteractions(client: ActorRef): Unit

val verboseHeartbeat: Boolean

val virtualNodesFactor: Int

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (ClusterReceptionist, B)

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterReceptionist to any2stringadd[ClusterReceptionist]

Inherited by implicit conversion StringFormat from ClusterReceptionist to StringFormat[ClusterReceptionist]

Inherited by implicit conversion Ensuring from ClusterReceptionist to Ensuring[ClusterReceptionist]

Inherited by implicit conversion ArrowAssoc from ClusterReceptionist to ArrowAssoc[ClusterReceptionist]

Ungrouped