trait CompositeHealthComponent[ID, HE <: HealthElement] extends CompositeHealthElement[ID, HE] with HealthComponent
- Alphabetic
- By Inheritance
- CompositeHealthComponent
- HealthComponent
- HealthQuasiComponent
- CompositeHealthElement
- HealthElement
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type State = ComponentHealthState
The type of health states exposed by this component
The type of health states exposed by this component
- Definition Classes
- HealthComponent → HealthQuasiComponent → HealthElement
Abstract Value Members
- abstract def associatedHasRunOnClosing: HasRunOnClosing
The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.
The com.digitalasset.canton.lifecycle.HasRunOnClosing associated with this object.
When this com.digitalasset.canton.lifecycle.HasRunOnClosing closes, the health state permanently becomes closingState and all listeners are notified about this.
- Attributes
- protected
- Definition Classes
- HealthElement
- abstract def combineDependentStates: State
Fetch the current states from the relevant dependencies and combine them into the new state to report for this element.
Fetch the current states from the relevant dependencies and combine them into the new state to report for this element.
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- abstract def initialHealthState: State
The initial state upon creation
The initial state upon creation
- Attributes
- protected
- Definition Classes
- HealthElement
- abstract def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- HealthElement
- abstract def name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- HealthElement
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def alterDependencies(remove: Set[ID], add: Map[ID, HE]): Unit
First removes all dependencies in
remove, then adds all those inadd.First removes all dependencies in
remove, then adds all those inadd. If anIDappears inremoveandadd, then theIDis replaced. Refreshes the state if any of the dependencies was changed.Updates of
dependenciesare not atomic: If this method is called concurrently multiple times, the resulting dependencies may not correspond to a serializable execution.If an dependency triggers a concurrent state refresh, then the state refresh may see an inconsistent set of dependencies and therefore derive an inconsistent state. This however is only temporary as in this case another state refresh will be triggered at the end.
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def closingState: ComponentHealthState
The state set when the associatedHasRunOnClosing closes
The state set when the associatedHasRunOnClosing closes
- Definition Classes
- HealthComponent → HealthQuasiComponent → HealthElement
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDependencies: Map[ID, HE]
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- final def getState: State
Returns the current state
Returns the current state
- Definition Classes
- HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def isDegraded: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFailed: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFatal: Boolean
- Definition Classes
- HealthQuasiComponent
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isOk: Boolean
- Definition Classes
- HealthQuasiComponent
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def prettyState: Pretty[State]
- Attributes
- protected
- Definition Classes
- HealthQuasiComponent → HealthElement
- def refreshFromDependencies()(implicit traceContext: TraceContext): Unit
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit
Triggers a refresh of the component's state, using
newStateto determine the new state.Triggers a refresh of the component's state, using
newStateto determine the new state. May return before thenewStatehas 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
- def registerHighPriorityOnHealthChange(listener: HealthListener): Boolean
Registers a high priority listener that gets poked upon each change of this element's health state.
Registers a high priority listener that gets poked upon each change of this element's health state. This listener will be run before listeners registered via registerOnHealthChange
- returns
Whether the listener was not registered before
- Definition Classes
- HealthElement
- def registerOnHealthChange(listener: HealthListener, pokeIfNew: Boolean = true): 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.
- pokeIfNew
if true (default), poke the listener if it's new
- returns
Whether the listener was not registered before
- Definition Classes
- HealthElement
- def removeDependency(id: ID): Unit
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- def setDependency(id: ID, dependency: HE): Unit
- Attributes
- protected
- Definition Classes
- CompositeHealthElement
- def stateLoggingLevel(state: ComponentHealthState): Level
- Attributes
- protected
- Definition Classes
- HealthComponent → HealthElement
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toComponentStatus: ComponentStatus
- Definition Classes
- HealthQuasiComponent
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unregisterOnHealthChange(listener: HealthListener): Boolean
Unregisters a listener.
Unregisters a listener.
- returns
Whether the listener was registered before.
- Definition Classes
- HealthElement
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])