t

com.digitalasset.canton.health

AtomicHealthComponent

trait AtomicHealthComponent extends AtomicHealthElement with HealthComponent

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AtomicHealthComponent
  2. HealthComponent
  3. HealthQuasiComponent
  4. AtomicHealthElement
  5. HealthElement
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type State = ComponentHealthState

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement

Abstract Value Members

  1. abstract def associatedOnShutdownRunner: OnShutdownRunner

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.

    When this com.digitalasset.canton.lifecycle.OnShutdownRunner closes, the health state permanently becomes closingState and all listeners are notified about this.

    Attributes
    protected
    Definition Classes
    HealthElement
  2. abstract def initialHealthState: State

    The initial state upon creation

    The initial state upon creation

    Attributes
    protected
    Definition Classes
    HealthElement
  3. abstract def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    HealthElement
  4. 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() @IntrinsicCandidate()
  6. def closingState: ComponentHealthState

    The state set when the associatedOnShutdownRunner closes

    The state set when the associatedOnShutdownRunner closes

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement
  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: BaseError)(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: BaseError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

  13. def fatalOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now fatally failed and the system should be restarted.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. def isDegrading: Boolean
    Definition Classes
    HealthQuasiComponent
  18. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  19. def isFatal: Boolean
    Definition Classes
    HealthQuasiComponent
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isOk: Boolean
    Definition Classes
    HealthQuasiComponent
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  26. def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit

    Triggers a refresh of the component's state, using newState to determine the new state.

    Triggers a refresh of the component's state, using newState to determine the new state. May return before the newState has been evaluated and the listeners have been poked.

    Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.

    Attributes
    protected
    Definition Classes
    HealthElement
  27. def registerOnHealthChange(listener: HealthListener): Boolean

    Registers a listener that gets poked upon each change of this element's health state.

    Registers a listener that gets poked upon each change of this element's health state.

    returns

    Whether the listener was not registered before

    Definition Classes
    HealthElement
  28. def reportHealthState(state: State)(implicit tc: TraceContext): Unit

    Sets the state of this component and notifies its listeners

    Sets the state of this component and notifies its listeners

    Definition Classes
    AtomicHealthElement
  29. def resolveUnhealthy()(implicit traceContext: TraceContext): Unit

    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.

  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. 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
    Deprecated

Inherited from HealthComponent

Inherited from HealthQuasiComponent

Inherited from AtomicHealthElement

Inherited from HealthElement

Inherited from AnyRef

Inherited from Any

Ungrouped