c

com.digitalasset.canton.environment

BootstrapStageWithStorage

abstract class BootstrapStageWithStorage[T <: CantonNode, StageResult <: BootstrapStageOrLeaf[T], M] extends BootstrapStage[T, StageResult]

Bootstrap stage which does auto-init / write operations and might eventually be passive

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BootstrapStageWithStorage
  2. BootstrapStage
  3. BootstrapStageOrLeaf
  4. HasCloseContext
  5. NamedLogging
  6. FlagCloseable
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BootstrapStageWithStorage(description: String, bootstrap: Callback, storage: Storage, autoInit: Boolean)(implicit executionContext: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Abstract Value Members

  1. abstract def autoCompleteStage(): EitherT[FutureUnlessShutdown, String, Option[M]]

    if the stage didn't complete yet, the node is active and auto-init is set to true, perform the steps necessary.

    if the stage didn't complete yet, the node is active and auto-init is set to true, perform the steps necessary. note, this invocation will be thread safe and only run once however, any implementation needs to be crash resilient, if it didn't complete fully, it might be called again. if this stage does not support auto-init, you must return None the method may throw "PassiveInstanceException" if it becomes passive

    Attributes
    protected
  2. abstract def buildNextStage(result: M): StageResult

    given the result of this stage, create the next stage

    given the result of this stage, create the next stage

    Attributes
    protected
  3. abstract def stageCompleted(implicit traceContext: TraceContext): Future[Option[M]]

    test whether the stage is completed already through a previous init.

    test whether the stage is completed already through a previous init. if so, return result

    Attributes
    protected

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. def addCloseable[C <: AutoCloseable](item: C): Unit

    can be used to track closeables created with this class that should be cleaned up after this stage

    can be used to track closeables created with this class that should be cleaned up after this stage

    Attributes
    protected
    Definition Classes
    BootstrapStage
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def attempt()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Option[StageResult]]

    main handler to implement where we attempt to init this stage if we return None, then the init was okay but stopped at this level (waiting for further input)

    main handler to implement where we attempt to init this stage if we return None, then the init was okay but stopped at this level (waiting for further input)

    Definition Classes
    BootstrapStageWithStorageBootstrapStage
  7. def attemptAndStore()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Option[StageResult]]

    the attempt and store handler that runs sequential on the init queue it will attempt to create the next stage and store it in the current atomic reference

    the attempt and store handler that runs sequential on the init queue it will attempt to create the next stage and store it in the current atomic reference

    Attributes
    protected
    Definition Classes
    BootstrapStage
  8. val bootstrap: Callback
    Definition Classes
    BootstrapStageBootstrapStageOrLeaf
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. final def close(): Unit

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Blocks until all earlier tasks have completed and then prevents further tasks from being run.

    Definition Classes
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  11. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  12. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  13. def completeWithExternal(storeAndPassResult: => EitherT[Future, String, M])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    if external input is necessary

    if external input is necessary

    Attributes
    protected
  14. def completeWithExternalUS(storeAndPassResult: => EitherT[FutureUnlessShutdown, String, M])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
    Attributes
    protected
  15. val description: String
    Definition Classes
    BootstrapStage
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getNode: Option[T]
    Definition Classes
    BootstrapStageBootstrapStageOrLeaf
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  23. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    FlagCloseable
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    FlagCloseable
  26. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    BootstrapStageOrLeafNamedLogging
  28. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  29. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def next: Option[StageResult]
    Definition Classes
    BootstrapStage
  32. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  36. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    BootstrapStageFlagCloseable
  37. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  38. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    FlagCloseable
  39. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  40. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  41. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  42. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  43. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    FlagCloseable
  44. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  45. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    FlagCloseable
  46. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  47. val stageResult: AtomicReference[Option[StageResult]]
    Attributes
    protected
    Definition Classes
    BootstrapStage
  48. def start()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]

    iterative start handler which will attempt to start the stages until we are either up and running or awaiting some init action by the user

    iterative start handler which will attempt to start the stages until we are either up and running or awaiting some init action by the user

    Definition Classes
    BootstrapStageWithStorageBootstrapStageBootstrapStageOrLeaf
  49. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  50. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    BootstrapStageOrLeafFlagCloseable
  51. def toBackgroundForPassiveNode()(implicit traceContext: TraceContext): Unit

    if a passive node hits a manual init step, it will return "start" is succeeded and wait in the background for the active node to finish the startup sequence

    if a passive node hits a manual init step, it will return "start" is succeeded and wait in the background for the active node to finish the startup sequence

    Attributes
    protected
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from BootstrapStage[T, StageResult]

Inherited from BootstrapStageOrLeaf[T]

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped