class DbParticipantEventLog extends DbSingleDimensionEventLog[ParticipantEventLogId] with ParticipantEventLog

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbParticipantEventLog
  2. ParticipantEventLog
  3. DbSingleDimensionEventLog
  4. DbStore
  5. HasCloseContext
  6. PromiseUnlessShutdownFactory
  7. NamedLogging
  8. FlagCloseable
  9. PerformUnlessClosing
  10. OnShutdownRunner
  11. AutoCloseable
  12. SingleDimensionEventLog
  13. SingleDimensionEventLogLookup
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbParticipantEventLog(id: ParticipantEventLogId, storage: DbStorage, indexedStringStore: IndexedStringStore, releaseProtocolVersion: ReleaseProtocolVersion, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext)

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 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
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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
  8. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  10. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  11. 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
    DbSingleDimensionEventLogSingleDimensionEventLog
  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. def eventAt(offset: LocalOffset)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]
  16. def eventById(eventId: EventId)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]
  17. def eventByTransactionId(transactionId: LedgerTransactionId)(implicit traceContext: TraceContext): OptionT[Future, TimestampedEvent]
    Definition Classes
    SingleDimensionEventLog
  18. implicit val executionContext: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbSingleDimensionEventLogSingleDimensionEventLog
  19. 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 localOffset whose timestamp is at least timestamp.

    Returns whether there exists an event in the event log with an com.digitalasset.canton.participant.LocalOffset of at most localOffset whose timestamp is at least timestamp.

    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
    DbSingleDimensionEventLogSingleDimensionEventLog
  20. def firstEventWithAssociatedDomainAtOrAfter(associatedDomain: DomainId, atOrAfter: CantonTimestamp)(implicit traceContext: TraceContext): Future[Option[TimestampedEvent]]

    Returns the first event (by offset ordering) whose com.digitalasset.canton.participant.sync.TimestampedEvent.EventId has the given associatedDomain and whose timestamp is at or after atOrAfter.

    Returns the first event (by offset ordering) whose com.digitalasset.canton.participant.sync.TimestampedEvent.EventId has the given associatedDomain and whose timestamp is at or after atOrAfter.

    Definition Classes
    DbParticipantEventLogParticipantEventLog
    Exceptions thrown

    java.lang.UnsupportedOperationException if this event log is not the participant event log.

  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val id: ParticipantEventLogId
  24. 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.IllegalArgumentException if 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.

  25. def insertsUnlessEventIdClash(events: Seq[TimestampedEvent])(implicit traceContext: TraceContext): Future[Seq[Either[TimestampedEvent, Unit]]]

    Publishes many events.

    Publishes many events.

    returns

    For each event in events in 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
    DbSingleDimensionEventLogSingleDimensionEventLog
    Exceptions thrown

    java.lang.IllegalArgumentException if a different event has already been published with the same com.digitalasset.canton.participant.LocalOffset as one of the events in events.

  26. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  27. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. 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
  30. def lastOffset(implicit traceContext: TraceContext): OptionT[Future, LocalOffset]
  31. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbParticipantEventLogDbSingleDimensionEventLogNamedLogging
  33. def lookupEventRange(fromExclusive: Option[LocalOffset], toInclusive: Option[LocalOffset], fromTimestampInclusive: Option[CantonTimestamp], toTimestampInclusive: Option[CantonTimestamp], limit: Option[Int])(implicit traceContext: TraceContext): Future[SortedMap[LocalOffset, TimestampedEvent]]
  34. 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
  35. 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
  36. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def nextLocalOffset()(implicit traceContext: TraceContext): Future[LocalOffset]

    Allocates the next local offset

    Allocates the next local offset

    Definition Classes
    ParticipantEventLog
  39. def nextLocalOffsets(count: NonNegativeInt)(implicit traceContext: TraceContext): Future[Seq[LocalOffset]]

    Allocates count many new offsets and returns all of them.

    Allocates count many new offsets and returns all of them.

    Definition Classes
    DbParticipantEventLogParticipantEventLog
  40. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  44. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  45. 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()
  46. 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
  47. 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
  48. 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
  49. 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
  50. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  51. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  52. 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
  53. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  54. val processingTime: TimedLoadGauge
    Attributes
    protected
    Definition Classes
    DbSingleDimensionEventLog
  55. def prune(beforeAndIncluding: LocalOffset)(implicit traceContext: TraceContext): Future[Unit]
  56. 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
  57. 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
  58. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  59. val storage: DbStorage
  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbParticipantEventLogDbSingleDimensionEventLogFlagCloseable
  62. def toString(): String
    Definition Classes
    AnyRef → Any
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  65. 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 ParticipantEventLog

Inherited from DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped