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.
- Alphabetic
- By Inheritance
- CantonNodeBootstrapX
- CantonNodeBootstrapCommon
- NoTracing
- HasCloseContext
- CantonNodeBootstrap
- NamedLogging
- FlagCloseable
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CantonNodeBootstrapX(arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics])(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Abstract Value Members
- abstract def customNodeStages(storage: Storage, crypto: Crypto, nodeId: UniqueIdentifier, manager: TopologyManagerX, healthReporter: GrpcHealthReporter, healthService: HealthService): BootstrapStageOrLeaf[T]
- Attributes
- protected
- abstract def member(uid: UniqueIdentifier): Member
member depends on node type
member depends on node type
- Attributes
- protected
- abstract def mkNodeHealthService(storage: Storage): HealthService
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
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
- implicit val actorSystem: ActorSystem
- Definition Classes
- CantonNodeBootstrapCommon
- val adminApiConfig: AdminServerConfig
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val adminServer: CloseableServer
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val adminServerRegistry: CantonMutableHandlerRegistry
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val arguments: CantonNodeBootstrapCommonArguments[NodeConfig, ParameterConfig, Metrics]
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val bootstrapStageCallback: Callback { val queue: com.digitalasset.canton.util.SimpleExecutionQueue }
- Attributes
- protected
- def clock: Clock
- Definition Classes
- CantonNodeBootstrapCommon → CantonNodeBootstrap
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def config: NodeConfig
- Definition Classes
- CantonNodeBootstrapCommon
- def connectionPoolForParticipant: Boolean
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- 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
- CantonNodeBootstrapX → CantonNodeBootstrap
- val cryptoConfig: CryptoConfig
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- implicit val executionContext: ExecutionContextIdlenessExecutorService
- Definition Classes
- CantonNodeBootstrapCommon
- def futureSupervisor: FutureSupervisor
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getId: Option[NodeId]
- Definition Classes
- CantonNodeBootstrapX → CantonNodeBootstrap
- def getNode: Option[T]
- Definition Classes
- CantonNodeBootstrapX → CantonNodeBootstrap
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val initConfig: InitConfigBase
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val initQueue: SimpleExecutionQueue
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val ips: IdentityProvidingServiceClient
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- def isActive: Boolean
- Definition Classes
- CantonNodeBootstrapX → CantonNodeBootstrap
- 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
- def isInitialized: Boolean
- Definition Classes
- CantonNodeBootstrapX → CantonNodeBootstrap
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- def loggerFactory: NamedLoggerFactory
- Definition Classes
- CantonNodeBootstrapCommon → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def mkHealthComponents(nodeHealthService: HealthService): (GrpcHealthReporter, Option[GrpcHealthServer])
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- def name: InstanceName
- Definition Classes
- CantonNodeBootstrapCommon → CantonNodeBootstrap
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def onClosed(): Unit
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapX → FlagCloseable
- def parameterConfig: ParameterConfig
- Definition Classes
- CantonNodeBootstrapCommon
- def parameters: ParameterConfig
- Definition Classes
- CantonNodeBootstrapCommon
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, 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
- 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
- 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. Bothetf
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 afteretf
completes, but other tasks may execute concurrently withetf
, 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 ofetf
, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, 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
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- FlagCloseable
- def registerHealthGauge(): Unit
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- implicit val scheduler: ScheduledExecutorService
- Definition Classes
- CantonNodeBootstrapCommon
- 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
- def start(): EitherT[Future, String, Unit]
- Definition Classes
- CantonNodeBootstrapX → CantonNodeBootstrap
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeouts: ProcessingTimeout
- Definition Classes
- CantonNodeBootstrapCommon → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- implicit val tracer: Tracer
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- val tracerProvider: TracerProvider
- Attributes
- protected
- Definition Classes
- CantonNodeBootstrapCommon
- 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])
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable