Packages

trait CommitmentQueue extends AnyRef

Manages the buffer (priority queue) for incoming commitments.

The priority is based on the timestamp of the end of the commitment's commitment period. Lower timestamps have higher priority.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommitmentQueue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def deleteThrough(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Deletes all commitments whose period ends at or before the given timestamp.

  2. abstract def enqueue(commitment: AcsCommitment)(implicit traceContext: TraceContext): Future[Unit]
  3. abstract def peekOverlapsForCounterParticipant(period: CommitmentPeriod, counterParticipant: ParticipantId)(implicit traceContext: TraceContext): Future[Seq[AcsCommitment]]

    Returns, if exists, a list containing all commitments originating from the given participant that overlap the given period.

    Returns, if exists, a list containing all commitments originating from the given participant that overlap the given period. Does not delete them from the queue.

    When the period covers a single reconciliation interval, there should be only one such commitment if the counter participant is correct; otherwise, the counter participant is malicious. The method is unaware of reconciliation intervals, however, thus cannot distinguish malicious behavior, and leaves this up to the caller. The caller (who has access to the reconciliation interval duration) should signal malicious behavior by emitting an AcsCommitmentAlarm if the list contains more than one element. Even with possible malicious behavior, the list of commitments might still be useful to the caller, for example if the list contains the expected commitment among all unexpected ones.

    However, the period passed to the method can cover several reconciliation intervals (e.g., when the caller participant hasn't heard from the sequencer in a while, and thus did not observe intermediate ticks). But the counter participant might have sent commitments for several reconciliation intervals in the period. Thus, in this case, the method returns a list and there is no malicious behavior.

  4. abstract def peekThrough(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[List[AcsCommitment]]

    Returns an unordered list of commitments whose period ends at or before the given timestamp.

    Returns an unordered list of commitments whose period ends at or before the given timestamp.

    Does not delete them from the queue.

  5. abstract def peekThroughAtOrAfter(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Seq[AcsCommitment]]

    Returns an unordered list of commitments whose period ends at or after the given timestamp.

    Returns an unordered list of commitments whose period ends at or after the given timestamp.

    Does not delete them from the queue.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped