Packages

trait SequencerPruning extends AnyRef

Sequencer pruning interface.

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

Abstract Value Members

  1. abstract def acknowledge(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided.

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided. Makes earlier events for this member available for pruning. The timestamp is in sequencer time and will likely correspond to an event that the client has processed however this is not validated. It is assumed that members in consecutive calls will never acknowledge an earlier timestamp however this is also not validated (and could be invalid if the member has many subscriptions from the same or many processes). It is expected that members will periodically call this endpoint with their latest clean timestamp rather than calling it for every event they process. The default interval is in the range of once a minute.

    A member should only acknowledge timestamps it has actually received. The behaviour of the sequencer is implementation-defined when a member acknowledges a later timestamp.

    See also

    com.digitalasset.canton.sequencing.client.SequencerClientConfig.acknowledgementInterval for the default interval

  2. abstract def acknowledgeSigned(signedAcknowledgeRequest: SignedContent[AcknowledgeRequest])(implicit traceContext: TraceContext): EitherT[Future, String, Unit]

    Newer version of acknowledgements.

    Newer version of acknowledgements. To be active for protocol versions >= 4. The signature is checked on the server side to avoid that malicious sequencers create fake acknowledgements in multi-writer architectures where writers don't fully trust each other.

    Acknowledge that a member has successfully handled all events up to and including the timestamp provided. Makes earlier events for this member available for pruning. The timestamp is in sequencer time and will likely correspond to an event that the client has processed however this is not validated. It is assumed that members in consecutive calls will never acknowledge an earlier timestamp however this is also not validated (and could be invalid if the member has many subscriptions from the same or many processes). It is expected that members will periodically call this endpoint with their latest clean timestamp rather than calling it for every event they process. The default interval is in the range of once a minute.

    A member should only acknowledge timestamps it has actually received. The behaviour of the sequencer is implementation-defined when a member acknowledges a later timestamp.

    See also

    com.digitalasset.canton.sequencing.client.SequencerClientConfig.acknowledgementInterval for the default interval

  3. abstract def locatePruningTimestamp(index: PositiveInt)(implicit traceContext: TraceContext): EitherT[Future, PruningSupportError, Option[CantonTimestamp]]

    Locate a timestamp relative to the earliest available sequencer event based on an index starting at one.

    Locate a timestamp relative to the earliest available sequencer event based on an index starting at one.

    When index == 1, indicates the progress of pruning as the timestamp of the oldest unpruned response When index > 1, returns the timestamp of the index'th oldest response which is useful for pruning in batches when index == batchSize.

  4. abstract def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, PruningError, String]

    Prune as much sequencer data as safely possible without breaking operation (except for members that have been previously flagged as disabled).

    Prune as much sequencer data as safely possible without breaking operation (except for members that have been previously flagged as disabled). Sequencers are permitted to prune to an earlier timestamp if required to for their own consistency. For example, the Database Sequencer will adjust this time to a potentially earlier point in time where counter checkpoints are available for all members (who aren't being ignored).

    Implementations that support pruning also update the "oldest-response-age" metric if pruning succeeds.

  5. abstract def pruningStatus(implicit traceContext: TraceContext): Future[SequencerPruningStatus]

    Return a structure containing the members registered with the sequencer and the latest positions of clients reading events.

  6. abstract def reportMaxEventAgeMetric(oldestEventTimestamp: Option[CantonTimestamp]): Either[PruningSupportError, Unit]

    Report the max-event-age metric based on the oldest event timestamp and the current clock time or zero if no oldest timestamp exists (e.g.

    Report the max-event-age metric based on the oldest event timestamp and the current clock time or zero if no oldest timestamp exists (e.g. events fully pruned).

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() @HotSpotIntrinsicCandidate()
  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() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def pruningScheduler: Option[PruningScheduler]
  15. def pruningSchedulerBuilder: Option[(Storage) => PruningScheduler]

    Builds a pruning scheduler once storage is available

  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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