Packages

abstract class BaseSequencer extends Sequencer with NamedLogging with Spanning

Provides additional functionality that is common between sequencer implementations:

  • auto registers unknown recipients addressed in envelopes from the domain identity manager (avoids explicit registration from the domain node -> sequencer which will be useful when separate processes)
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseSequencer
  2. Spanning
  3. NamedLogging
  4. Sequencer
  5. AutoCloseable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BaseSequencer(domainManagerId: DomainIdentityManagerId, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext, trace: Tracer)

Abstract Value Members

  1. abstract def acknowledge(member: MemberInstance, 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.

    Definition Classes
    Sequencer
  2. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  3. abstract def disableMember(member: Member)(implicit traceContext: TraceContext): Future[Unit]

    Disable the provided member.

    Disable the provided member. Should prevent them from reading or writing in the future (although they can still be addressed). Their unread data can also be pruned. Effectively disables all instances of this member.

    Definition Classes
    Sequencer
  4. abstract def disableMemberInstance(memberInstance: MemberInstance)(implicit traceContext: TraceContext): Future[Unit]

    Disable the provided member instance.

    Disable the provided member instance. Should prevent them from reading or writing in the future (although they can still be addressed). Their unread data can also be pruned.

    Definition Classes
    Sequencer
  5. abstract def isRegistered(member: Member)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    Sequencer
  6. 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 and member instances that have been previously flagged as disabled).

    Prune as much sequencer data as safely possible without breaking operation (except for members and member instances 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).

    Definition Classes
    Sequencer
  7. 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.

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

    Definition Classes
    Sequencer
  8. abstract def readInternal(member: MemberInstance, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
    Attributes
    protected
  9. abstract def registerMember(member: Member)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]
    Definition Classes
    Sequencer
  10. abstract def sendAsyncInternal(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
    Attributes
    protected
  11. abstract def sendHeartbeatInternal(callerTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[HeartbeatError], Unit]
    Attributes
    protected
  12. abstract def snapshot(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, String, SequencerSnapshot]

    Return a snapshot state that other newly onboarded sequencers can use as an initial state from which to support serving events.

    Return a snapshot state that other newly onboarded sequencers can use as an initial state from which to support serving events. This state depends on the provided timestamp and will contain registered members, counters per member, latest timestamp (which will be greater than or equal to the provided timestamp) as well as a sequencer implementation specific piece of information such that all together form the point after which the new sequencer can safely operate. The provided timestamp is typically the timestamp of the requesting sequencer's private key, which is the point in time where it can effectively sign events.

    Definition Classes
    Sequencer

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. def ensureRegistered(member: Member)(implicit executionContext: ExecutionContext, traceContext: TraceContext): EitherT[Future, SequencerWriteError[RegisterMemberError], Unit]

    First check is the member is registered and if not call registerMember

    First check is the member is registered and if not call registerMember

    Definition Classes
    Sequencer
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def health(implicit traceContext: TraceContext): Future[SequencerHealthStatus]

    Return a structure indicating the health status of the sequencer implementation.

    Return a structure indicating the health status of the sequencer implementation. Should succeed even if the configured datastore is unavailable.

    Definition Classes
    BaseSequencerSequencer
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    BaseSequencerNamedLoggingSequencer
  15. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def read(member: MemberInstance, offset: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, CreateSubscriptionError, EventSource]
    Definition Classes
    BaseSequencerSequencer
  21. def sendAsync(submission: SubmissionRequest)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncError, Unit]
    Definition Classes
    BaseSequencerSequencer
  22. final def sendHeartbeat(callerTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, SequencerWriteError[HeartbeatError], Unit]
    Definition Classes
    BaseSequencerSequencer
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. def withNewTrace[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  29. def withSpan[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit traceContext: TraceContext, tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  30. def withSpanFromGrpcContext[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning

Deprecated Value Members

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

Inherited from Spanning

Inherited from NamedLogging

Inherited from Sequencer

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped