class ParticipantNodes[PC <: LocalParticipantConfig] extends ManagedNodes[ParticipantNode, PC, ParticipantNodeParameters, ParticipantNodeBootstrap]

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

Instance Constructors

  1. new ParticipantNodes(create: (String, PC) => ParticipantNodeBootstrap, migrationsFactory: DbMigrationsFactory, timeouts: ProcessingTimeout, configs: Map[String, PC], parametersFor: (String) => ParticipantNodeParameters, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContextIdlenessExecutorService)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def attemptStartAll(implicit traceContext: TraceContext): Either[StartupError, Unit]

    Start all configured nodes but stop on first error

    Start all configured nodes but stop on first error

    Definition Classes
    ManagedNodesNodes
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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()
  8. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. implicit val executionContext: ExecutionContextIdlenessExecutorService
    Attributes
    protected
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def getRunning(name: String): Option[ParticipantNodeBootstrap]

    Get the single running node

    Get the single running node

    Definition Classes
    ManagedNodesNodes
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  17. 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
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isRunning(name: String): Boolean

    Is the named node running?

    Is the named node running?

    Definition Classes
    ManagedNodesNodes
  20. 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
  21. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ManagedNodesNamedLogging
  23. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. def migrateDatabase(name: String): Either[StartupError, Unit]

    Independently run any pending database migrations for the named node

    Independently run any pending database migrations for the named node

    Definition Classes
    ParticipantNodesManagedNodesNodes
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def onClosed(): Unit
    Definition Classes
    ManagedNodesFlagCloseable
  30. def performUnlessClosing[A](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.

    f

    The task to perform

    returns

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

    Definition Classes
    FlagCloseable
  31. def performUnlessClosingEitherT[E, R](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.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  32. def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  33. def performUnlessClosingF[A](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.

    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
  34. def repairDatabaseMigration(name: String): Either[StartupError, Unit]

    Independently repair the Flyway schema history table for the named node to reset Flyway migration checksums etc

    Independently repair the Flyway schema history table for the named node to reset Flyway migration checksums etc

    Definition Classes
    ManagedNodesNodes
  35. def runIfUsingDatabase[F[_]](storageConfig: StorageConfig)(fn: (DbConfig) => F[Either[StartupError, Unit]])(implicit F: Applicative[F]): F[Either[StartupError, Unit]]
    Attributes
    protected
    Definition Classes
    ManagedNodes
  36. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  37. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  38. def running: Seq[ParticipantNodeBootstrap]

    Get nodes that are currently running

    Get nodes that are currently running

    Definition Classes
    ManagedNodesNodes
  39. def sleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  40. def start(name: String)(implicit traceContext: TraceContext): Either[StartupError, ParticipantNodeBootstrap]

    Start an individual node by name

    Start an individual node by name

    Definition Classes
    ManagedNodesNodes
  41. def startAll(implicit traceContext: TraceContext): Either[Seq[StartupError], Unit]

    Start all nodes regardless if some fail

    Start all nodes regardless if some fail

    Definition Classes
    ManagedNodesNodes
  42. def stop(name: String): Either[ShutdownError, Unit]

    Stop the named node

    Stop the named node

    Definition Classes
    ManagedNodesNodes
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    ManagedNodesFlagCloseable
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. 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

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped