c

org.apache.pekko.remote

DeadlineFailureDetector

class DeadlineFailureDetector extends FailureDetector

Implementation of failure detector using an absolute timeout of missing heartbeats to trigger unavailability.

#isAvailable will return false if there is no #heartbeat within the duration heartbeatInterval + acceptableHeartbeatPause.

Source
DeadlineFailureDetector.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeadlineFailureDetector
  2. FailureDetector
  3. AnyRef
  4. 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 DeadlineFailureDetector(config: Config, ev: EventStream)

    Constructor that reads parameters from config.

    Constructor that reads parameters from config. Expecting config properties named acceptable-heartbeat-pause.

  2. new DeadlineFailureDetector(acceptableHeartbeatPause: FiniteDuration, heartbeatInterval: FiniteDuration)(implicit clock: Clock)

    acceptableHeartbeatPause

    Duration corresponding to number of potentially lost/delayed heartbeats that will be accepted before considering it to be an anomaly.

    heartbeatInterval

    Expected heartbeat interval

    clock

    The clock, returning current time in milliseconds, but can be faked for testing purposes. It is only used for measuring intervals (duration).

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 DeadlineFailureDetector toany2stringadd[DeadlineFailureDetector] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DeadlineFailureDetector, B)
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toArrowAssoc[DeadlineFailureDetector] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val acceptableHeartbeatPause: FiniteDuration
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (DeadlineFailureDetector) => Boolean, msg: => Any): DeadlineFailureDetector
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toEnsuring[DeadlineFailureDetector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (DeadlineFailureDetector) => Boolean): DeadlineFailureDetector
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toEnsuring[DeadlineFailureDetector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): DeadlineFailureDetector
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toEnsuring[DeadlineFailureDetector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): DeadlineFailureDetector
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toEnsuring[DeadlineFailureDetector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def heartbeat(): Unit

    Notifies the FailureDetector that a heartbeat arrived from the monitored resource.

    Notifies the FailureDetector that a heartbeat arrived from the monitored resource. This causes the FailureDetector to update its state.

    Definition Classes
    DeadlineFailureDetectorFailureDetector
  18. val heartbeatInterval: FiniteDuration
  19. def isAvailable: Boolean

    Returns true if the resource is considered to be up and healthy and returns false otherwise.

    Returns true if the resource is considered to be up and healthy and returns false otherwise.

    Definition Classes
    DeadlineFailureDetectorFailureDetector
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isMonitoring: Boolean

    Returns true if the failure detector has received any heartbeats and started monitoring of the resource.

    Returns true if the failure detector has received any heartbeats and started monitoring of the resource.

    Definition Classes
    DeadlineFailureDetectorFailureDetector
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 DeadlineFailureDetector toStringFormat[DeadlineFailureDetector] 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): (DeadlineFailureDetector, B)
    Implicit
    This member is added by an implicit conversion from DeadlineFailureDetector toArrowAssoc[DeadlineFailureDetector] 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 FailureDetector

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDeadlineFailureDetector to any2stringadd[DeadlineFailureDetector]

Inherited by implicit conversion StringFormat fromDeadlineFailureDetector to StringFormat[DeadlineFailureDetector]

Inherited by implicit conversion Ensuring fromDeadlineFailureDetector to Ensuring[DeadlineFailureDetector]

Inherited by implicit conversion ArrowAssoc fromDeadlineFailureDetector to ArrowAssoc[DeadlineFailureDetector]

Ungrouped