From afc113f5df3195627f562b0d4e140107a55117f5 Mon Sep 17 00:00:00 2001 From: svroonland Date: Thu, 4 Apr 2024 21:33:28 +0200 Subject: [PATCH] updated site --- .../rezilience/Bulkhead$$BulkheadError.html | 2 ++ .../Bulkhead$$BulkheadException.html | 2 ++ .../Bulkhead$$BulkheadRejection$.html | 2 ++ .../vroste/rezilience/Bulkhead$$Metrics.html | 2 ++ .../rezilience/Bulkhead$$WrappedError.html | 2 ++ api/nl/vroste/rezilience/Bulkhead$.html | 6 +++++ api/nl/vroste/rezilience/Bulkhead.html | 12 +++++++++ ...rcuitBreaker$$CircuitBreakerCallError.html | 2 ++ ...rcuitBreaker$$CircuitBreakerException.html | 2 ++ .../CircuitBreaker$$CircuitBreakerOpen$.html | 2 ++ .../CircuitBreaker$$State$$Closed$.html | 2 ++ .../CircuitBreaker$$State$$HalfOpen$.html | 2 ++ .../CircuitBreaker$$State$$Open$.html | 2 ++ .../rezilience/CircuitBreaker$$State$.html | 2 ++ .../rezilience/CircuitBreaker$$State.html | 2 ++ .../CircuitBreaker$$StateChange.html | 2 ++ .../CircuitBreaker$$WrappedError.html | 2 ++ api/nl/vroste/rezilience/CircuitBreaker$.html | 19 +++++++++++++ api/nl/vroste/rezilience/CircuitBreaker.html | 25 +++++++++++++++++ .../Policy$$BulkheadRejection$.html | 2 ++ .../rezilience/Policy$$CallTimedOut$.html | 2 ++ .../Policy$$CircuitBreakerOpen$.html | 2 ++ .../rezilience/Policy$$PolicyError.html | 2 ++ .../rezilience/Policy$$PolicyException.html | 2 ++ .../rezilience/Policy$$WrappedError.html | 2 ++ api/nl/vroste/rezilience/Policy$.html | 6 +++++ api/nl/vroste/rezilience/Policy.html | 5 ++++ api/nl/vroste/rezilience/RateLimiter$.html | 8 ++++++ api/nl/vroste/rezilience/RateLimiter.html | 8 ++++++ .../vroste/rezilience/Retry$$Schedules$.html | 23 ++++++++++++++++ api/nl/vroste/rezilience/Retry$.html | 13 +++++++++ api/nl/vroste/rezilience/Retry.html | 3 +++ ...itchablePolicy$$Mode$$FinishInFlight$.html | 2 ++ .../SwitchablePolicy$$Mode$$Transition$.html | 2 ++ .../rezilience/SwitchablePolicy$$Mode$.html | 2 ++ .../rezilience/SwitchablePolicy$$Mode.html | 2 ++ .../vroste/rezilience/SwitchablePolicy$.html | 3 +++ .../vroste/rezilience/SwitchablePolicy.html | 11 ++++++++ .../rezilience/Timeout$$CallTimedOut$.html | 2 ++ .../rezilience/Timeout$$TimeoutError.html | 2 ++ .../rezilience/Timeout$$TimeoutException.html | 2 ++ .../rezilience/Timeout$$WrappedError.html | 2 ++ api/nl/vroste/rezilience/Timeout$.html | 2 ++ api/nl/vroste/rezilience/Timeout.html | 3 +++ .../vroste/rezilience/TrippingStrategy$.html | 12 +++++++++ .../vroste/rezilience/TrippingStrategy.html | 7 +++++ api/nl/vroste/rezilience/index.html | 27 +++++++++++++++++++ 47 files changed, 251 insertions(+) create mode 100644 api/nl/vroste/rezilience/Bulkhead$$BulkheadError.html create mode 100644 api/nl/vroste/rezilience/Bulkhead$$BulkheadException.html create mode 100644 api/nl/vroste/rezilience/Bulkhead$$BulkheadRejection$.html create mode 100644 api/nl/vroste/rezilience/Bulkhead$$Metrics.html create mode 100644 api/nl/vroste/rezilience/Bulkhead$$WrappedError.html create mode 100644 api/nl/vroste/rezilience/Bulkhead$.html create mode 100644 api/nl/vroste/rezilience/Bulkhead.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerCallError.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerException.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerOpen$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$State$$Closed$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$State$$HalfOpen$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$State$$Open$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$State$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$State.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$StateChange.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$$WrappedError.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker$.html create mode 100644 api/nl/vroste/rezilience/CircuitBreaker.html create mode 100644 api/nl/vroste/rezilience/Policy$$BulkheadRejection$.html create mode 100644 api/nl/vroste/rezilience/Policy$$CallTimedOut$.html create mode 100644 api/nl/vroste/rezilience/Policy$$CircuitBreakerOpen$.html create mode 100644 api/nl/vroste/rezilience/Policy$$PolicyError.html create mode 100644 api/nl/vroste/rezilience/Policy$$PolicyException.html create mode 100644 api/nl/vroste/rezilience/Policy$$WrappedError.html create mode 100644 api/nl/vroste/rezilience/Policy$.html create mode 100644 api/nl/vroste/rezilience/Policy.html create mode 100644 api/nl/vroste/rezilience/RateLimiter$.html create mode 100644 api/nl/vroste/rezilience/RateLimiter.html create mode 100644 api/nl/vroste/rezilience/Retry$$Schedules$.html create mode 100644 api/nl/vroste/rezilience/Retry$.html create mode 100644 api/nl/vroste/rezilience/Retry.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$FinishInFlight$.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$Transition$.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy$$Mode$.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy$$Mode.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy$.html create mode 100644 api/nl/vroste/rezilience/SwitchablePolicy.html create mode 100644 api/nl/vroste/rezilience/Timeout$$CallTimedOut$.html create mode 100644 api/nl/vroste/rezilience/Timeout$$TimeoutError.html create mode 100644 api/nl/vroste/rezilience/Timeout$$TimeoutException.html create mode 100644 api/nl/vroste/rezilience/Timeout$$WrappedError.html create mode 100644 api/nl/vroste/rezilience/Timeout$.html create mode 100644 api/nl/vroste/rezilience/Timeout.html create mode 100644 api/nl/vroste/rezilience/TrippingStrategy$.html create mode 100644 api/nl/vroste/rezilience/TrippingStrategy.html create mode 100644 api/nl/vroste/rezilience/index.html diff --git a/api/nl/vroste/rezilience/Bulkhead$$BulkheadError.html b/api/nl/vroste/rezilience/Bulkhead$$BulkheadError.html new file mode 100644 index 00000000..9604c38f --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$$BulkheadError.html @@ -0,0 +1,2 @@ +

Packages

sealed trait BulkheadError[+E] extends AnyRef

Self Type
BulkheadError[E]
Linear Supertypes
AnyRef, Any
Known Subclasses
BulkheadRejection, WrappedError
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BulkheadError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def fold[O](bulkheadRejection: O, unwrap: (E) => O): O
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def toException: Exception
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead$$BulkheadException.html b/api/nl/vroste/rezilience/Bulkhead$$BulkheadException.html new file mode 100644 index 00000000..319d4057 --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$$BulkheadException.html @@ -0,0 +1,2 @@ +

Packages

c

nl.vroste.rezilience.Bulkhead

BulkheadException

case class BulkheadException[E](error: BulkheadError[E]) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BulkheadException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BulkheadException(error: BulkheadError[E])

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val error: BulkheadError[E]
  9. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  10. def getCause(): Throwable
    Definition Classes
    Throwable
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  13. def getMessage(): String
    Definition Classes
    Throwable
  14. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  15. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  16. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(): Unit
    Definition Classes
    Throwable
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead$$BulkheadRejection$.html b/api/nl/vroste/rezilience/Bulkhead$$BulkheadRejection$.html new file mode 100644 index 00000000..d6e98458 --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$$BulkheadRejection$.html @@ -0,0 +1,2 @@ +

Packages

o

nl.vroste.rezilience.Bulkhead

BulkheadRejection

case object BulkheadRejection extends BulkheadError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, BulkheadError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BulkheadRejection
  2. Serializable
  3. Product
  4. Equals
  5. BulkheadError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def fold[O](bulkheadRejection: O, unwrap: (Nothing) => O): O
    Definition Classes
    BulkheadError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. final def toException: Exception
    Definition Classes
    BulkheadError
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 BulkheadError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead$$Metrics.html b/api/nl/vroste/rezilience/Bulkhead$$Metrics.html new file mode 100644 index 00000000..1a77e58a --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$$Metrics.html @@ -0,0 +1,2 @@ +

Packages

final case class Metrics(inFlight: Int, inQueue: Int) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Metrics
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Metrics(inFlight: Int, inQueue: Int)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  8. val inFlight: Int
  9. val inQueue: Int
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead$$WrappedError.html b/api/nl/vroste/rezilience/Bulkhead$$WrappedError.html new file mode 100644 index 00000000..f7691bf0 --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$$WrappedError.html @@ -0,0 +1,2 @@ +

Packages

final case class WrappedError[E](e: E) extends BulkheadError[E] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, BulkheadError[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WrappedError
  2. Serializable
  3. Product
  4. Equals
  5. BulkheadError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WrappedError(e: E)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. val e: E
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def fold[O](bulkheadRejection: O, unwrap: (E) => O): O
    Definition Classes
    BulkheadError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def toException: Exception
    Definition Classes
    BulkheadError
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 BulkheadError[E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead$.html b/api/nl/vroste/rezilience/Bulkhead$.html new file mode 100644 index 00000000..46d5d221 --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead$.html @@ -0,0 +1,6 @@ +

Packages

object Bulkhead

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bulkhead
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait BulkheadError[+E] extends AnyRef
  2. case class BulkheadException[E](error: BulkheadError[E]) extends Exception with Product with Serializable
  3. final case class Metrics(inFlight: Int, inQueue: Int) extends Product with Serializable
  4. final case class WrappedError[E](e: E) extends BulkheadError[E] with Product with Serializable

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make(maxInFlightCalls: Int, maxQueueing: Int = 32): ZIO[Scope, Nothing, Bulkhead]

    Create a Bulkhead with the given parameters +

    Create a Bulkhead with the given parameters +

    maxInFlightCalls

    + Maxmimum of concurrent executing calls

    maxQueueing

    + Maximum queueing calls

  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. case object BulkheadRejection extends BulkheadError[Nothing] with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Bulkhead.html b/api/nl/vroste/rezilience/Bulkhead.html new file mode 100644 index 00000000..2749c1a1 --- /dev/null +++ b/api/nl/vroste/rezilience/Bulkhead.html @@ -0,0 +1,12 @@ +

Packages

trait Bulkhead extends AnyRef

Limits the number of simultaneous in-flight calls to an external resource

A bulkhead limits the resources used by some system by limiting the number of concurrent calls to that system. Calls +that exceed that number are rejected with a BulkheadError. To ensure good utilisation of the system, however, there +is a queue/buffer of waiting calls.

It also prevents queueing up of requests, which consume resources in the calling system, by rejecting calls when the +queue is full. +

Self Type
Bulkhead
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bulkhead
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E, A](task: ZIO[R, E, A]): ZIO[R, BulkheadError[E], A]

    Call the system protected by the Bulkhead +

    Call the system protected by the Bulkhead +

    task

    + Task to execute. When the maximum number of in-flight calls is exceeded, the call will be queued.

    returns

    + Effect that succeeds with the success of the given task or fails, when executed, with a WrappedError of the + task's error, or when not executed, with a BulkheadRejection.

  2. abstract def metrics: UIO[Metrics]

    Provides the number of in-flight and queued calls +

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toPolicy: Policy[Any]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerCallError.html b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerCallError.html new file mode 100644 index 00000000..ea259aff --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerCallError.html @@ -0,0 +1,2 @@ +

Packages

t

nl.vroste.rezilience.CircuitBreaker

CircuitBreakerCallError

sealed trait CircuitBreakerCallError[+E] extends AnyRef

Self Type
CircuitBreakerCallError[E]
Linear Supertypes
AnyRef, Any
Known Subclasses
CircuitBreakerOpen, WrappedError
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerCallError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](circuitBreakerOpen: O, unwrap: (E) => O): O
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerException.html b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerException.html new file mode 100644 index 00000000..fb3e9e9d --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerException.html @@ -0,0 +1,2 @@ +

Packages

c

nl.vroste.rezilience.CircuitBreaker

CircuitBreakerException

case class CircuitBreakerException[E](error: CircuitBreakerCallError[E]) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CircuitBreakerException(error: CircuitBreakerCallError[E])

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val error: CircuitBreakerCallError[E]
  9. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  10. def getCause(): Throwable
    Definition Classes
    Throwable
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  13. def getMessage(): String
    Definition Classes
    Throwable
  14. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  15. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  16. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(): Unit
    Definition Classes
    Throwable
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerOpen$.html b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerOpen$.html new file mode 100644 index 00000000..c0c540b2 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$CircuitBreakerOpen$.html @@ -0,0 +1,2 @@ +

Packages

case object CircuitBreakerOpen extends CircuitBreakerCallError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, CircuitBreakerCallError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerOpen
  2. Serializable
  3. Product
  4. Equals
  5. CircuitBreakerCallError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](circuitBreakerOpen: O, unwrap: (Nothing) => O): O
    Definition Classes
    CircuitBreakerCallError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toException: Exception
    Definition Classes
    CircuitBreakerCallError
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 CircuitBreakerCallError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$State$$Closed$.html b/api/nl/vroste/rezilience/CircuitBreaker$$State$$Closed$.html new file mode 100644 index 00000000..376da9f0 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$State$$Closed$.html @@ -0,0 +1,2 @@ +

Packages

case object Closed extends State with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, State, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Closed
  2. Serializable
  3. Product
  4. Equals
  5. State
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 State

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$State$$HalfOpen$.html b/api/nl/vroste/rezilience/CircuitBreaker$$State$$HalfOpen$.html new file mode 100644 index 00000000..3bcacb8d --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$State$$HalfOpen$.html @@ -0,0 +1,2 @@ +

Packages

case object HalfOpen extends State with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, State, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HalfOpen
  2. Serializable
  3. Product
  4. Equals
  5. State
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 State

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$State$$Open$.html b/api/nl/vroste/rezilience/CircuitBreaker$$State$$Open$.html new file mode 100644 index 00000000..afea3173 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$State$$Open$.html @@ -0,0 +1,2 @@ +

Packages

case object Open extends State with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, State, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Open
  2. Serializable
  3. Product
  4. Equals
  5. State
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 State

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$State$.html b/api/nl/vroste/rezilience/CircuitBreaker$$State$.html new file mode 100644 index 00000000..b3f7550c --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$State$.html @@ -0,0 +1,2 @@ +

Packages

object State

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. case object Closed extends State with Product with Serializable
  20. case object HalfOpen extends State with Product with Serializable
  21. case object Open extends State with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$State.html b/api/nl/vroste/rezilience/CircuitBreaker$$State.html new file mode 100644 index 00000000..422f4534 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$State.html @@ -0,0 +1,2 @@ +

Packages

sealed trait State extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Closed, HalfOpen, Open
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$StateChange.html b/api/nl/vroste/rezilience/CircuitBreaker$$StateChange.html new file mode 100644 index 00000000..11e9fd74 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$StateChange.html @@ -0,0 +1,2 @@ +

Packages

case class StateChange(from: State, to: State, at: Instant) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateChange
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StateChange(from: State, to: State, at: Instant)

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. val at: Instant
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val from: State
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. val to: State
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$$WrappedError.html b/api/nl/vroste/rezilience/CircuitBreaker$$WrappedError.html new file mode 100644 index 00000000..22cded2d --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$$WrappedError.html @@ -0,0 +1,2 @@ +

Packages

case class WrappedError[E](error: E) extends CircuitBreakerCallError[E] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, CircuitBreakerCallError[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WrappedError
  2. Serializable
  3. Product
  4. Equals
  5. CircuitBreakerCallError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WrappedError(error: E)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val error: E
  8. def fold[O](circuitBreakerOpen: O, unwrap: (E) => O): O
    Definition Classes
    CircuitBreakerCallError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
    Definition Classes
    CircuitBreakerCallError
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 CircuitBreakerCallError[E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker$.html b/api/nl/vroste/rezilience/CircuitBreaker$.html new file mode 100644 index 00000000..2a9188d6 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker$.html @@ -0,0 +1,19 @@ +

Packages

object CircuitBreaker

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreaker
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait CircuitBreakerCallError[+E] extends AnyRef
  2. case class CircuitBreakerException[E](error: CircuitBreakerCallError[E]) extends Exception with Product with Serializable
  3. sealed trait State extends AnyRef
  4. case class StateChange(from: State, to: State, at: Instant) extends Product with Serializable
  5. case class WrappedError[E](error: E) extends CircuitBreakerCallError[E] with Product with Serializable

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make[E](trippingStrategy: ZIO[Scope, Nothing, TrippingStrategy], resetPolicy: Schedule[Any, Any, Any] = Retry.Schedules.exponentialBackoff(1.second, 1.minute), isFailure: PartialFunction[E, Boolean] = isFailureAny[E], metricLabels: Option[Set[MetricLabel]] = None): ZIO[Scope, Nothing, CircuitBreaker[E]]

    Create a CircuitBreaker with the given tripping strategy +

    Create a CircuitBreaker with the given tripping strategy +

    trippingStrategy

    + Determines under which conditions the CircuitBraker trips

    resetPolicy

    + Reset schedule after too many failures. Typically an exponential backoff strategy is used.

    isFailure

    + Only failures that match according to isFailure are treated as failures by the circuit breaker. Other failures + are passed on, circumventing the circuit breaker's failure counter.

    metricLabels

    + Set of labels to annotate metrics with, to distinguish this circuit breaker from others in the same application. + No metrics are recorded if None is passed.

  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. def withMaxFailures[E](maxFailures: Int, resetPolicy: Schedule[Any, Any, Any] = Retry.Schedules.exponentialBackoff(1.second, 1.minute), isFailure: PartialFunction[E, Boolean] = isFailureAny[E], metricLabels: Option[Set[MetricLabel]] = None): ZIO[Scope, Nothing, CircuitBreaker[E]]

    Create a CircuitBreaker that fails when a number of successive failures (no pun intended) has been counted +

    Create a CircuitBreaker that fails when a number of successive failures (no pun intended) has been counted +

    maxFailures

    + Maximum number of failures before tripping the circuit breaker

    resetPolicy

    + Reset schedule after too many failures. Typically an exponential backoff strategy is used.

    isFailure

    + Only failures that match according to isFailure are treated as failures by the circuit breaker. Other failures + are passed on, circumventing the circuit breaker's failure counter.

    metricLabels

    + Set of labels to annotate metrics with, to distinguish this circuit breaker from others in the same application. + No metrics are recorded if None is passed.

    returns

    + The CircuitBreaker as a managed resource

  21. case object CircuitBreakerOpen extends CircuitBreakerCallError[Nothing] with Product with Serializable
  22. object State

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/CircuitBreaker.html b/api/nl/vroste/rezilience/CircuitBreaker.html new file mode 100644 index 00000000..49554027 --- /dev/null +++ b/api/nl/vroste/rezilience/CircuitBreaker.html @@ -0,0 +1,25 @@ +

Packages

trait CircuitBreaker[-E] extends AnyRef

CircuitBreaker protects external resources against overload under failure

Operates in three states:

  • Closed (initial state / normal operation): calls are let through normally. Call failures and successes update the + call statistics, eg failure count. When the statistics satisfy some criteria, the circuit breaker is 'tripped' + and set to the Open state. Note that after this switch, in-flight calls are not canceled. Their success or + failure does not affect the circuit breaker anymore though.
  • Open: all calls fail fast with a CircuitBreakerOpen error. After the reset timeout, the states changes to + HalfOpen
  • HalfOpen: the first call is let through. Meanwhile all other calls fail with a CircuitBreakerOpen error. If the + first call succeeds, the state changes to Closed again (normal operation). If it fails, the state changes back to + Open. The reset timeout is governed by a reset policy, which is typically an exponential backoff.

Two tripping strategies are implemented: 1) Failure counting. When the number of successive failures exceeds a +threshold, the circuit breaker is tripped.

Note that the maximum number of failures before tripping the circuit breaker is not absolute under concurrent +execution. I.e. if you make 20 calls to a failing system in parallel via a circuit breaker with max 10 failures, the +calls will be running concurrently. The circuit breaker will trip after 10 calls, but the remaining 10 that are +in-flight will continue to run and fail as well.

TODO what to do if you want this kind of behavior, or should we make it an option?

2) Failure rate. When the fraction of failed calls in some sample period exceeds a threshold (between 0 and 1), the +circuit breaker is tripped. The decision to trip the Circuit Breaker is made after every call (including successful +ones!)

CircuitBreaker can record the following metrics, if a non-empty set of MetricLabels is given:

  • rezilience_circuit_breaker_state: current state (0 = closed, 1 = half-open, 2 = open)
  • rezilience_circuit_breaker_state_changes: number of state changes
  • rezilience_circuit_breaker_calls_success: number of successful calls
  • rezilience_circuit_breaker_calls_failure: number of failed calls
  • rezilience_circuit_breaker_calls_rejected: number of calls rejected in the open state +
Self Type
CircuitBreaker[E]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreaker
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E1 <: E, A](f: ZIO[R, E1, A]): ZIO[R, CircuitBreakerCallError[E1], A]

    Execute a given effect with the circuit breaker +

    Execute a given effect with the circuit breaker +

    f

    + Effect to execute

    returns

    + A ZIO that either succeeds with the success of the given f or fails with either a CircuitBreakerOpen or a + WrappedError of the error of the given f

  2. abstract def currentState: UIO[State]
  3. abstract val stateChanges: ZIO[Scope, Nothing, Dequeue[StateChange]]

    Stream of Circuit Breaker state changes

    Stream of Circuit Breaker state changes

    Is backed by a zio.Hub, so each use of the Dequeue will receive all state changes +

  4. abstract def widen[E2](pf: PartialFunction[E2, E]): CircuitBreaker[E2]

    Transform this policy to apply to larger class of errors

    Transform this policy to apply to larger class of errors

    Only for errors where the partial function is defined will errors be considered as failures, otherwise the error is +passed through to the caller +

    pf

    + Map an error of type E2 to an error of type E

    returns

    + A new CircuitBreaker defined for failures of type E2

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toPolicy: Policy[E]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$BulkheadRejection$.html b/api/nl/vroste/rezilience/Policy$$BulkheadRejection$.html new file mode 100644 index 00000000..097c95f1 --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$BulkheadRejection$.html @@ -0,0 +1,2 @@ +

Packages

o

nl.vroste.rezilience.Policy

BulkheadRejection

case object BulkheadRejection extends PolicyError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, PolicyError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BulkheadRejection
  2. Serializable
  3. Product
  4. Equals
  5. PolicyError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](bulkheadRejection: O, circuitBreakerOpen: O, timeout: O, unwrap: (Nothing) => O): O
    Definition Classes
    PolicyError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toException: Exception
    Definition Classes
    PolicyError
  18. def toString(): String
    Definition Classes
    PolicyError → AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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 PolicyError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$CallTimedOut$.html b/api/nl/vroste/rezilience/Policy$$CallTimedOut$.html new file mode 100644 index 00000000..a59e2fa6 --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$CallTimedOut$.html @@ -0,0 +1,2 @@ +

Packages

case object CallTimedOut extends PolicyError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, PolicyError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallTimedOut
  2. Serializable
  3. Product
  4. Equals
  5. PolicyError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](bulkheadRejection: O, circuitBreakerOpen: O, timeout: O, unwrap: (Nothing) => O): O
    Definition Classes
    PolicyError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toException: Exception
    Definition Classes
    PolicyError
  18. def toString(): String
    Definition Classes
    PolicyError → AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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 PolicyError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$CircuitBreakerOpen$.html b/api/nl/vroste/rezilience/Policy$$CircuitBreakerOpen$.html new file mode 100644 index 00000000..2105ee19 --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$CircuitBreakerOpen$.html @@ -0,0 +1,2 @@ +

Packages

o

nl.vroste.rezilience.Policy

CircuitBreakerOpen

case object CircuitBreakerOpen extends PolicyError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, PolicyError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerOpen
  2. Serializable
  3. Product
  4. Equals
  5. PolicyError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](bulkheadRejection: O, circuitBreakerOpen: O, timeout: O, unwrap: (Nothing) => O): O
    Definition Classes
    PolicyError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toException: Exception
    Definition Classes
    PolicyError
  18. def toString(): String
    Definition Classes
    PolicyError → AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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 PolicyError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$PolicyError.html b/api/nl/vroste/rezilience/Policy$$PolicyError.html new file mode 100644 index 00000000..2f02626a --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$PolicyError.html @@ -0,0 +1,2 @@ +

Packages

sealed trait PolicyError[+E] extends AnyRef

Self Type
PolicyError[E]
Linear Supertypes
AnyRef, Any
Known Subclasses
BulkheadRejection, CallTimedOut, CircuitBreakerOpen, WrappedError
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PolicyError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](bulkheadRejection: O, circuitBreakerOpen: O, timeout: O, unwrap: (E) => O): O
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
  17. def toString(): String
    Definition Classes
    PolicyError → AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$PolicyException.html b/api/nl/vroste/rezilience/Policy$$PolicyException.html new file mode 100644 index 00000000..4575f419 --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$PolicyException.html @@ -0,0 +1,2 @@ +

Packages

c

nl.vroste.rezilience.Policy

PolicyException

case class PolicyException[E](error: PolicyError[E]) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PolicyException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PolicyException(error: PolicyError[E])

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val error: PolicyError[E]
  9. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  10. def getCause(): Throwable
    Definition Classes
    Throwable
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  13. def getMessage(): String
    Definition Classes
    Throwable
  14. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  15. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  16. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(): Unit
    Definition Classes
    Throwable
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$$WrappedError.html b/api/nl/vroste/rezilience/Policy$$WrappedError.html new file mode 100644 index 00000000..f885b653 --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$$WrappedError.html @@ -0,0 +1,2 @@ +

Packages

case class WrappedError[E](e: E) extends PolicyError[E] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, PolicyError[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WrappedError
  2. Serializable
  3. Product
  4. Equals
  5. PolicyError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WrappedError(e: E)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. val e: E
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def fold[O](bulkheadRejection: O, circuitBreakerOpen: O, timeout: O, unwrap: (E) => O): O
    Definition Classes
    PolicyError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
    Definition Classes
    PolicyError
  17. def toString(): String
    Definition Classes
    PolicyError → AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 PolicyError[E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy$.html b/api/nl/vroste/rezilience/Policy$.html new file mode 100644 index 00000000..15192a0d --- /dev/null +++ b/api/nl/vroste/rezilience/Policy$.html @@ -0,0 +1,6 @@ +

Packages

object Policy

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Policy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait PolicyError[+E] extends AnyRef
  2. case class PolicyException[E](error: PolicyError[E]) extends Exception with Product with Serializable
  3. case class WrappedError[E](e: E) extends PolicyError[E] with Product with Serializable

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def common[E](rateLimiter: RateLimiter = noopRateLimiter, bulkhead: Bulkhead = noopBulkhead, circuitBreaker: CircuitBreaker[E] = noopCircuitBreaker, retry: Retry[E] = noopRetry[E]): Policy[E]

    Creates a common rezilience policy that wraps calls with a bulkhead, followed by a circuit breaker, followed by a +rate limiter, followed by a retry policy.

    Creates a common rezilience policy that wraps calls with a bulkhead, followed by a circuit breaker, followed by a +rate limiter, followed by a retry policy.

    i.e. retry(withRateLimiter(withCircuitBreaker(withBulkhead(effect)))

    Each of these wraps are optional by the default values for these three policies being noop versions +

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def flattenWrappedError[E]: (PolicyError[PolicyError[E]]) => PolicyError[E]
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val noop: Policy[Any]

    A policy that does not change the execution of the effect +

  15. val noopBulkhead: Bulkhead
  16. def noopCircuitBreaker[E]: CircuitBreaker[E]
  17. val noopRateLimiter: RateLimiter
  18. def noopRetry[E]: Retry[E]
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def unwrap[E]: PartialFunction[PolicyError[E], E]
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. case object BulkheadRejection extends PolicyError[Nothing] with Product with Serializable
  28. case object CallTimedOut extends PolicyError[Nothing] with Product with Serializable
  29. case object CircuitBreakerOpen extends PolicyError[Nothing] with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Policy.html b/api/nl/vroste/rezilience/Policy.html new file mode 100644 index 00000000..f6d5491b --- /dev/null +++ b/api/nl/vroste/rezilience/Policy.html @@ -0,0 +1,5 @@ +

Packages

trait Policy[-E] extends AnyRef

Represents a composition of one or more rezilience policies +

Self Type
Policy[E]
Linear Supertypes
AnyRef, Any
Known Subclasses
SwitchablePolicy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Policy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E1 <: E, A](f: ZIO[R, E1, A]): ZIO[R, PolicyError[E1], A]

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def compose[E2 <: E](that: Policy[PolicyError[E2]]): Policy[E2]

    Apply another policy on top of this one

    Apply another policy on top of this one

    The other policy gets applied before this policy, i.e. policyA compose policyB means policyB { policyA { effect } } +

    that

    + The other policy

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/RateLimiter$.html b/api/nl/vroste/rezilience/RateLimiter$.html new file mode 100644 index 00000000..ead26275 --- /dev/null +++ b/api/nl/vroste/rezilience/RateLimiter$.html @@ -0,0 +1,8 @@ +

Packages

object RateLimiter

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RateLimiter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make(max: Int, interval: zio.Duration = 1.second): ZIO[Scope, Nothing, RateLimiter]

    Creates a RateLimiter as Managed resource

    Creates a RateLimiter as Managed resource

    Note that the maximum number of calls is spread out over the interval, i.e. 10 calls per second means that 1 call +can be made every 100 ms. Up to max calls can be saved up. The maximum is immediately available when starting the +RateLimiter +

    max

    + Maximum number of calls in each interval

    interval

    + Interval duration

    returns

    + RateLimiter

  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/RateLimiter.html b/api/nl/vroste/rezilience/RateLimiter.html new file mode 100644 index 00000000..6ef064fe --- /dev/null +++ b/api/nl/vroste/rezilience/RateLimiter.html @@ -0,0 +1,8 @@ +

Packages

trait RateLimiter extends AnyRef

Limits the number of calls to a resource to a maximum amount in some interval

Uses a token bucket algorithm

Note that only the moment of starting the effect is rate limited: the number of concurrent executions is not bounded. +For that you may use a Bulkhead

Calls are queued up in an unbounded queue until capacity becomes available. +

Self Type
RateLimiter
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RateLimiter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E, A](task: ZIO[R, E, A]): ZIO[R, E, A]

    Execute the task with RateLimiter protection

    Execute the task with RateLimiter protection

    The effect returned by this method can be interrupted, which is handled as follows:

    • If the task is still waiting in the rate limiter queue, it will not start execution. It will also not count for + the rate limiting or hold back other uninterrupted queued tasks.
    • If the task has already started executing, interruption will interrupt the task and will complete when the + task's interruption is complete. +
    task

    + Task to execute. When the rate limit is exceeded, the call will be postponed.

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toPolicy: Policy[Any]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Retry$$Schedules$.html b/api/nl/vroste/rezilience/Retry$$Schedules$.html new file mode 100644 index 00000000..ce1e8850 --- /dev/null +++ b/api/nl/vroste/rezilience/Retry$$Schedules$.html @@ -0,0 +1,23 @@ +

Packages

object Schedules

Convenience methods to create common ZIO schedules for retrying +

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Schedules
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def common(min: zio.Duration = 1.second, max: zio.Duration = 1.minute, factor: Double = 2.0, retryImmediately: Boolean = true, maxRetries: Option[Int] = Some(3), jitterFactor: Double = 0.1): Schedule[Any, Any, (Any, Long)]

    A common-practice schedule for retrying

    A common-practice schedule for retrying

    By default the first retry is done immediately. With transient / random failures this method gives the highest +chance of fast success. After that Retry uses exponential backoff between some minimum and maximum duration. +Jitter is added to prevent spikes of retries from multiple instances. An optional maximum number of retries +ensures that retrying does not continue forever.

    See also https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/ +

    min

    + Minimum retry backoff delay

    max

    + Maximum backoff time. When this value is reached, subsequent intervals will be equal to this value.

    factor

    + Factor with which delays increase

    retryImmediately

    + Retry immediately after the first failure

    maxRetries

    + Maximum number of retries

    jitterFactor

    + Maximum fraction of the current delay interval that is randomly added or subtracted. This helps to spread call + attempts in time when there are multiple systems making calls to some system using the same retry schedule. For + example, with jitterFactor = 0.1 the retry intervals will be multiplied with a random factor between 0.9 and + 1.1. jitterFactor = 0 disables jittering.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def exponentialBackoff[E](min: zio.Duration, max: zio.Duration, factor: Double = 2.0): Schedule[Any, E, zio.Duration]

    Schedule for exponential backoff up to a maximum interval +

    Schedule for exponential backoff up to a maximum interval +

    E

    + Schedule input

    min

    + Minimum backoff time

    max

    + Maximum backoff time. When this value is reached, subsequent intervals will be equal to this value.

    factor

    + Exponential factor. 2 means doubling, 1 is constant, < 1 means decreasing

  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. def whenCase[Env, In, Out](pf: PartialFunction[In, Any])(schedule: Schedule[Env, In, Out]): Schedule[Env, In, (In, Out)]

    Apply the given schedule only when inputs match the partial function +

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Retry$.html b/api/nl/vroste/rezilience/Retry$.html new file mode 100644 index 00000000..0f714dcc --- /dev/null +++ b/api/nl/vroste/rezilience/Retry$.html @@ -0,0 +1,13 @@ +

Packages

object Retry

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

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make[R, E](schedule: Schedule[R, E, Any]): ZIO[Scope with R, Nothing, Retry[E]]

    Create a Retry from a ZIO Schedule +

  12. def make(min: zio.Duration = 1.second, max: zio.Duration = 1.minute, factor: Double = 2.0, retryImmediately: Boolean = true, maxRetries: Option[Int] = Some(3)): ZIO[Scope, Nothing, Retry[Any]]

    Create a Retry policy with a common retry schedule

    Create a Retry policy with a common retry schedule

    By default the first retry is done immediately. With transient / random failures this method gives the highest +chance of fast success. After that Retry uses exponential backoff between some minimum and maximum duration. Jitter +is added to prevent spikes of retries. An optional maximum number of retries ensures that retrying does not +continue forever. +

    min

    + Minimum retry backoff delay

    max

    + Maximum backoff time. When this value is reached, subsequent intervals will be equal to this value.

    factor

    + Factor with which delays increase

    retryImmediately

    + Retry immediately after the first failure

    maxRetries

    + Maximum number of retries

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. object Schedules

    Convenience methods to create common ZIO schedules for retrying +

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Retry.html b/api/nl/vroste/rezilience/Retry.html new file mode 100644 index 00000000..c62dfddb --- /dev/null +++ b/api/nl/vroste/rezilience/Retry.html @@ -0,0 +1,3 @@ +

Packages

trait Retry[-E] extends AnyRef

Self Type
Retry[E]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Retry
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E1 <: E, A](f: ZIO[R, E1, A]): ZIO[R, E1, A]
  2. abstract def widen[E2](pf: PartialFunction[E2, E]): Retry[E2]

    Transform this policy to apply to larger class of errors

    Transform this policy to apply to larger class of errors

    Only where the partial function is defined will the policy be applied, other errors are not retried +

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toPolicy: Policy[E]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$FinishInFlight$.html b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$FinishInFlight$.html new file mode 100644 index 00000000..cfcb04ee --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$FinishInFlight$.html @@ -0,0 +1,2 @@ +

Packages

case object FinishInFlight extends Mode with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Mode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FinishInFlight
  2. Serializable
  3. Product
  4. Equals
  5. Mode
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 Mode

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$Transition$.html b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$Transition$.html new file mode 100644 index 00000000..95f68367 --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$$Transition$.html @@ -0,0 +1,2 @@ +

Packages

case object Transition extends Mode with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Mode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transition
  2. Serializable
  3. Product
  4. Equals
  5. Mode
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 Mode

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$.html b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$.html new file mode 100644 index 00000000..f295b1d0 --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode$.html @@ -0,0 +1,2 @@ +

Packages

object Mode

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mode
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. case object FinishInFlight extends Mode with Product with Serializable
  20. case object Transition extends Mode with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy$$Mode.html b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode.html new file mode 100644 index 00000000..abee8571 --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy$$Mode.html @@ -0,0 +1,2 @@ +

Packages

sealed trait Mode extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
FinishInFlight, Transition
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Mode
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy$.html b/api/nl/vroste/rezilience/SwitchablePolicy$.html new file mode 100644 index 00000000..3e06de17 --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy$.html @@ -0,0 +1,3 @@ +

Packages

object SwitchablePolicy

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwitchablePolicy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Mode extends AnyRef

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make[R0, E0, E](initial: ZIO[Scope with R0, E0, Policy[E]]): ZIO[Scope with R0, E0, SwitchablePolicy[E]]

    Creates a Policy that can be replaced safely at runtime +

  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. object Mode

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/SwitchablePolicy.html b/api/nl/vroste/rezilience/SwitchablePolicy.html new file mode 100644 index 00000000..20cdb252 --- /dev/null +++ b/api/nl/vroste/rezilience/SwitchablePolicy.html @@ -0,0 +1,11 @@ +

Packages

trait SwitchablePolicy[E] extends Policy[E]

A Policy that can be replaced safely at runtime +

Linear Supertypes
Policy[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SwitchablePolicy
  2. Policy
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E1 <: E, A](f: ZIO[R, E1, A]): ZIO[R, PolicyError[E1], A]
    Definition Classes
    Policy
  2. abstract def switch[R0, E0, E2 >: E](newPolicy: ZIO[Scope with R0, E0, Policy[E2]], mode: Mode = Mode.Transition): ZIO[R0, E0, UIO[Unit]]

    Switches the policy to the new policy

    Switches the policy to the new policy

    After completion of this effect, it is guaranteed that new calls are executed with the new policy. Calls in flight +before execution of the switch will be completed with the old policy.

    The old policy will be released after those in-flight calls are completed. The inner UIO signals completion of +release of the old policy. +

    newPolicy

    + The new policy to apply. Can be a policy that accepts a supertype of errors of the original policy.

    mode

    + Transition mode: Transition = Process new calls with the new policy while completing in-flight calls with the + previous policy. FinishInFlight = Wait for completion of in-flight calls with the old policy before accepting

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def compose[E2 <: E](that: Policy[PolicyError[E2]]): Policy[E2]

    Apply another policy on top of this one

    Apply another policy on top of this one

    The other policy gets applied before this policy, i.e. policyA compose policyB means policyB { policyA { effect } } +

    that

    + The other policy

    Definition Classes
    Policy
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 Policy[E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout$$CallTimedOut$.html b/api/nl/vroste/rezilience/Timeout$$CallTimedOut$.html new file mode 100644 index 00000000..62e11f86 --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout$$CallTimedOut$.html @@ -0,0 +1,2 @@ +

Packages

case object CallTimedOut extends TimeoutError[Nothing] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, TimeoutError[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CallTimedOut
  2. Serializable
  3. Product
  4. Equals
  5. TimeoutError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](onTimeout: O, unwrap: (Nothing) => O): O
    Definition Classes
    TimeoutError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementName(n: Int): String
    Definition Classes
    Product
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toException: Exception
    Definition Classes
    TimeoutError
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 TimeoutError[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout$$TimeoutError.html b/api/nl/vroste/rezilience/Timeout$$TimeoutError.html new file mode 100644 index 00000000..6817fc0c --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout$$TimeoutError.html @@ -0,0 +1,2 @@ +

Packages

sealed trait TimeoutError[+E] extends AnyRef

Self Type
TimeoutError[E]
Linear Supertypes
AnyRef, Any
Known Subclasses
CallTimedOut, WrappedError
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeoutError
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def fold[O](onTimeout: O, unwrap: (E) => O): O
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout$$TimeoutException.html b/api/nl/vroste/rezilience/Timeout$$TimeoutException.html new file mode 100644 index 00000000..3b453d61 --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout$$TimeoutException.html @@ -0,0 +1,2 @@ +

Packages

c

nl.vroste.rezilience.Timeout

TimeoutException

case class TimeoutException[E](error: TimeoutError[E]) extends Exception with Product with Serializable

Linear Supertypes
Product, Equals, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TimeoutException
  2. Product
  3. Equals
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TimeoutException(error: TimeoutError[E])

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val error: TimeoutError[E]
  9. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  10. def getCause(): Throwable
    Definition Classes
    Throwable
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  13. def getMessage(): String
    Definition Classes
    Throwable
  14. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  15. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  16. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  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() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  22. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  23. def printStackTrace(): Unit
    Definition Classes
    Throwable
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 Product

Inherited from Equals

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout$$WrappedError.html b/api/nl/vroste/rezilience/Timeout$$WrappedError.html new file mode 100644 index 00000000..e78700bc --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout$$WrappedError.html @@ -0,0 +1,2 @@ +

Packages

case class WrappedError[E](error: E) extends TimeoutError[E] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, TimeoutError[E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WrappedError
  2. Serializable
  3. Product
  4. Equals
  5. TimeoutError
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WrappedError(error: E)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val error: E
  8. def fold[O](onTimeout: O, unwrap: (E) => O): O
    Definition Classes
    TimeoutError
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toException: Exception
    Definition Classes
    TimeoutError
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 TimeoutError[E]

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout$.html b/api/nl/vroste/rezilience/Timeout$.html new file mode 100644 index 00000000..704b7348 --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout$.html @@ -0,0 +1,2 @@ +

Packages

object Timeout

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Timeout
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait TimeoutError[+E] extends AnyRef
  2. case class TimeoutException[E](error: TimeoutError[E]) extends Exception with Product with Serializable
  3. case class WrappedError[E](error: E) extends TimeoutError[E] with Product with Serializable

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def make(timeout: zio.Duration): ZIO[Scope, Nothing, Timeout]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. case object CallTimedOut extends TimeoutError[Nothing] with Product with Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/Timeout.html b/api/nl/vroste/rezilience/Timeout.html new file mode 100644 index 00000000..7da89d0d --- /dev/null +++ b/api/nl/vroste/rezilience/Timeout.html @@ -0,0 +1,3 @@ +

Packages

trait Timeout extends AnyRef

Applies a timeout to effects

Just a thin wrapper around ZIO's retry mechanisms for easy composition with other Policys. +

Self Type
Timeout
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Timeout
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply[R, E, A](task: ZIO[R, E, A]): ZIO[R, TimeoutError[E], A]

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toPolicy: Policy[Any]
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/TrippingStrategy$.html b/api/nl/vroste/rezilience/TrippingStrategy$.html new file mode 100644 index 00000000..c4b8d292 --- /dev/null +++ b/api/nl/vroste/rezilience/TrippingStrategy$.html @@ -0,0 +1,12 @@ +

Packages

object TrippingStrategy

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TrippingStrategy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def failureCount(maxFailures: Int): ZIO[Scope, Nothing, TrippingStrategy]

    For a CircuitBreaker that fails when a number of successive failures (no pun intended) has been counted +

    For a CircuitBreaker that fails when a number of successive failures (no pun intended) has been counted +

    maxFailures

    + Maximum number of failures before tripping the circuit breaker

  9. def failureRate(failureRateThreshold: Double = 0.5, sampleDuration: zio.Duration = 1.minute, minThroughput: Int = 10, nrSampleBuckets: Int = 10): ZIO[Scope, Nothing, TrippingStrategy]

    For a CircuitBreaker that fails when the fraction of failures in a sample period exceeds some threshold

    For a CircuitBreaker that fails when the fraction of failures in a sample period exceeds some threshold

    The sample interval is divided into a number of buckets, which are rotated periodically (sampleDuration / +nrSampleBuckets) to achieve a moving average of the failure rate. +

    failureRateThreshold

    + The minimum fraction (between 0.0 and 1.0) of calls that must fail within the sample duration for the circuit + breaker to trip

    sampleDuration

    + Minimum amount of time to record calls

    minThroughput

    + Minimum number of calls required within the sample period to evaluate the actual failure rate.

    nrSampleBuckets

    + Nr of intervals to divide

  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/TrippingStrategy.html b/api/nl/vroste/rezilience/TrippingStrategy.html new file mode 100644 index 00000000..4f50636e --- /dev/null +++ b/api/nl/vroste/rezilience/TrippingStrategy.html @@ -0,0 +1,7 @@ +

Packages

trait TrippingStrategy extends AnyRef

Keeps track of successful calls and failures and determines when the circuit breaker should trip from Closed to Open +state

Custom implementations are supported +

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TrippingStrategy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def onReset: UIO[Unit]
  2. abstract def shouldTrip(callSuccessful: Boolean): UIO[Boolean]

    Called for every successful or failed call +

    Called for every successful or failed call +

    returns

    + If the CircuitBreaker should trip because of too many failures

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped

diff --git a/api/nl/vroste/rezilience/index.html b/api/nl/vroste/rezilience/index.html new file mode 100644 index 00000000..ce925a3c --- /dev/null +++ b/api/nl/vroste/rezilience/index.html @@ -0,0 +1,27 @@ +

Packages

p

nl.vroste

rezilience

package rezilience

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package config

Type Members

  1. trait Bulkhead extends AnyRef

    Limits the number of simultaneous in-flight calls to an external resource

    Limits the number of simultaneous in-flight calls to an external resource

    A bulkhead limits the resources used by some system by limiting the number of concurrent calls to that system. Calls +that exceed that number are rejected with a BulkheadError. To ensure good utilisation of the system, however, there +is a queue/buffer of waiting calls.

    It also prevents queueing up of requests, which consume resources in the calling system, by rejecting calls when the +queue is full. +

  2. trait CircuitBreaker[-E] extends AnyRef

    CircuitBreaker protects external resources against overload under failure

    CircuitBreaker protects external resources against overload under failure

    Operates in three states:

    • Closed (initial state / normal operation): calls are let through normally. Call failures and successes update the + call statistics, eg failure count. When the statistics satisfy some criteria, the circuit breaker is 'tripped' + and set to the Open state. Note that after this switch, in-flight calls are not canceled. Their success or + failure does not affect the circuit breaker anymore though.
    • Open: all calls fail fast with a CircuitBreakerOpen error. After the reset timeout, the states changes to + HalfOpen
    • HalfOpen: the first call is let through. Meanwhile all other calls fail with a CircuitBreakerOpen error. If the + first call succeeds, the state changes to Closed again (normal operation). If it fails, the state changes back to + Open. The reset timeout is governed by a reset policy, which is typically an exponential backoff.

    Two tripping strategies are implemented: 1) Failure counting. When the number of successive failures exceeds a +threshold, the circuit breaker is tripped.

    Note that the maximum number of failures before tripping the circuit breaker is not absolute under concurrent +execution. I.e. if you make 20 calls to a failing system in parallel via a circuit breaker with max 10 failures, the +calls will be running concurrently. The circuit breaker will trip after 10 calls, but the remaining 10 that are +in-flight will continue to run and fail as well.

    TODO what to do if you want this kind of behavior, or should we make it an option?

    2) Failure rate. When the fraction of failed calls in some sample period exceeds a threshold (between 0 and 1), the +circuit breaker is tripped. The decision to trip the Circuit Breaker is made after every call (including successful +ones!)

    CircuitBreaker can record the following metrics, if a non-empty set of MetricLabels is given:

    • rezilience_circuit_breaker_state: current state (0 = closed, 1 = half-open, 2 = open)
    • rezilience_circuit_breaker_state_changes: number of state changes
    • rezilience_circuit_breaker_calls_success: number of successful calls
    • rezilience_circuit_breaker_calls_failure: number of failed calls
    • rezilience_circuit_breaker_calls_rejected: number of calls rejected in the open state +
  3. trait Policy[-E] extends AnyRef

    Represents a composition of one or more rezilience policies +

  4. trait RateLimiter extends AnyRef

    Limits the number of calls to a resource to a maximum amount in some interval

    Limits the number of calls to a resource to a maximum amount in some interval

    Uses a token bucket algorithm

    Note that only the moment of starting the effect is rate limited: the number of concurrent executions is not bounded. +For that you may use a Bulkhead

    Calls are queued up in an unbounded queue until capacity becomes available. +

  5. trait Retry[-E] extends AnyRef
  6. trait SwitchablePolicy[E] extends Policy[E]

    A Policy that can be replaced safely at runtime +

  7. trait Timeout extends AnyRef

    Applies a timeout to effects

    Applies a timeout to effects

    Just a thin wrapper around ZIO's retry mechanisms for easy composition with other Policys. +

  8. trait TrippingStrategy extends AnyRef

    Keeps track of successful calls and failures and determines when the circuit breaker should trip from Closed to Open +state

    Keeps track of successful calls and failures and determines when the circuit breaker should trip from Closed to Open +state

    Custom implementations are supported +

Value Members

  1. object Bulkhead
  2. object CircuitBreaker
  3. object Policy
  4. object RateLimiter
  5. object Retry
  6. object SwitchablePolicy
  7. object Timeout
  8. object TrippingStrategy

Ungrouped