Class ClusterSingletonProxy

The ClusterSingletonProxy works together with the ClusterSingletonManager to provide a distributed proxy to the singleton actor.

The proxy can be started on every node where the singleton needs to be reached and used as if it were the singleton itself. It will then act as a router to the currently running singleton instance. If the singleton is not currently available, e.g., during hand off or startup, the proxy will buffer the messages sent to the singleton and then deliver them when the singleton is finally available. The size of the buffer is configurable and it can be disabled by using a buffer size of 0. When the buffer is full old messages will be dropped when new messages are sent via the proxy.

The proxy works by keeping track of the oldest cluster member. When a new oldest member is identified, e.g. because the older one left the cluster, or at startup, the proxy will try to identify the singleton on the oldest member by periodically sending an Identify message until the singleton responds with its ActorIdentity.

Note that this is a best effort implementation: messages can always be lost due to the distributed nature of the actors involved.

Inheritance

Object

ActorBase

UntypedActor

ReceiveActor

ClusterSingletonProxy

Implements

IInternalActor

IInitializableActor

IWithTimers

Inherited Members

ReceiveActor.IInitializableActor.Init()

ReceiveActor.OnReceive(Object)

ReceiveActor.Become(Action)

ReceiveActor.BecomeStacked(Action)

ReceiveActor.ReceiveAsync<T>(Func<T, Task>, Predicate<T>)

ReceiveActor.ReceiveAsync<T>(Predicate<T>, Func<T, Task>)

ReceiveActor.ReceiveAsync(Type, Func<Object, Task>, Predicate<Object>)

ReceiveActor.ReceiveAsync(Type, Predicate<Object>, Func<Object, Task>)

ReceiveActor.ReceiveAnyAsync(Func<Object, Task>)

ReceiveActor.Receive<T>(Action<T>, Predicate<T>)

ReceiveActor.Receive<T>(Predicate<T>, Action<T>)

ReceiveActor.Receive(Type, Action<Object>, Predicate<Object>)

ReceiveActor.Receive(Type, Predicate<Object>, Action<Object>)

ReceiveActor.Receive<T>(Func<T, Boolean>)

ReceiveActor.Receive(Type, Func<Object, Boolean>)

ReceiveActor.ReceiveAny(Action<Object>)

UntypedActor.Receive(Object)

UntypedActor.RunTask(Action)

UntypedActor.RunTask(Func<Task>)

UntypedActor.Become(UntypedReceive)

UntypedActor.BecomeStacked(UntypedReceive)

UntypedActor.Context

ActorBase.Sender

ActorBase.Self

ActorBase.IInternalActor.ActorContext

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.Singleton

Assembly: Akka.Cluster.Tools.dll

Syntax

public sealed class ClusterSingletonProxy : ReceiveActor, IInternalActor, IInitializableActor, IWithTimers

Constructors

ClusterSingletonProxy(String, ClusterSingletonProxySettings)

TBD

Declaration

public ClusterSingletonProxy(string singletonManagerPath, ClusterSingletonProxySettings settings)

Parameters

Type	Name	Description
String	singletonManagerPath	TBD
ClusterSingletonProxySettings	settings	TBD

Properties

Timers

Declaration

public ITimerScheduler Timers { get; set; }

Property Value

Type	Description
ITimerScheduler

Methods

DefaultConfig()

Returns default HOCON configuration for the cluster singleton.

Declaration

public static Config DefaultConfig()

Returns

Type	Description
Config	TBD

PostStop()

TBD

Declaration

protected override void PostStop()

Overrides

ActorBase.PostStop()

PreStart()

TBD

Declaration

protected override void PreStart()

Overrides

ActorBase.PreStart()

Props(String, ClusterSingletonProxySettings)

Factory method for ClusterSingletonProxy Props.

Declaration

public static Props Props(string singletonManagerPath, ClusterSingletonProxySettings settings)

Parameters

Type	Name	Description
String	singletonManagerPath	The logical path of the singleton manager, e.g. /user/singletonManager, which ends with the name you defined in actorOf when creating the ClusterSingletonManager.
ClusterSingletonProxySettings	settings	Cluster singleton proxy settings.

Returns

Type	Description
Props	TBD

Implements

IInternalActor

IInitializableActor

IWithTimers

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)