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