Packages

class DirectSequencerConnectionXPool extends SequencerConnectionXPool

This connection pool is meant to be used to create a sequencer client that connects directly to an in-process sequencer. Needed for cases when the sequencer node itself needs to listen to specific events such as identity events.

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

Instance Constructors

  1. new DirectSequencerConnectionXPool(sequencer: Sequencer, mySynchronizerId: PhysicalSynchronizerId, sequencerId: SequencerId, staticParameters: StaticSynchronizerParameters, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContextExecutor)

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. val config: SequencerConnectionXPoolConfig

    Return the current configuration of the pool.

    Return the current configuration of the pool.

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  10. val contents: Map[SequencerId, Set[SequencerConnectionX]]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. def getAllConnections()(implicit traceContext: TraceContext): Seq[SequencerConnectionX]

    Obtain all the connections present in the pool.

    Obtain all the connections present in the pool.

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. 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
    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  17. def getOneConnectionPerSequencer(requester: String)(implicit traceContext: TraceContext): Map[SequencerId, SequencerConnectionX]

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

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

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. val health: SequencerConnectionXPoolHealth
  20. 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
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isThresholdStillReachable(threshold: PositiveInt, ignored: Set[ConnectionXConfig], extraUndecided: NonNegativeInt)(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.

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

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  23. 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
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DirectSequencerConnectionXPoolNamedLogging
  26. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  27. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. def nbConnections: NonNegativeInt

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

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

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  29. def nbSequencers: NonNegativeInt

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

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

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  34. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. 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
  37. 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.

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  38. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  39. 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
  40. 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
  41. 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
  42. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

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

  43. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  44. 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.

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  45. 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

  46. 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
  47. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  48. 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

  49. 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

  50. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DirectSequencerConnectionXPoolFlagCloseable
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. 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()
  55. 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.

    Definition Classes
    DirectSequencerConnectionXPoolSequencerConnectionXPool
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. 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