class DbSynchronizerConnectionConfigStore extends SynchronizerConnectionConfigStore with DbStore
- Alphabetic
 - By Inheritance
 
- DbSynchronizerConnectionConfigStore
 - DbStore
 - HasCloseContext
 - PromiseUnlessShutdownFactory
 - NamedLogging
 - FlagCloseable
 - PerformUnlessClosing
 - HasSynchronizeWithReaders
 - HasSynchronizeWithClosing
 - OnShutdownRunner
 - HasRunOnClosing
 - HasUnlessClosing
 - SynchronizerConnectionConfigStore
 - AutoCloseable
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - Protected
 
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
 
 -    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
 
 -    val aliasResolution: SynchronizerAliasResolution
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -   final  def asInstanceOf[T0]: T0
- Definition Classes
 - Any
 
 -    def clone(): AnyRef
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
 
 -   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 → OnShutdownRunner → AutoCloseable
 
 -   implicit  val closeContext: CloseContext
- Definition Classes
 - HasCloseContext
 
 -    def closingTimeout: FiniteDuration
- Attributes
 - protected
 - Definition Classes
 - FlagCloseable → PerformUnlessClosing
 
 -   implicit  val ec: ExecutionContext
- Attributes
 - protected
 - Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -   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
 
 -    def get(psid: PhysicalSynchronizerId): Either[UnknownPSId, StoredSynchronizerConnectionConfig]
Retrieves the config for a given id.
Retrieves the config for a given id. Will return an SynchronizerConnectionConfigStore.UnknownPSId error if there is no config for id.
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def get(alias: SynchronizerAlias, configuredPSId: ConfiguredPhysicalSynchronizerId): Either[MissingConfigForSynchronizer, StoredSynchronizerConnectionConfig]
Retrieves the config for a given alias and id.
Retrieves the config for a given alias and id. Will return an SynchronizerConnectionConfigStore.MissingConfigForSynchronizer error if there is no config for the pair (alias, id).
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def getActive(id: SynchronizerId): Either[Error, StoredSynchronizerConnectionConfig]
Retrieves the active connection for
id.Retrieves the active connection for
id. Return an SynchronizerConnectionConfigStore.Error if the id is unknown or if no connection is active. If several active configs are found, return the one with the highest com.digitalasset.canton.topology.PhysicalSynchronizerId.- Definition Classes
 - SynchronizerConnectionConfigStore
 
 -    def getActive(alias: SynchronizerAlias): Either[Error, StoredSynchronizerConnectionConfig]
Retrieves the active connection for
alias.Retrieves the active connection for
alias. Return an SynchronizerConnectionConfigStore.Error if the alias is unknown or if no connection is active. If several active configs are found, return the one with the highest com.digitalasset.canton.topology.PhysicalSynchronizerId.- Definition Classes
 - SynchronizerConnectionConfigStore
 
 -    def getAll(): Seq[StoredSynchronizerConnectionConfig]
Retrieves all configured synchronizers connection configs
Retrieves all configured synchronizers connection configs
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def getAllFor(alias: SynchronizerAlias): Either[UnknownAlias, NonEmpty[Seq[StoredSynchronizerConnectionConfig]]]
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def getAllFor(id: SynchronizerId): Either[UnknownId, NonEmpty[Seq[StoredSynchronizerConnectionConfig]]]
- Definition Classes
 - SynchronizerConnectionConfigStore
 
 -    def getAllForAliasInternal(alias: SynchronizerAlias)(implicit traceContext: TraceContext): FutureUnlessShutdown[Seq[StoredSynchronizerConnectionConfig]]
- Attributes
 - protected
 - Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def getAllStatusesFor(id: SynchronizerId): Either[UnknownId, NonEmpty[Seq[Status]]]
- Definition Classes
 - SynchronizerConnectionConfigStore
 
 -   final  def getClass(): Class[_ <: AnyRef]
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def hashCode(): Int
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    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
performUnlessClosingand friends.- Definition Classes
 - OnShutdownRunner → HasUnlessClosing
 
 -   final  def isInstanceOf[T0]: Boolean
- Definition Classes
 - Any
 
 -    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
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -    def logger: TracedLogger
- Attributes
 - protected
 - Definition Classes
 - NamedLogging
 
 -    val loggerFactory: NamedLoggerFactory
- Attributes
 - protected
 - Definition Classes
 - DbSynchronizerConnectionConfigStore → NamedLogging
 
 -    def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): 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
successon the returned promise but rather usetrySuccess. The reason is that the call tosuccessmay fail in case of shutdown.- Definition Classes
 - PromiseUnlessShutdownFactory
 
 -    def nameInternal: String
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -   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
 - @IntrinsicCandidate() @native()
 
 -   final  def notifyAll(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def onCloseFailure(e: Throwable): Unit
- Attributes
 - protected
 - Definition Classes
 - PerformUnlessClosing
 
 -    def onClosed(): Unit
- Attributes
 - protected
 - Definition Classes
 - PerformUnlessClosing
 
 -   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
 - PerformUnlessClosing → OnShutdownRunner
 
 -    def predecessorCompatibilityCheck(configuredPSId: ConfiguredPhysicalSynchronizerId, synchronizerPredecessor: Option[SynchronizerPredecessor]): Either[Error, Unit]
Ensures a configured PSId can be the successor of another one.
Ensures a configured PSId can be the successor of another one.
- Attributes
 - protected
 - Definition Classes
 - SynchronizerConnectionConfigStore
 
 -    def put(config: SynchronizerConnectionConfig, status: Status, configuredPSId: ConfiguredPhysicalSynchronizerId, synchronizerPredecessor: Option[SynchronizerPredecessor])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]
Stores a synchronizer connection config together with the status.
Stores a synchronizer connection config together with the status. Primary identifier is the (synchronizer alias, physical synchronizer id). Will return an SynchronizerConnectionConfigStore.ConfigAlreadyExists error if a config for that alias and physical synchronizer id already exists.
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def refreshCache()(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
Dump and refresh all connection configs.
Dump and refresh all connection configs. Used when a warm participant replica becomes active to ensure it has accurate configs cached.
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def remainingReaders(): Seq[String]
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -    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
 
 -    def replace(configuredPSId: ConfiguredPhysicalSynchronizerId, config: SynchronizerConnectionConfig)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]
Replaces the config for the given alias and physical synchronizer id.
Replaces the config for the given alias and physical synchronizer id. Will return an SynchronizerConnectionConfigStore.MissingConfigForSynchronizer error if there is no config for the (alias, physicalSynchronizerId).
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    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'scloseAsyncmethod completes or whenAutoCloseable'sclosemethod returns, unless the returnedLifeCycleRegistrationHandlewas 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
 - OnShutdownRunner → HasRunOnClosing
 
 -    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'scloseAsyncmethod completes orAutoCloseable'sclosereturns. This is because the task is run immediately if the component has already been closed.- Definition Classes
 - HasRunOnClosing
 
 -   final  def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
 - HasRunOnClosing
 
 -    def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
 - protected[this]
 - Definition Classes
 - OnShutdownRunner → HasRunOnClosing
 
 -    def setPhysicalSynchronizerId(alias: SynchronizerAlias, psid: PhysicalSynchronizerId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    def setStatus(alias: SynchronizerAlias, configuredPSId: ConfiguredPhysicalSynchronizerId, status: Status)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Error, Unit]
Set the synchronizer configuration status
Set the synchronizer configuration status
- Definition Classes
 - DbSynchronizerConnectionConfigStore → SynchronizerConnectionConfigStore
 
 -    val storage: DbStorage
- Attributes
 - protected
 - Definition Classes
 - DbSynchronizerConnectionConfigStore → DbStore
 
 -    def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise it is the result of runningf.
- Definition Classes
 - HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns.Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
 - PerformUnlessClosing
 
 -    def synchronizeWithClosingPatience: FiniteDuration
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -    def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas finished or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run.
- Definition Classes
 - HasSynchronizeWithClosing
 - Annotations
 - @SuppressWarnings()
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise the result of runningf.
- Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -   final  def synchronized[T0](arg0: => T0): T0
- Definition Classes
 - AnyRef
 
 -    val timeouts: ProcessingTimeout
- Attributes
 - protected
 - Definition Classes
 - DbSynchronizerConnectionConfigStore → FlagCloseable
 
 -    def toString(): String
- Definition Classes
 - AnyRef → Any
 
 -   final  def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
faunless isClosing returns true.Runs the computation
faunless isClosing returns true.This method does not delay the closing while
fais running, unlike the methods inHasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
 The result of
faor com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
 - HasUnlessClosing
 - Annotations
 - @inline()
 
 -   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])
 
 -   final  def wait(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -    def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders