Packages

class EnterpriseSequencerRateLimitManager extends SequencerRateLimitManager with NamedLogging with FlagCloseable

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

Instance Constructors

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

  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 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  7. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. 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
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  16. def getTrafficStateForMemberAt(member: Member, timestamp: CantonTimestamp, lastSequencerEventTimestamp: Option[CantonTimestamp])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, TrafficNotFound, Option[TrafficState]]
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. 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
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. 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
  21. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  22. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    EnterpriseSequencerRateLimitManagerNamedLogging
  24. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  26. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. def onClosed(): Unit
  33. 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
    Annotations
    @SuppressWarnings()
  34. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    PerformUnlessClosing
  35. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    PerformUnlessClosing
  36. def performUnlessClosingCheckedUST[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[FutureUnlessShutdown, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[FutureUnlessShutdown, A, N, R]
    Definition Classes
    PerformUnlessClosing
  37. def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.

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

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  38. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  39. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  40. def performUnlessClosingEitherUSFAsync[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(asyncResultToWaitForF: (R) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    etf

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by etf

    Definition Classes
    PerformUnlessClosing
  41. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.

    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.

    f

    The task to perform

    returns

    The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.

    Definition Classes
    PerformUnlessClosing
  42. def performUnlessClosingOptionUSF[R](name: String)(otf: => OptionT[FutureUnlessShutdown, R])(implicit ec: ExecutionContext, traceContext: TraceContext): OptionT[FutureUnlessShutdown, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  44. def performUnlessClosingUSFAsync[A](name: String)(f: => FutureUnlessShutdown[A])(asyncResultToWaitForF: (A) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.

    f

    closing of this object will wait for all such spawned Futures to finish

    asyncResultToWaitForF

    closing of this object will wait also wait for all such asynchronous Futures to finish too

    returns

    the future spawned by f

    Definition Classes
    PerformUnlessClosing
  45. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  46. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  47. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  48. 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
  49. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  50. 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
  51. 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
  52. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

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

  53. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  54. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  55. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. val timeouts: ProcessingTimeout
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. val trafficConsumedStore: TrafficConsumedStore
  60. 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()
  61. def validateRequestAndConsumeTraffic(request: SubmissionRequest, sequencingTime: CantonTimestamp, submissionTimestampO: Option[CantonTimestamp], latestSequencerEventTimestamp: Option[CantonTimestamp], warnIfApproximate: Boolean, sequencerSignature: Signature)(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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  62. 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
    EnterpriseSequencerRateLimitManagerSequencerRateLimitManager
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. 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 FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from NamedLogging

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped