c

com.digitalasset.canton.environment

CantonNodeBootstrapX

abstract class CantonNodeBootstrapX[T <: CantonNode, NodeConfig <: LocalNodeConfig, ParameterConfig <: CantonNodeParameters, Metrics <: BaseMetrics] extends CantonNodeBootstrapCommon[T, NodeConfig, ParameterConfig, Metrics]

CantonNodeBootstrapX trait insists that nodes have their own topology manager and that they have the ability to auto-initialize their identity on their own.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CantonNodeBootstrapX
  2. CantonNodeBootstrapCommon
  3. NoTracing
  4. HasCloseContext
  5. CantonNodeBootstrap
  6. NamedLogging
  7. FlagCloseable
  8. AutoCloseable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CantonNodeBootstrapX(arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics])(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem)

Type Members

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

Abstract Value Members

  1. abstract def customNodeStages(storage: Storage, crypto: Crypto, nodeId: UniqueIdentifier, manager: TopologyManagerX, healthReporter: GrpcHealthReporter, healthService: HealthService): BootstrapStageOrLeaf[T]
    Attributes
    protected
  2. abstract def member(uid: UniqueIdentifier): Member

    member depends on node type

    member depends on node type

    Attributes
    protected
  3. abstract def mkNodeHealthService(storage: Storage): HealthService
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon

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. implicit val actorSystem: ActorSystem
    Definition Classes
    CantonNodeBootstrapCommon
  5. val adminApiConfig: AdminServerConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  6. val adminServer: CloseableServer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  7. val adminServerRegistry: CantonMutableHandlerRegistry
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  8. val arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics]
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val bootstrapStageCallback: Callback { val queue: com.digitalasset.canton.util.SimpleExecutionQueue }
    Attributes
    protected
  11. def clock: Clock
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. 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()
  14. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  15. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  16. def config: NodeConfig
    Definition Classes
    CantonNodeBootstrapCommon
  17. def connectionPoolForParticipant: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  18. def crypto: Option[Crypto]

    Access to the private and public store to support local key inspection commands

    Access to the private and public store to support local key inspection commands

    Definition Classes
    CantonNodeBootstrapXCantonNodeBootstrap
  19. val cryptoConfig: CryptoConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Definition Classes
    CantonNodeBootstrapCommon
  24. def futureSupervisor: FutureSupervisor
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def getId: Option[NodeId]
  27. def getNode: Option[T]
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. val initConfig: InitConfigBase
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  30. val initQueue: SimpleExecutionQueue
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  31. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  32. val ips: IdentityProvidingServiceClient
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  33. def isActive: Boolean
  34. 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
  35. def isInitialized: Boolean
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. 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
  38. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. def loggerFactory: NamedLoggerFactory
  40. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  41. def mkHealthComponents(nodeHealthService: HealthService): (GrpcHealthReporter, Option[GrpcHealthServer])
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  42. def name: InstanceName
  43. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  49. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapXFlagCloseable
  50. def parameterConfig: ParameterConfig
    Definition Classes
    CantonNodeBootstrapCommon
  51. def parameters: ParameterConfig
    Definition Classes
    CantonNodeBootstrapCommon
  52. 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
  53. 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
  54. 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
  55. 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
  56. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  57. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  58. 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
  59. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  60. def registerHealthGauge(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  61. 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
  62. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  63. implicit val scheduler: ScheduledExecutorService
    Definition Classes
    CantonNodeBootstrapCommon
  64. def sequencedTopologyStores: Seq[TopologyStoreX[TopologyStoreId]]

    callback for topology read service

    callback for topology read service

    this callback must be implemented by all node types, providing access to the domain topology stores which are only available in a later startup stage (domain nodes) or in the node runtime itself (participant sync domain)

    Attributes
    protected
  65. def start(): EitherT[Future, String, Unit]
  66. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  67. def timeouts: ProcessingTimeout
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  70. implicit val tracer: Tracer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  71. val tracerProvider: TracerProvider
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. 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 CantonNodeBootstrapCommon[T, NodeConfig, ParameterConfig, Metrics]

Inherited from NoTracing

Inherited from HasCloseContext

Inherited from CantonNodeBootstrap[T]

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped