Packages

c

org.apache.pekko.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 pekko.actor.ActorSystem.

A custom DowningProvider can be configured with pekko.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://pekko.apache.org/docs/pekko/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 pekko.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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DowningProvider toany2stringadd[DowningProvider] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DowningProvider, B)
    Implicit
    This member is added by an implicit conversion from DowningProvider toArrowAssoc[DowningProvider] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (DowningProvider) => Boolean, msg: => Any): DowningProvider
    Implicit
    This member is added by an implicit conversion from DowningProvider toEnsuring[DowningProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DowningProvider) => Boolean): DowningProvider
    Implicit
    This member is added by an implicit conversion from DowningProvider toEnsuring[DowningProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): DowningProvider
    Implicit
    This member is added by an implicit conversion from DowningProvider toEnsuring[DowningProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DowningProvider
    Implicit
    This member is added by an implicit conversion from DowningProvider toEnsuring[DowningProvider] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DowningProvider toStringFormat[DowningProvider] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (DowningProvider, B)
    Implicit
    This member is added by an implicit conversion from DowningProvider toArrowAssoc[DowningProvider] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDowningProvider to any2stringadd[DowningProvider]

Inherited by implicit conversion StringFormat fromDowningProvider to StringFormat[DowningProvider]

Inherited by implicit conversion Ensuring fromDowningProvider to Ensuring[DowningProvider]

Inherited by implicit conversion ArrowAssoc fromDowningProvider to ArrowAssoc[DowningProvider]

Ungrouped