Packages

final class SingletonActor[M] extends AnyRef

Source
ClusterSingleton.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SingletonActor
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. val behavior: Behavior[M]
  2. val name: String
  3. val props: Props
  4. val settings: Option[ClusterSingletonSettings]
  5. val stopMessage: Option[M]
  6. def withProps(props: Props): SingletonActor[M]

    akka.actor.typed.Props of the singleton actor, such as dispatcher settings.

  7. def withSettings(settings: ClusterSingletonSettings): SingletonActor[M]

    Additional settings, typically loaded from configuration.

  8. def withStopMessage(msg: M): SingletonActor[M]

    Message sent to the singleton to tell it to stop, e.g.

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