Packages

c

com.digitalasset.canton.domain.block.data.db

DbSequencerBlockStore

class DbSequencerBlockStore extends SequencerBlockStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbSequencerBlockStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. NamedLogging
  6. FlagCloseable
  7. PerformUnlessClosing
  8. OnShutdownRunner
  9. SequencerBlockStore
  10. AutoCloseable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbSequencerBlockStore(storage: DbStorage, protocolVersion: ProtocolVersion, timeouts: ProcessingTimeout, checkedInvariant: Option[Member], loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)

    checkedInvariant

    Defines whether all methods should check the block invariant when they modify the state. Invariant checking is slow. It should only be enabled for testing and debugging. scala.Some$ defines the member under whom the sequencer's topology client subscribes.

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 blockInvariant(topologyClientMember: Member, currentBlock: BlockInfo, prevBlockO: Option[BlockInfo], allEventsInBlock: Map[Member, NonEmpty[Seq[OrdinarySerializedEvent]]], newMembersInBlock: Iterable[(Member, CantonTimestamp)])(implicit traceContext: TraceContext): Unit

    Check the invariant for a block in the store:

    Check the invariant for a block in the store:

    topologyClientMember

    The member under whom the sequencer's topology client subscribes

    currentBlock

    The block info of the current block

    prevBlockO

    The block info of the block preceding the currentBlock, unless the current block is the initial state

    allEventsInBlock

    All events in the current block

    newMembersInBlock

    All member registrations that happened in the block i.e., at currentBlock's com.digitalasset.canton.domain.block.data.BlockInfo.lastTs.

    Attributes
    protected
    Definition Classes
    SequencerBlockStore
    Exceptions thrown

    java.lang.IllegalStateException if the invariant is violated

  6. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. 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
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  15. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  16. def finalizeBlockUpdate(block: BlockInfo)(implicit traceContext: TraceContext): Future[Unit]

    Finalizes the current block whose updates have been added in the calls to partialBlockUpdate since the last call to finalizeBlockUpdate.

    Finalizes the current block whose updates have been added in the calls to partialBlockUpdate since the last call to finalizeBlockUpdate.

    This method must not be called concurrently with itself or partialBlockUpdate, and must be called for the blocks in monotonically increasing order of height.

    block

    The block information about the current block. It is the responsibility of the caller to ensure that the height increases monotonically by one

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def getInitialState(implicit traceContext: TraceContext): Future[BlockEphemeralState]

    Get initial state from which this sequencer node supports serving requests.

    Get initial state from which this sequencer node supports serving requests. The member counters returned as part of this initial state indicate the minimum counters that this sequencer supports serving requests from. If a member is not included in these counters, it means that this sequencer node supports serving requests from the com.digitalasset.canton.data.CounterCompanion.Genesis for that member.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  19. def getInitialTopologySnapshotTimestamp(implicit traceContext: TraceContext): Future[Option[CantonTimestamp]]

    Retrieve the timestamp of the initial topology snapshot if available.

    Retrieve the timestamp of the initial topology snapshot if available.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  22. 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
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def keepTrackOfOpenFutures: Boolean

    track running futures on shutdown

    track running futures on shutdown

    set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbSequencerBlockStoreNamedLogging
  27. 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
  28. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  29. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  34. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  35. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  36. 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()
  37. def partialBlockUpdate(newMembers: MemberTimestamps, events: Seq[MemberSignedEvents], acknowledgments: MemberTimestamps, membersDisabled: Seq[Member], trafficState: Map[Member, TrafficState])(implicit traceContext: TraceContext): Future[Unit]

    Stores some updates that happen in a single block.

    Stores some updates that happen in a single block. May be called several times for the same block and the same update may be contained in several of the calls. Before adding updates of a subsequent block, finalizeBlockUpdate must be called to wrap up the current block.

    This method must not be called concurrently with itself or finalizeBlockUpdate.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  38. 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.

    f

    The task to perform

    returns

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

    Definition Classes
    PerformUnlessClosing
  39. 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
  40. 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.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  41. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    PerformUnlessClosing
  42. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  43. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  44. 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.

    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
  45. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  46. def prune(requestedTimestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[String]
  47. def pruningStatus()(implicit traceContext: TraceContext): Future[InternalSequencerPruningStatus]
  48. def readHead(implicit traceContext: TraceContext): Future[BlockEphemeralState]

    The current state of the sequencer, which can be used when the node is restarted to deterministically derive the following counters and timestamps.

    The current state of the sequencer, which can be used when the node is restarted to deterministically derive the following counters and timestamps.

    The state excludes updates of unfinalized blocks added with partialBlockUpdate.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  49. def readRange(member: Member, startInclusive: SequencerCounter, endExclusive: SequencerCounter)(implicit traceContext: TraceContext): Source[OrdinarySerializedEvent, NotUsed]

    Serve events (or tombstones) for member with the given counter range.

    Serve events (or tombstones) for member with the given counter range.

    The returned range may include events added with partialBlockUpdate even before the corresponding block has been finalized with finalizeBlockUpdate. This ensures that com.digitalasset.canton.sequencing.client.SequencerClients can immediately read events when they are added. In particular, the sequencer's com.digitalasset.canton.topology.client.DomainTopologyClient will see such updates so that block processing can request a com.digitalasset.canton.topology.client.TopologySnapshot that includes the updates in a block while processing continues for the same block.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  50. def readStateForBlockContainingTimestamp(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, InvalidTimestamp, BlockEphemeralState]

    The state at the end of the block that contains the given timestamp.

    The state at the end of the block that contains the given timestamp. This will typically be used to inform other sequencer nodes being initialized of the initial state they should use based on the timestamp they provide which is typically the timestamp of their signing key.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  51. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  52. def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    OnShutdownRunner
  53. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  54. def setInitialState(initial: BlockEphemeralState, maybeOnboardingTopologyEffectiveTimestamp: Option[CantonTimestamp])(implicit traceContext: TraceContext): Future[Unit]

    Set initial state of the sequencer node from which it supports serving requests.

    Set initial state of the sequencer node from which it supports serving requests. This should be called at most once. If not called, it means this sequencer node can server requests from genesis.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  55. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbSequencerBlockStoreDbStore
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbSequencerBlockStoreFlagCloseable
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. def updateMemberCounterSupportedAfter(member: Member, counterLastUnsupported: SequencerCounter)(implicit traceContext: TraceContext): Future[Unit]

    Updates the last unsupported member sequencer counter, i.e.

    Updates the last unsupported member sequencer counter, i.e. the one just before the first supported sequencer counter. Only ever increases counter.

    Definition Classes
    DbSequencerBlockStoreSequencerBlockStore
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from SequencerBlockStore

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped