Packages

final case class Pause(logger: TracedLogger, performUnlessClosing: PerformUnlessClosing, maxRetries: Int, delay: FiniteDuration, operationName: String, longDescription: String = "", actionable: Option[String] = None, retryLogLevel: Option[Level] = None, suspendRetries: Eval[FiniteDuration] = Eval.now(Duration.Zero)) extends RetryWithDelay with Product with Serializable

Retry with a pause between attempts for a max number of times

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pause
  2. Serializable
  3. Product
  4. Equals
  5. RetryWithDelay
  6. Policy
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Pause(logger: TracedLogger, performUnlessClosing: PerformUnlessClosing, maxRetries: Int, delay: FiniteDuration, operationName: String, longDescription: String = "", actionable: Option[String] = None, retryLogLevel: Option[Level] = None, suspendRetries: Eval[FiniteDuration] = Eval.now(Duration.Zero))

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. val actionable: Option[String]
  5. def apply[T](task: => Future[T], retryable: ExceptionRetryable)(implicit success: Success[T], executionContext: ExecutionContext, traceContext: TraceContext): Future[T]

    A com.digitalasset.canton.util.retry.Success criteria is supplied to determine whether the future-based task has succeeded, or if it should perhaps be retried.

    A com.digitalasset.canton.util.retry.Success criteria is supplied to determine whether the future-based task has succeeded, or if it should perhaps be retried. Retries are not performed after the com.digitalasset.canton.lifecycle.FlagCloseable has been closed. In that case, the Future is completed with the last result (even if it is an outcome that doesn't satisfy the success predicate).

    Definition Classes
    RetryWithDelayPolicy
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val delay: FiniteDuration
  9. val directExecutionContext: DirectExecutionContext
    Attributes
    protected
    Definition Classes
    Policy
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val logger: TracedLogger
  14. val longDescription: String
  15. val maxRetries: Int
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def nextDelay(nextCount: Int, delay: FiniteDuration): FiniteDuration
    Definition Classes
    PauseRetryWithDelay
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val operationName: String
  21. val performUnlessClosing: PerformUnlessClosing
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val retryLogLevel: Option[Level]
  24. val suspendRetries: Eval[FiniteDuration]
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def unlessShutdown[T](task: => FutureUnlessShutdown[T], retryable: ExceptionRetryable)(implicit success: Success[T], executionContext: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[T]

    In contrast to com.digitalasset.canton.util.retry.RetryWithDelay.apply, this Policy completes the returned future with AbortedDueToShutdown if the retry is aborted due to the corresponding com.digitalasset.canton.lifecycle.FlagCloseable being closed or if the task itself reports a shutdown (and not with the last result).

    In contrast to com.digitalasset.canton.util.retry.RetryWithDelay.apply, this Policy completes the returned future with AbortedDueToShutdown if the retry is aborted due to the corresponding com.digitalasset.canton.lifecycle.FlagCloseable being closed or if the task itself reports a shutdown (and not with the last result).

    Unless your task does already naturally return a FutureUnlessShutdown[T], using com.digitalasset.canton.util.retry.RetryWithDelay.apply is likely sufficient to make it robust against shutdowns.

    Definition Classes
    RetryWithDelayPolicy
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from RetryWithDelay

Inherited from Policy

Inherited from AnyRef

Inherited from Any

Ungrouped