Packages

c

akka.cluster

DowningProvider

abstract class DowningProvider extends AnyRef

API for plugins that will handle downing of cluster nodes. Concrete plugins must subclass and have a public one argument constructor accepting an akka.actor.ActorSystem.

A custom DowningProvider can be configured with akka.cluster.downing-provider-class

When implementing a downing provider you should make sure that it will not split the cluster into several separate clusters in case of network problems or system overload (long GC pauses). This is much more difficult than it might be perceived at first, so carefully read the concerns and scenarios described in https://doc.akka.io/libraries/akka-core/current/split-brain-resolver.html

Source
DowningProvider.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DowningProvider
  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. Protected

Instance Constructors

  1. new DowningProvider()

Abstract Value Members

  1. abstract def downRemovalMargin: FiniteDuration

    Time margin after which shards or singletons that belonged to a downed/removed partition are created in surviving partition.

    Time margin after which shards or singletons that belonged to a downed/removed partition are created in surviving partition. The purpose of this margin is that in case of a network partition the persistent actors in the non-surviving partitions must be stopped before corresponding persistent actors are started somewhere else. This is useful if you implement downing strategies that handle network partitions, e.g. by keeping the larger side of the partition and shutting down the smaller side.

  2. abstract def downingActorProps: Option[Props]

    If a props is returned it is created as a child of the core cluster daemon on cluster startup.

    If a props is returned it is created as a child of the core cluster daemon on cluster startup. It should then handle downing using the regular akka.cluster.Cluster APIs. The actor will run on the same dispatcher as the cluster actor if dispatcher not configured.

    May throw an exception which will then immediately lead to Cluster stopping, as the downing provider is vital to a working cluster.