com.digitalasset.canton.synchronizer.sequencing.traffic
TrafficPurchasedManager
Companion object TrafficPurchasedManager
class TrafficPurchasedManager extends NamedLogging with FlagCloseable with HasCloseContext
Manages traffic purchased entries for sequencer members. This borrows concepts from topology management, in a simplified way. There is no "change delay", which has the direct consequence that traffic purchased entry updates need to be processed sequentially before subsequent messages read in the BlockUpdateGenerator can be processed. We also only here keep track of the latest *few* balance updates for each member in memory. Older traffic states will have to be fetched from the database. Traffic purchased entries can be automatically pruned from the cache AND the store according to pruningRetentionWindow.
- Alphabetic
- By Inheritance
- TrafficPurchasedManager
- HasCloseContext
- PromiseUnlessShutdownFactory
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TrafficPurchasedManager(store: TrafficPurchasedStore, trafficConfig: SequencerTrafficConfig, futureSupervisor: FutureSupervisor, sequencerMetrics: SequencerMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)
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
- def addTrafficPurchased(balance: TrafficPurchased)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
Add a new traffic purchased entry to the store and the cache.
Add a new traffic purchased entry to the store and the cache. TrafficPurchased with a serial less or equal to the most recent one will be ignored. Together with tick, this method expects to be called sequentially with balances in increasing order of sequencingTimestamp. This method MUST NOT be called concurrently.
- 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
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getLatestKnownBalance(member: Member)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[TrafficPurchased]]
Return the latest known balance for the given member.
- def getTrafficPurchasedAt(member: Member, desired: CantonTimestamp, lastSeenO: Option[CantonTimestamp] = None, warnIfApproximate: Boolean = true)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TrafficPurchasedManagerError, Option[TrafficPurchased]]
Return the traffic purchased entry valid at the given timestamp for the given member.
Return the traffic purchased entry valid at the given timestamp for the given member. TrafficPurchased are cached in this class, according to the cache size defined in trafficConfig. Requesting balances for timestamps outside of the cache will trigger a lookup in the database. The balances in this class are updated after they've been processed and validated by the sequencer client, however they can be queried on the sequencer read path. To avoid providing incorrect balance values while balance updates are "in-flight" (as in being processed by the sequencer client), the parameter lastSeen0 can be provided. This parameter indicates to the function the youngest timestamp for which the caller thinks a balance update might have been sequenced. This allows this function to compare this timestamp with the internal state, and if necessary, wait for the potential update before providing the balance. Note that if requesting a traffic purchased entry at a timestamp that has already been pruned, the function will return an error.
- member
member to request the traffic purchased entry for
- desired
the timestamp for which the balance is requested
- lastSeenO
the youngest timestamp for which the caller thinks a balance update might have been sequenced
- warnIfApproximate
if no lastSeen0 is provided, and the desired timestamp is more recent than the last update, a warning will be logged if this is true
- returns
the traffic purchased entry valid at the given timestamp for the given member, or empty if no balance exists for that member
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initialize(implicit tc: TraceContext): FutureUnlessShutdown[Unit]
Initializes the traffic manager lastUpdateAt with the initial timestamp from the store if it's not already set.
Initializes the traffic manager lastUpdateAt with the initial timestamp from the store if it's not already set. Call before using the manager.
- 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
- 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
- TrafficPurchasedManager → NamedLogging
- def maxTsO: Option[CantonTimestamp]
Timestamp of the last update made to the manager
- 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
success
on the returned promise but rather usetrySuccess
. The reason is that the call tosuccess
may 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
- Definition Classes
- TrafficPurchasedManager → 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 prune(upToExclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[String]
Prune traffic purchased for members such as it can be queried for timestamps as old as "timestamp"
- 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 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
'scloseAsync
method completes or whenAutoCloseable
'sclose
method returns, unless the returnedLifeCycleRegistrationHandle
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
- 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
'scloseAsync
method completes orAutoCloseable
'sclose
returns. 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
- val store: TrafficPurchasedStore
- lazy val subscription: SequencerTrafficControlSubscriber
- 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 untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as 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
f
has 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
Future
s instead ofFutureUnlessShutdown
s.Convenience method for synchronizing on
Future
s instead ofFutureUnlessShutdown
s. 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
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 untilf
has finished or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as 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
f
has 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
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 untilf
has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatience
has elapsed.DO NOT CALL
this.close
as 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
f
has 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
- def tick(timestamp: CantonTimestamp)(implicit tc: TraceContext): Unit
Notify this class that the provided timestamp has been observed by the sequencer client.
Notify this class that the provided timestamp has been observed by the sequencer client. Together with addTrafficPurchased, this method is expected to be called sequentially with increasing timestamps.
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- TrafficPurchasedManager → 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
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 inHasSynchronizeWithClosing
. 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()
- 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