Packages

object RetryPolicy

Source
Retry.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RetryPolicy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 RetriableStatuses: Set[Status]

    Statuses that are retriable, per HTTP spec

  5. def apply[F[_]](backoff: (Int) ⇒ Option[FiniteDuration], retriable: (Request[F], Either[Throwable, Response[F]]) ⇒ Boolean = defaultRetriable[F]): RetryPolicy[F]

    Decomposes a retry policy into components that are typically configured individually.

    Decomposes a retry policy into components that are typically configured individually.

    backoff

    a function of attempts to an optional FiniteDuration. Return None to stop retrying, or some duration after which the request will be retried. See exponentialBackoff for a useful implementation.

    retriable

    determines whether the request is retriable from the request and either the throwable or response that was returned. Defaults to defaultRetriable.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def defaultRetriable[F[_]](req: Request[F], result: Either[Throwable, Response[F]]): Boolean

    Returns true if (the request method is idempotent or request contains Idempotency-Key header) and the result is either a throwable or has one of the RetriableStatuses.

    Returns true if (the request method is idempotent or request contains Idempotency-Key header) and the result is either a throwable or has one of the RetriableStatuses.

    Caution: if the request body is effectful, the effects will be run twice. The most common symptom of this will be resubmitting an idempotent request.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def exponentialBackoff(maxWait: Duration, maxRetry: Int): (Int) ⇒ Option[FiniteDuration]
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def isErrorOrRetriableStatus[F[_]](result: Either[Throwable, Response[F]]): Boolean

    Returns true if parameter is a Left or if the response contains a retriable status(as per HTTP spec)

  16. def isErrorOrStatus[F[_]](result: Either[Throwable, Response[F]], status: Set[Status]): Boolean

    Like isErrorOrRetriableStatus but allows the caller to specify which statuses are considered retriable

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def recklesslyRetriable[F[_]](result: Either[Throwable, Response[F]]): Boolean

    Like defaultRetriable, but returns true even if the request method is not idempotent.

    Like defaultRetriable, but returns true even if the request method is not idempotent. This is useful if failed requests are assumed to have not reached their destination, which is a dangerous assumption. Use at your own risk.

    Caution: if the request body is effectful, the effects will be run twice. The most common symptom of this will be resubmitting an empty request body.

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. def unsafeRetriable[F[_]](req: Request[F], result: Either[Throwable, Response[F]]): Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Use defaultRetriable instead

Inherited from AnyRef

Inherited from Any

Ungrouped