Packages

trait SequencerConnectionXPool extends FlagCloseable with NamedLogging

Pool of sequencer connections.

The pool is initialized with a configuration describing the individual connections information (endpoint, TLS, etc.) and a trust threshold.

The connections information can combine connections to different logical sequencers (sequencer ID) as well as multiple endpoints for the same logical sequencer, which allows for high-availability for a given sequencer. The contents of the pool then distinguishes between the number of logical sequencers represented nbSequencers and the number of individual connections nbConnections.

The trust threshold has the following functions:

  • It represents the number of connections (to different logical sequencers) that must be validated (see com.digitalasset.canton.sequencing.InternalSequencerConnectionX.SequencerConnectionXState.Validated) and agree on bootstrap information (synchronizer ID, static parameters) before the pool is initialized and starts serving connections.
  • It is the threshold determining the pool's health. After initialization and during the life of the pool, connections will be removed as they fail and added as they recover. The pool is then considered healthy if the number of connections (to different logical sequencers) is >= the threshold, degraded if it is below, and failing if it reaches 0.

The configuration can also optionally define an expected com.digitalasset.canton.topology.PhysicalSynchronizerId. If defined, any connection that does not report connecting to that synchronizer will be rejected. If undefined, the synchronizer ID will be determined by consensus once trust-threshold-many connections (to different logical sequencers) report the same synchronizer.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SequencerConnectionXPool
  2. NamedLogging
  3. FlagCloseable
  4. PerformUnlessClosing
  5. HasSynchronizeWithReaders
  6. HasSynchronizeWithClosing
  7. OnShutdownRunner
  8. HasRunOnClosing
  9. HasUnlessClosing
  10. AutoCloseable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def config: SequencerConnectionXPoolConfig

    Return the current configuration of the pool.

  2. abstract def contents: Map[SequencerId, Set[SequencerConnectionX]]
    Annotations
    @VisibleForTesting()
  3. abstract def getAllConnections()(implicit traceContext: TraceContext): Seq[SequencerConnectionX]

    Obtain all the connections present in the pool.

  4. abstract def getConnections(requester: String, nb: PositiveInt, exclusions: Set[SequencerId])(implicit traceContext: TraceContext): Set[SequencerConnectionX]

    Obtain a number of connections from the pool.

    Obtain a number of connections from the pool. The set of returned connections has the following properties:

    • it contains at most one connection per sequencer ID
    • the sequencer IDs represented are picked at random at every call
    • it may contain less than the requested number of connections if the current pool contents cannot satisfy the requirements
    • it excludes connections for sequencer IDs provided in exclusions
    • when the pool contains multiple connections for the same sequencer ID, the connection returned for that sequencer ID is chosen via round-robin
  5. abstract def getOneConnectionPerSequencer(requester: String)(implicit traceContext: TraceContext): Map[SequencerId, SequencerConnectionX]

    Obtain a single connection for each different sequencer ID present in the pool.

  6. abstract def health: SequencerConnectionXPoolHealth
  7. abstract def isThresholdStillReachable(threshold: PositiveInt, ignored: Set[ConnectionXConfig] = Set.empty, extraUndecided: NonNegativeInt = NonNegativeInt.zero)(implicit traceContext: TraceContext): Boolean

    Determine whether the connection pool can still reach the given threshold, ignoring the ignored connections and considering an additional extraUndecided number of undecided connections.

  8. abstract def loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    NamedLogging
  9. abstract def nbConnections: NonNegativeInt

    Return the number of connections present in the pool (>= nbSequencers).

  10. abstract def nbSequencers: NonNegativeInt

    Return the number of different sequencerIds present in the pool (connections for the same sequencerId count for 1).

  11. abstract def physicalSynchronizerId: Option[PhysicalSynchronizerId]

    Return the synchronizer ID to which the connections in the pool are connected.

    Return the synchronizer ID to which the connections in the pool are connected. Empty if the pool has not yet reached enough validated connections to initialize.

  12. abstract def start()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SequencerConnectionXPoolError, Unit]

    Start the connection pool.

    Start the connection pool. This will start all the configured connections and begin validating them.

    returns

    A future that completes either when the connection pool has initialized and is serving connections, or when the initialization has timed out. The value of the timeout is defined by the com.digitalasset.canton.config.ProcessingTimeout.sequencerInfo configuration. In case of timeout, the pool is closed and unusable. A new connection pool must be created if desired.

  13. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    FlagCloseable
  14. abstract def updateConfig(newConfig: SequencerConnectionXPoolConfig)(implicit traceContext: TraceContext): Either[SequencerConnectionXPoolError, Unit]

    Dynamically update the pool configuration.

    Dynamically update the pool configuration. Changing the expected synchronizer ID is not supported and requires a node restart.

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 addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  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
    FlagCloseableOnShutdownRunner → AutoCloseable
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def isClosing: Boolean

    Check whether we're closing.

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

    Definition Classes
    OnShutdownRunnerHasUnlessClosing
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  17. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  19. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  26. 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
  27. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  28. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  29. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  30. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  31. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  32. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  33. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  34. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  35. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  36. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  37. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  38. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

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

    (Since version 9)

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped