Packages

class ParticipantNodeBootstrapX extends CantonNodeBootstrapX[ParticipantNodeX, LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics] with ParticipantNodeBootstrapCommon

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantNodeBootstrapX
  2. ParticipantNodeBootstrapCommon
  3. CantonNodeBootstrapX
  4. CantonNodeBootstrapCommon
  5. NoTracing
  6. HasCloseContext
  7. PromiseUnlessShutdownFactory
  8. CantonNodeBootstrap
  9. NamedLogging
  10. FlagCloseable
  11. PerformUnlessClosing
  12. OnShutdownRunner
  13. AutoCloseable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ParticipantNodeBootstrapX(arguments: CantonNodeBootstrapCommonArguments[LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics], engine: Engine, cantonSyncServiceFactory: Factory[CantonSyncService], setStartableStoppableLedgerApiAndCantonServices: (StartableStoppableLedgerApiServer, StartableStoppableLedgerApiDependentServices) => Unit, resourceManagementServiceFactory: (Eval[ParticipantSettingsStore]) => ResourceManagementService, replicationServiceFactory: (Storage) => ServerServiceDefinition, createSchedulers: (ParticipantSchedulersParameters) => Future[SchedulersWithParticipantPruning] = _ => Future.successful(SchedulersWithParticipantPruning.noop), persistentStateFactory: ParticipantNodePersistentStateFactory, ledgerApiServerFactory: CantonLedgerApiServerFactory, skipRecipientsCheck: Boolean)(implicit executionContext: ExecutionContextIdlenessExecutorService, scheduler: ScheduledExecutorService, actorSystem: ActorSystem, executionSequencerFactory: ExecutionSequencerFactory)

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[LocalParticipantConfig, ParticipantNodeParameters, ParticipantMetrics]
    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
    Definition Classes
    CantonNodeBootstrapX
  11. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  12. def clock: Clock
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  15. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  16. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  17. def config: LocalParticipantConfig
  18. def connectionPoolForParticipant: Boolean
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  19. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  20. def createParticipantServices(participantId: ParticipantId, crypto: Crypto, storage: Storage, persistentStateFactory: ParticipantNodePersistentStateFactory, engine: Engine, ledgerApiServerFactory: CantonLedgerApiServerFactory, indexedStringStore: IndexedStringStore, cantonSyncServiceFactory: Factory[CantonSyncService], setStartableStoppableLedgerApiAndCantonServices: (StartableStoppableLedgerApiServer, StartableStoppableLedgerApiDependentServices) => Unit, resourceManagementServiceFactory: (Eval[ParticipantSettingsStore]) => ResourceManagementService, replicationServiceFactory: (Storage) => ServerServiceDefinition, createSchedulers: (ParticipantSchedulersParameters) => Future[SchedulersWithParticipantPruning], createPartyNotifierAndSubscribe: (ParticipantEventPublisher) => LedgerServerPartyNotifier, adminToken: CantonAdminToken, topologyManager: ParticipantTopologyManagerOps, packageDependencyResolver: PackageDependencyResolver, componentFactory: ParticipantComponentBootstrapFactory, skipRecipientsCheck: Boolean, overrideKeyUniqueness: Option[Boolean] = None)(implicit executionSequencerFactory: ExecutionSequencerFactory): EitherT[FutureUnlessShutdown, String, (LedgerServerPartyNotifier, CantonSyncService, ParticipantNodeEphemeralState, LedgerApiServerState, StartableStoppableLedgerApiDependentServices, SchedulersWithParticipantPruning, ParticipantTopologyDispatcherCommon)]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  21. 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
  22. val cryptoConfig: CryptoConfig
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  23. def customNodeStages(storage: Storage, crypto: Crypto, nodeId: UniqueIdentifier, manager: AuthorizedTopologyManagerX, healthReporter: GrpcHealthReporter, healthService: HealthService): BootstrapStageOrLeaf[ParticipantNodeX]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapXCantonNodeBootstrapX
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Definition Classes
    CantonNodeBootstrapCommon
  28. def futureSupervisor: FutureSupervisor
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def getId: Option[NodeId]
  31. def getNode: Option[ParticipantNodeX]
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. val initConfig: InitConfigBase
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  34. val initQueue: SimpleExecutionQueue
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  35. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. val ips: IdentityProvidingServiceClient
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  37. def isActive: Boolean
  38. 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
    OnShutdownRunner
  39. def isInitialized: Boolean
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. 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
    PerformUnlessClosing
  42. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. def loggerFactory: NamedLoggerFactory
  44. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  45. def member(uid: UniqueIdentifier): Member

    member depends on node type

    member depends on node type

    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapXCantonNodeBootstrapX
  46. def mkHealthComponents(nodeHealthService: HealthService): (GrpcHealthReporter, Option[GrpcHealthServer], HealthService)
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  47. def mkNodeHealthService(storage: Storage): HealthService
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapXCantonNodeBootstrapCommon
  48. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  49. def name: InstanceName
  50. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  56. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapXPerformUnlessClosing
  57. final def onFirstClose(): 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  58. def parameterConfig: ParticipantNodeParameters
    Definition Classes
    CantonNodeBootstrapCommon
  59. def parameters: ParticipantNodeParameters
    Definition Classes
    CantonNodeBootstrapCommon
  60. 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
    PerformUnlessClosing
  61. 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
    PerformUnlessClosing
  62. 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
    PerformUnlessClosing
  63. 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
    PerformUnlessClosing
  64. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  65. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  66. 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
    PerformUnlessClosing
  67. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  68. val recordSequencerInteractions: AtomicReference[Option[RecordingConfig]]

    If set to Some(path), every sequencer client will record all received events to the directory path.

    If set to Some(path), every sequencer client will record all received events to the directory path.

    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  69. def registerHealthGauge(): Unit
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  70. val replaySequencerConfig: AtomicReference[Option[ReplayConfig]]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapCommon
  71. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  72. 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
    OnShutdownRunner
  73. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  74. implicit val scheduler: ScheduledExecutorService
    Definition Classes
    CantonNodeBootstrapCommon
  75. def sequencedTopologyManagers: Seq[DomainTopologyManagerX]
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapXCantonNodeBootstrapX
  76. def sequencedTopologyStores: Seq[TopologyStoreX[DomainStore]]

    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
    Definition Classes
    ParticipantNodeBootstrapXCantonNodeBootstrapX
  77. def setPostInitCallbacks(sync: CantonSyncService): Unit
    Attributes
    protected
    Definition Classes
    ParticipantNodeBootstrapXParticipantNodeBootstrapCommon
  78. def start(): EitherT[Future, String, Unit]
  79. lazy val syncDomainEphemeralHealth: MutableHealthComponent
  80. lazy val syncDomainHealth: MutableHealthComponent
  81. lazy val syncDomainSequencerClientHealth: MutableHealthComponent
  82. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  83. def timeouts: ProcessingTimeout
  84. def toString(): String
    Definition Classes
    AnyRef → Any
  85. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  86. implicit val tracer: Tracer
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  87. val tracerProvider: TracerProvider
    Attributes
    protected
    Definition Classes
    CantonNodeBootstrapCommon
  88. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  89. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  90. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Ungrouped