com.digitalasset.canton.participant.store.db
DbSingleDimensionEventLog
Companion object DbSingleDimensionEventLog
class DbSingleDimensionEventLog[+Id <: EventLogId] extends SingleDimensionEventLog[Id] with DbStore
- Alphabetic
- By Inheritance
- DbSingleDimensionEventLog
- DbStore
- HasCloseContext
- PromiseUnlessShutdownFactory
- NamedLogging
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- SingleDimensionEventLog
- SingleDimensionEventLogLookup
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
-  new DbSingleDimensionEventLog(id: Id, storage: DbStorage, indexedStringStore: IndexedStringStore, releaseProtocolVersion: ReleaseProtocolVersion, batchAggregatorConfig: BatchAggregatorConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)
Value Members
-   final  def !=(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def ##: Int- Definition Classes
- AnyRef → Any
 
-   final  def ==(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def asInstanceOf[T0]: T0- Definition Classes
- Any
 
-    val batchAggregatorConfig: BatchAggregatorConfig- Attributes
- protected
- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def cancelShutdownTask(token: Long): UnitRemoves 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
 
-    def clone(): AnyRef- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
 
-   final  def close(): UnitBlocks 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
- FlagCloseable → OnShutdownRunner → AutoCloseable
 
-   implicit  val closeContext: CloseContext- Definition Classes
- HasCloseContext
 
-    def closingTimeout: FiniteDuration- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
 
-    def containsShutdownTask(token: Long): Boolean- Definition Classes
- OnShutdownRunner
 
-    def deleteAfter(exclusive: LocalOffset)(implicit traceContext: TraceContext): Future[Unit]Deletes all events whose local offset is greater than exclusive.Deletes all events whose local offset is greater than exclusive. This operation need not execute atomically.- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-   final  def eq(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def equals(arg0: AnyRef): Boolean- Definition Classes
- AnyRef → Any
 
-   implicit  def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext- Attributes
- protected
- Definition Classes
- NamedLogging
 
-    def eventAt(offset: LocalOffset)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLogLookup
 
-    def eventById(eventId: EventId)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def eventByTransactionId(transactionId: LedgerTransactionId)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]- Definition Classes
- SingleDimensionEventLog
 
-   implicit  val executionContext: ExecutionContext- Attributes
- protected
- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def existsBetween(timestampInclusive: CantonTimestamp, localOffsetInclusive: LocalOffset)(implicit traceContext: TraceContext): Future[Boolean]Returns whether there exists an event in the event log with an com.digitalasset.canton.participant.LocalOffset of at most localOffsetwhose timestamp is at leasttimestamp.Returns whether there exists an event in the event log with an com.digitalasset.canton.participant.LocalOffset of at most localOffsetwhose timestamp is at leasttimestamp.In an event logs where timestamps need not increase with offsets, this can be used to check that whether there are events with lower offsets and larger timestamps. - Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
 
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
 
-    val id: Id- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def insert(event: TimestampedEvent)(implicit traceContext: TraceContext): Future[Unit]Publishes an event and fails upon an event ID clash. Publishes an event and fails upon an event ID clash. - Definition Classes
- SingleDimensionEventLog
- Exceptions thrown
- java.lang.IllegalArgumentExceptionif a different event has already been published with the same com.digitalasset.canton.participant.LocalOffset or an event with the same com.digitalasset.canton.participant.sync.TimestampedEvent.EventId has been published with a different (unpruned) com.digitalasset.canton.participant.LocalOffset.
 
-    def insertsUnlessEventIdClash(events: Seq[TimestampedEvent])(implicit traceContext: TraceContext): Future[Seq[Either[TimestampedEvent, Unit]]]Publishes many events. Publishes many events. - returns
- For each event in - eventsin the same order: scala.Left$ of the conficting event if an event with the same event ID has been published with a different (unpruned) com.digitalasset.canton.participant.LocalOffset. scala.Right$ if the event has been successfully inserted or has already been present in the event log
 - Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
- Exceptions thrown
- java.lang.IllegalArgumentExceptionif a different event has already been published with the same com.digitalasset.canton.participant.LocalOffset as one of the events in- events.
 
-    def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
 
-    def isClosing: BooleanCheck 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 performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-    def keepTrackOfOpenFutures: Booleantrack 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
 
-    def lastOffset(implicit traceContext: TraceContext): OptionT[Future, LocalOffset]- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def logger: TracedLogger- Attributes
- protected
- Definition Classes
- NamedLogging
 
-    val loggerFactory: NamedLoggerFactory- Attributes
- protected
- Definition Classes
- DbSingleDimensionEventLog → NamedLogging
 
-    def lookupEventRange(fromExclusive: Option[LocalOffset], toInclusive: Option[LocalOffset], fromTimestampInclusive: Option[CantonTimestamp], toTimestampInclusive: Option[CantonTimestamp], limit: Option[Int])(implicit traceContext: TraceContext): Future[SortedMap[LocalOffset, TimestampedEvent]]- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLogLookup
 
-    def maxSleepMillis: LongHow 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
 
-    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 successon the returned promise but rather usetrySuccess. The reason is that the call tosuccessmay fail in case of shutdown.- Definition Classes
- PromiseUnlessShutdownFactory
 
-   implicit  def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext- Attributes
- protected
- Definition Classes
- NamedLogging
 
-   final  def ne(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def noTracingLogger: Logger- Attributes
- protected
- Definition Classes
- NamedLogging
 
-   final  def notify(): Unit- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
 
-   final  def notifyAll(): Unit- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
 
-    def onCloseFailure(e: Throwable): Unit- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
 
-    def onClosed(): Unit- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
 
-   final  def onFirstClose(): UnitBlocks 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
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
 
-    def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]Performs the task given by funless a shutdown has been initiated.Performs the task given by funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
 
-    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
 
-    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 etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, 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.closeas part ofetf, because it will result in a deadlock.- etf
- The task to perform 
 - Definition Classes
- PerformUnlessClosing
 
-    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
 
-    def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]- Definition Classes
- PerformUnlessClosing
 
-    def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]- Definition Classes
- PerformUnlessClosing
 
-    def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]Performs the Future given by funless a shutdown has been initiated.Performs the Future given by funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, 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.closeas part off, 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
 
-    def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]- Definition Classes
- PerformUnlessClosing
 
-    val processingTime: TimedLoadGauge- Attributes
- protected
 
-    def prune(beforeAndIncluding: LocalOffset)(implicit traceContext: TraceContext): Future[Unit]- Definition Classes
- DbSingleDimensionEventLog → SingleDimensionEventLog
 
-    def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): LongSame 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
 
-    def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): UnitRegister 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
 
-    def runStateChanged(waitingState: Boolean = false): Unit- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
 
-    val storage: DbStorage- Attributes
- protected
- Definition Classes
- DbSingleDimensionEventLog → DbStore
 
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    val timeouts: ProcessingTimeout- Attributes
- protected
- Definition Classes
- DbSingleDimensionEventLog → FlagCloseable
 
-    def toString(): String- Definition Classes
- AnyRef → Any
 
-   final  def wait(arg0: Long, arg1: Int): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   final  def wait(arg0: Long): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
 
-   final  def wait(): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])