Packages

trait ComponentHealth extends HealthElement

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComponentHealth
  2. HealthElement
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type HealthListener = (ComponentHealth.this, (ComponentHealth.this)#State, TraceContext) => Unit
    Definition Classes
    HealthElement
  2. type State = ComponentState
    Definition Classes
    ComponentHealth → HealthElement

Abstract Value Members

  1. abstract def initialState: ComponentState

    Initial state of the component

    Initial state of the component

    Attributes
    protected
  2. abstract def name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    HealthElement

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def degradationOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

  7. def degradationOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

  11. def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def getState: ComponentState

    Current state

    Current state

    Definition Classes
    ComponentHealth → HealthElement
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def isFailed: Boolean

    Whether the component is in a failed state.

    Whether the component is in a failed state. Note: failed here means exactly _failed_, to know if the component is just unhealthy (i.e degraded or failed), use isUnhealthy.

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isNotFailed: Boolean

    Returns true when the component is not in a failed state (for components, degraded is still not failed)

    Returns true when the component is not in a failed state (for components, degraded is still not failed)

    Definition Classes
    ComponentHealth → HealthElement
  18. val listeners: AtomicReference[List[(ComponentHealth.this)#HealthListener]]
    Attributes
    protected
    Definition Classes
    HealthElement
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def registerOnHealthChange(listener: (ComponentHealth.this)#HealthListener): Unit
    Definition Classes
    HealthElement
  23. def reportHealthState(state: ComponentState)(implicit tc: TraceContext): Boolean
  24. def reportHealthState_(state: ComponentState)(implicit tc: TraceContext): Unit
  25. def resolveUnhealthy(implicit traceContext: TraceContext): Boolean

    Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

  26. def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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

Inherited from HealthElement

Inherited from AnyRef

Inherited from Any

Ungrouped