Class SingletonActor

Inheritance
object
SingletonActor
Inherited Members
Namespace: Akka.Cluster.Tools.Singleton
Assembly: Akka.Cluster.Tools.dll
Syntax
[Obsolete("This setting class 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 class SingletonActor

Properties

| Edit this page View Source

Name

Declaration
public string Name { get; }
Property Value
Type Description
string
| Edit this page View Source

Props

Declaration
public Props Props { get; }
Property Value
Type Description
Props
| Edit this page View Source

Settings

Declaration
public Option<ClusterSingletonSettings> Settings { get; }
Property Value
Type Description
Option<ClusterSingletonSettings>
| Edit this page View Source

StopMessage

Declaration
public Option<object> StopMessage { get; }
Property Value
Type Description
Option<object>

Methods

| Edit this page View Source

Create(Props, string)

Declaration
public static SingletonActor Create(Props props, string name)
Parameters
Type Name Description
Props props
string name
Returns
Type Description
SingletonActor
| Edit this page View Source

WithProps(Props)

Props of the singleton actor, such as dispatcher settings.

Declaration
public SingletonActor WithProps(Props props)
Parameters
Type Name Description
Props props
Returns
Type Description
SingletonActor
| Edit this page View Source

WithSettings(ClusterSingletonSettings)

Additional settings, typically loaded from configuration.

Declaration
public SingletonActor WithSettings(ClusterSingletonSettings settings)
Parameters
Type Name Description
ClusterSingletonSettings settings
Returns
Type Description
SingletonActor
| Edit this page View Source

WithStopMessage(object)

Message sent to the singleton to tell it to stop, e.g. when being migrated. If this is not defined, a PoisonPill will be used instead. It can be useful to define a custom stop message if the singleton needs to perform some asynchronous cleanup or interactions before stopping.

Declaration
public SingletonActor WithStopMessage(object stopMessage)
Parameters
Type Name Description
object stopMessage
Returns
Type Description
SingletonActor

Extension Methods