Packages

class SyncDomainEphemeralState extends SyncDomainEphemeralStateLookup with FlagCloseable with NamedLogging with HealthComponent

The state of a synchronization domain that is kept only in memory and must be reconstructed after crashes and fatal errors from the SyncDomainPersistentState. The ephemeral state can be kept across network disconnects provided that the local processing continues as far as possible.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncDomainEphemeralState
  2. HealthComponent
  3. BaseHealthComponent
  4. HealthElement
  5. NamedLogging
  6. FlagCloseable
  7. AutoCloseable
  8. SyncDomainEphemeralStateLookup
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SyncDomainEphemeralState(participantId: ParticipantId, persistentState: SyncDomainPersistentState, multiDomainEventLog: Eval[MultiDomainEventLog], inFlightSubmissionTracker: InFlightSubmissionTracker, startingPoints: ProcessingStartingPoints, createTimeTracker: (NamedLoggerFactory) => DomainTimeTracker, metrics: SyncDomainMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor)(implicit executionContext: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable
  2. type HealthListener = (SyncDomainEphemeralState.this.type, State, TraceContext) => Unit
    Definition Classes
    HealthElement
  3. type State = ComponentHealthState

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  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
    FlagCloseable → AutoCloseable
    Annotations
    @SuppressWarnings()
  8. val closingState: ComponentHealthState
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. def contractLookup: ContractLookup
  11. def degradationOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

    Definition Classes
    HealthComponent
  12. def degradationOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now degraded.

    Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!

    Definition Classes
    HealthComponent
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  17. def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def getState: State

    Current state

    Current state

    Definition Classes
    BaseHealthComponentHealthElement
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val inFlightSubmissionTracker: InFlightSubmissionTracker
  22. lazy val inFlightSubmissionTrackerDomainState: InFlightSubmissionTrackerDomainState
  23. val initialHealthState: ComponentHealthState
  24. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  25. 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
    FlagCloseable
  26. def isFailed: Boolean
    Definition Classes
    BaseHealthComponent
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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
    FlagCloseable
  29. val listeners: AtomicReference[List[HealthListener]]
    Attributes
    protected
    Definition Classes
    HealthElement
  30. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. val loggerFactory: NamedLoggerFactory
  32. def markAsRecovered()(implicit tc: TraceContext): Unit
  33. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  34. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    SyncDomainEphemeralStateHealthElement
  35. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def observedTimestampLookup: WatermarkLookup[CantonTimestamp]
  41. val observedTimestampTracker: WatermarkTracker[CantonTimestamp]
  42. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  43. def onClosed(): Unit
  44. val pendingTransferInSubmissions: TrieMap[RootHash, PendingTransferSubmission]
  45. val pendingTransferOutSubmissions: TrieMap[RootHash, PendingTransferSubmission]
  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
    FlagCloseable
  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
    FlagCloseable
  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
    FlagCloseable
  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
    FlagCloseable
  50. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  51. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  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
    FlagCloseable
  53. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  54. val phase37Synchronizer: Phase37Synchronizer
  55. val recordOrderPublisher: RecordOrderPublisher
  56. def registerOnHealthChange(listener: HealthListener): Unit
    Definition Classes
    BaseHealthComponentHealthElement
  57. def reportHealthState(state: State)(implicit tc: TraceContext): Boolean
    Definition Classes
    BaseHealthComponent
  58. def reportHealthState_(state: State)(implicit tc: TraceContext): Unit
    Definition Classes
    BaseHealthComponent
  59. val requestCounterAllocator: RequestCounterAllocatorImpl
  60. val requestJournal: RequestJournal
  61. val requestTracker: RequestTracker
  62. def resolveUnhealthy(implicit traceContext: TraceContext): Boolean

    Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

    Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.

    Definition Classes
    HealthComponent
  63. def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
    Definition Classes
    HealthComponent
  64. 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
    FlagCloseable
  65. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  66. val startingPoints: ProcessingStartingPoints
  67. lazy val stateRef: AtomicReference[State]
    Attributes
    protected
    Definition Classes
    BaseHealthComponent
  68. val storedContractManager: StoredContractManager
  69. val submissionTracker: SubmissionTracker
  70. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  71. val timeTracker: DomainTimeTracker
  72. val timeouts: ProcessingTimeout
  73. def toComponentStatus: ComponentStatus
    Definition Classes
    BaseHealthComponent
  74. def toString(): String
    Definition Classes
    AnyRef → Any
  75. def tracker: RequestTrackerLookup
  76. val transferCache: TransferCache
  77. def transferLookup: TransferLookup
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  80. 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

Inherited from HealthComponent

Inherited from BaseHealthComponent

Inherited from HealthElement

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped