Class SingletonActor
Inheritance
SingletonActor
Assembly: Akka.Cluster.Tools.dll
public class SingletonActor
Properties
|
Improve this Doc
View Source
Declaration
public string Name { get; }
Property Value
|
Improve this Doc
View Source
Declaration
public Props Props { get; }
Property Value
|
Improve this Doc
View Source
Declaration
public Option<ClusterSingletonSettings> Settings { get; }
Property Value
|
Improve this Doc
View Source
Declaration
public Option<object> StopMessage { get; }
Property Value
Methods
|
Improve this Doc
View Source
Declaration
public static SingletonActor Create(Props props, string name)
Parameters
Returns
|
Improve this Doc
View Source
Props of the singleton actor, such as dispatcher settings.
Declaration
public SingletonActor WithProps(Props props)
Parameters
Type |
Name |
Description |
Props |
props |
|
Returns
|
Improve this Doc
View Source
Additional settings, typically loaded from configuration.
Declaration
public SingletonActor WithSettings(ClusterSingletonSettings settings)
Parameters
Returns
|
Improve this Doc
View Source
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
Extension Methods