class EnterpriseSequencerRateLimitManager extends SequencerRateLimitManager with NamedLogging with FlagCloseable
- Alphabetic
- By Inheritance
- EnterpriseSequencerRateLimitManager
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- NamedLogging
- SequencerRateLimitManager
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EnterpriseSequencerRateLimitManager(trafficPurchasedManager: TrafficPurchasedManager, trafficConsumedStore: TrafficConsumedStore, loggerFactory: NamedLoggerFactory, timeouts: ProcessingTimeout, metrics: SequencerMetrics, synchronizerSyncCryptoApi: SynchronizerCryptoClient, protocolVersion: ProtocolVersion, trafficConfig: SequencerTrafficConfig, sequencerMemberRateLimiterFactory: TrafficConsumedManagerFactory = DefaultTrafficConsumedManagerFactory, eventCostCalculator: EventCostCalculator)(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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def balanceKnownUntil: Option[CantonTimestamp]
Timestamp of the latest known state of traffic purchased entries.
Timestamp of the latest known state of traffic purchased entries.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- def balanceUpdateSubscriber: SequencerTrafficControlSubscriber
Optional subscriber to the traffic control processor, only used for the new top up implementation
Optional subscriber to the traffic control processor, only used for the new top up implementation
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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
- 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 getStates(requestedMembers: Set[Member], minTimestamp: Option[CantonTimestamp], lastSequencerEventTimestamp: Option[CantonTimestamp], warnIfApproximate: Boolean = true)(implicit executionContext: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[Map[Member, Either[String, TrafficState]]]
Return the latest known traffic states for the requested members, or all currently cached members if requestedMembers is empty.
Return the latest known traffic states for the requested members, or all currently cached members if requestedMembers is empty.
- minTimestamp
The minimum timestamp at which to get the traffic states. If the current known state is more recent than minTimestamp, it will be returned. If minTimestamp is more recent than the current known state, an APPROXIMATION of the state at minTimestamp will be used. Specifically, the base traffic remainder will be extrapolated to minTimestamp. There is no guarantee that the state returned will be the same as the correct one, when the synchronizer time actually reaches minTimestamp.
- lastSequencerEventTimestamp
timestamp of the last event addressed to the sequencer.
- returns
A Map of member and their traffic state.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- def getTrafficStateForMemberAt(member: Member, timestamp: CantonTimestamp, lastSequencerEventTimestamp: Option[CantonTimestamp])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TrafficNotFound, Option[TrafficState]]
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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
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 lastKnownBalanceFor(member: Member)(implicit traceContext: TraceContext): FutureUnlessShutdown[Option[TrafficPurchased]]
Returns the latest known balance for the given member.
Returns the latest known balance for the given member.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- EnterpriseSequencerRateLimitManager → NamedLogging
- 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
- EnterpriseSequencerRateLimitManager → 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]
Prunes traffic control data such as it can still be queried up to 'upToExclusive'.
Prunes traffic control data such as it can still be queried up to 'upToExclusive'.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- def registerNewMemberAt(member: Member, timestamp: CantonTimestamp, trafficControlParameters: TrafficControlParameters)(implicit tc: TraceContext): FutureUnlessShutdown[Unit]
Create a traffic state for a new member at the given timestamp.
Create a traffic state for a new member at the given timestamp. Its base traffic remainder will be equal to the max burst window configured at that point in time.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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 resetStateTo(timestampExclusive: CantonTimestamp)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
This method must be called during the crash recovery and must reset the state of rate limit manager to the state at the given timestamp (stores + internal state if there is i.e.
This method must be called during the crash recovery and must reset the state of rate limit manager to the state at the given timestamp (stores + internal state if there is i.e. a cache).
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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
- 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
- val timeouts: ProcessingTimeout
- Definition Classes
- EnterpriseSequencerRateLimitManager → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- val trafficConsumedStore: TrafficConsumedStore
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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()
- def validateRequestAndConsumeTraffic(request: SubmissionRequest, sequencingTime: CantonTimestamp, submissionTimestampO: Option[CantonTimestamp], latestSequencerEventTimestamp: Option[CantonTimestamp], warnIfApproximate: Boolean, orderingSequencerId: SequencerId)(implicit traceContext: TraceContext, closeContext: CloseContext): EitherT[FutureUnlessShutdown, SequencerRateLimitError, Option[TrafficReceipt]]
Validate submission requests after they've been sequenced.
Validate submission requests after they've been sequenced. The same validation as performed at submission is run again, to ensure that the submitting sequencer was not malicious. If the request is valid, the cost is consumed. This method MUST be called sequentially for a given sender, meaning concurrent updates are not supported. This method MUST be called in order of sequencing times, meaning 2 events sequenced at T1 and T2 such that T2 > T1 must be processed by this method in the order T1 -> T2. However, if T1 and T2 have been processed in the correct order, it is then ok to call the method with T1 again, which will result in the same output as when it was first called.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- def validateRequestAtSubmissionTime(request: SubmissionRequest, submissionTimestampO: Option[CantonTimestamp], lastSequencedTimestamp: CantonTimestamp, lastSequencerEventTimestamp: Option[CantonTimestamp])(implicit traceContext: TraceContext, closeContext: CloseContext): EitherT[FutureUnlessShutdown, SequencerRateLimitError, Unit]
Validate signed submission requests received by the sequencer.
Validate signed submission requests received by the sequencer. Requests with a an invalid cost or a cost that exceeds the traffic credit will be rejected.
- lastSequencerEventTimestamp
timestamp of the last event addressed to the sequencer.
- Definition Classes
- EnterpriseSequencerRateLimitManager → SequencerRateLimitManager
- 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