trait HealthComponent extends BaseHealthComponent

Implements health component Base using ComponentHealthState as a state. Suitable for most components unless there is a need for a custom State type.

Self Type
HealthComponent with NamedLogging with FlagCloseable
Linear Supertypes
BaseHealthComponent, HealthElement, AnyRef, Any
Known Subclasses
DomainTopologySender, Impl, DelegatingMutableHealthComponent, MutableHealthComponent, SyncDomainEphemeralState, SyncDomain, DbStorage, DbStorageMulti, DbStorageSingle, MemoryStorage, Storage, ResilientSequencerSubscription
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HealthComponent
  2. BaseHealthComponent
  3. HealthElement
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type HealthListener = (HealthComponent.this, (HealthComponent.this)#State, TraceContext) => Unit
    Definition Classes
    HealthElement
  2. type State = ComponentHealthState
    Definition Classes
    HealthComponent → BaseHealthComponent → HealthElement

Abstract Value Members

  1. abstract def initialHealthState: (HealthComponent.this)#State
    Attributes
    protected
    Definition Classes
    BaseHealthComponent
  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. val closingState: ComponentHealthState
    Definition Classes
    HealthComponent → BaseHealthComponent
  7. 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!

  8. 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!

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

    Report that the component is now failed

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

    Report that the component is now failed

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getState: (HealthComponent.this)#State

    Current state

    Current state

    Definition Classes
    BaseHealthComponent → HealthElement
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def isFailed: Boolean
    Definition Classes
    BaseHealthComponent
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val listeners: AtomicReference[List[(HealthComponent.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: (HealthComponent.this)#HealthListener): Unit
    Definition Classes
    BaseHealthComponent → HealthElement
  23. def reportHealthState(state: (HealthComponent.this)#State)(implicit tc: TraceContext): Boolean
    Definition Classes
    BaseHealthComponent
  24. def reportHealthState_(state: (HealthComponent.this)#State)(implicit tc: TraceContext): Unit
    Definition Classes
    BaseHealthComponent
  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. lazy val stateRef: AtomicReference[(HealthComponent.this)#State]
    Attributes
    protected
    Definition Classes
    BaseHealthComponent
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toComponentStatus: ComponentStatus
    Definition Classes
    BaseHealthComponent
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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 BaseHealthComponent

Inherited from HealthElement

Inherited from AnyRef

Inherited from Any

Ungrouped