Class 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 Get(ActorSystem) or as an ordinary actor (use the factory method Props(IActorRef, 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 Send, SendToAll or Publish with the semantics described in distributed publish/subscribe.

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 preserved as the original sender, so the client can choose to send subsequent messages directly to the actor in the cluster.

Inheritance

Object

ActorBase

ClusterReceptionist

Implements

IInternalActor

Inherited Members

ActorBase.Sender

ActorBase.Self

ActorBase.IInternalActor.ActorContext

ActorBase.Context

ActorBase.AroundReceive(Receive, Object)

ActorBase.EmptyReceive

ActorBase.Unhandled(Object)

ActorBase.Become(Receive)

ActorBase.BecomeStacked(Receive)

ActorBase.UnbecomeStacked()

ActorBase.SetReceiveTimeout(Nullable<TimeSpan>)

ActorBase.AroundPreRestart(Exception, Object)

ActorBase.AroundPreStart()

ActorBase.AroundPostRestart(Exception, Object)

ActorBase.PreRestart(Exception, Object)

ActorBase.PostRestart(Exception)

ActorBase.AroundPostStop()

ActorBase.SupervisorStrategy()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Cluster.Tools.Client

Assembly: Akka.Cluster.Tools.dll

Syntax

public sealed class ClusterReceptionist : ActorBase, IInternalActor

Constructors

ClusterReceptionist(IActorRef, ClusterReceptionistSettings)

TBD

Declaration

public ClusterReceptionist(IActorRef pubSubMediator, ClusterReceptionistSettings settings)

Parameters

Type	Name	Description
IActorRef	pubSubMediator	TBD
ClusterReceptionistSettings	settings	TBD

Exceptions

Type	Condition
ArgumentException	TBD

Methods

PostStop()

Declaration

protected override void PostStop()

Overrides

ActorBase.PostStop()

PreStart()

Declaration

protected override void PreStart()

Overrides

ActorBase.PreStart()

Props(IActorRef, ClusterReceptionistSettings)

Factory method for ClusterReceptionist Props.

Declaration

public static Props Props(IActorRef pubSubMediator, ClusterReceptionistSettings settings)

Parameters

Type	Name	Description
IActorRef	pubSubMediator	TBD
ClusterReceptionistSettings	settings	TBD

Returns

Type	Description
Props	TBD

Receive(Object)

TBD

Declaration

protected override bool Receive(object message)

Parameters

Type	Name	Description
Object	message	TBD

Returns

Type	Description
Boolean	TBD

Overrides

ActorBase.Receive(Object)

Implements

IInternalActor

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)