Class ClusterSingleton

This class is not intended for user extension other than for test purposes (e.g. stub implementation). More methods may be added in the future and that may break such implementations.

Inheritance
object
ClusterSingleton
Implements
Inherited Members
Namespace: Akka.Cluster.Tools.Singleton
Assembly: Akka.Cluster.Tools.dll
Syntax
public class ClusterSingleton : IExtension

Constructors

| Edit this page View Source

ClusterSingleton(ExtendedActorSystem)

Declaration
public ClusterSingleton(ExtendedActorSystem system)
Parameters
Type Name Description
ExtendedActorSystem system

Methods

| Edit this page View Source

DefaultConfig()

Returns default HOCON configuration for the cluster singleton.

Declaration
public static Config DefaultConfig()
Returns
Type Description
Config
| Edit this page View Source

Get(ActorSystem)

Declaration
public static ClusterSingleton Get(ActorSystem system)
Parameters
Type Name Description
ActorSystem system
Returns
Type Description
ClusterSingleton
| Edit this page View Source

Init(SingletonActor)

Start if needed and provide a proxy to a named singleton.

If there already is a manager running for the given `singletonName` on this node, no additional manager is started.

If there already is a proxy running for the given `singletonName` on this node, an IActorRef to that is returned.

Declaration
[Obsolete("This convenience method is deprecated and will be removed in v1.6, please use ClusterSingletonManager.Props and ClusterSingletonProxy.Props directly instead. See https://getakka.net/community/whats-new/akkadotnet-v1.5-upgrade-advisories.html#upgrading-to-akkanet-v1532. Since 1.5.32.")]
public IActorRef Init(SingletonActor singleton)
Parameters
Type Name Description
SingletonActor singleton
Returns
Type Description
IActorRef

A proxy actor that can be used to communicate with the singleton in the cluster

Implements

Extension Methods