class SequencerSubscriptionPoolHealth extends AtomicHealthComponent
- Alphabetic
- By Inheritance
- SequencerSubscriptionPoolHealth
- AtomicHealthComponent
- HealthComponent
- HealthQuasiComponent
- AtomicHealthElement
- HealthElement
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SequencerSubscriptionPoolHealth(name: String, associatedHasRunOnClosing: HasRunOnClosing, logger: TracedLogger)
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
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val 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
- SequencerSubscriptionPoolHealth → HealthElement
- 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
- 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!
- Definition Classes
- AtomicHealthComponent
- def degradationOccurred(error: RpcError)(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!
- Definition Classes
- AtomicHealthComponent
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def failureOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- AtomicHealthComponent
- def failureOccurred(error: RpcError)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- AtomicHealthComponent
- def fatalOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now fatally failed and the system should be restarted.
Report that the component is now fatally failed and the system should be restarted.
- Definition Classes
- AtomicHealthComponent
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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()
- val initialHealthState: ComponentHealthState
The initial state upon creation
The initial state upon creation
- Attributes
- protected
- Definition Classes
- SequencerSubscriptionPoolHealth → HealthElement
- 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
- val logger: TracedLogger
- Attributes
- protected
- Definition Classes
- SequencerSubscriptionPoolHealth → HealthElement
- val name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- SequencerSubscriptionPoolHealth → HealthElement
- 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 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 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
- 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.
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.
- Definition Classes
- AtomicHealthComponent
- 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])