| ClusterSingletonManagerProps Method (Props, Object, ClusterSingletonManagerSettings) |
Creates props for the current cluster singleton manager.
Namespace:
Akka.Cluster.Tools.Singleton
Assembly:
Akka.Cluster.Tools (in Akka.Cluster.Tools.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax public static Props Props(
Props singletonProps,
Object terminationMessage,
ClusterSingletonManagerSettings settings
)
static member Props :
singletonProps : Props *
terminationMessage : Object *
settings : ClusterSingletonManagerSettings -> Props
Parameters
- singletonProps
- Type: Akka.ActorProps
Props of the singleton actor instance. - terminationMessage
- Type: SystemObject
When handing over to a new oldest node this terminationMessage is sent to the singleton actor
to tell it to finish its work, close resources, and stop. The hand-over to the new oldest node
is completed when the singleton actor is terminated. Note that PoisonPill is a
perfectly fine terminationMessage if you only need to stop the actor.
- settings
- Type: Akka.Cluster.Tools.SingletonClusterSingletonManagerSettings
Cluster singleton manager settings.
Return Value
Type:
PropsTBD
See Also