CircuitBreakerState

Holds the state of the circuit breaker. Transitions through three states:

Closed: elements/requests/calls run through the main logic until the maxFailures count is reached. If maxFailures is reached, it transitions to Open state.

Open: Short circuits. A scala.util.Failure or a fallback response is returned. After resetTimeout, it transitions to HalfOpen state.

HalfOpen: the first element/request/call will be allowed through the main logic, if it succeeds the circuit breaker will reset to Closed state. If it fails, the circuit breaker will re-open to Open state. All elements/requests/calls beyond the first that execute while the first is running will fail-fast with scala.util.Failure or a fallback response.

An ActorRef can be subscribed to receive certain events, e.g., TransitionEvents to receive all state transition events or specific state transition event like Open.

It collects metrics for success, failure and short-circuit counts. Also, exposes the state as a gauge.

Linear Supertypes

AnyRef, Any

Known Subclasses

AtomicCircuitBreakerState

Abstract Value Members

abstract val callTimeout: FiniteDuration
abstract def currentState: State

returns
the current state

Attributes
protected
abstract val exponentialBackoffFactor: Double
abstract def fails(): Unit

Implementation specific fail logic
Implementation specific fail logic

Attributes
protected
abstract def isShortCircuited: Boolean

Implementation specific short circuit check
Implementation specific short circuit check
returns
true if short circuited

Attributes
protected
abstract val maxFailures: Int
abstract val maxResetTimeout: FiniteDuration
abstract val metricRegistry: MetricRegistry
abstract val name: String
abstract val resetTimeout: FiniteDuration
abstract def succeeds(): Unit

Implementation specific success logic
Implementation specific success logic

Attributes
protected
abstract def transitionImpl(fromState: State, toState: State): Boolean

Implementation specific transition logic
Implementation specific transition logic

Attributes
protected
abstract def withMetricRegistry(metricRegistry: MetricRegistry): CircuitBreakerState

The provided MetricRegistry will be used to register metrics
The provided MetricRegistry will be used to register metrics
metricRegistry
the registry to use for codahale metrics

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object StateGauge extends Gauge[State]
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def attemptReset(): Unit

Attempts to reset breaker by transitioning to HalfOpen state.
Attempts to reset breaker by transitioning to HalfOpen state. This is valid from Open state only.

Attributes
protected
val beanName: ObjectName
final def checkAndMarkIfShortCircuit(): Boolean

Check if circuit should be short circuited.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val mBeanServer: MBeanServer
final def markFailure(): Unit

Mark a failed element/response/call through CircuitBreaker.
final def markSuccess(): Unit

Mark a successful element/response/call through CircuitBreaker.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def resetBreaker(): Unit

Resets breaker to Closed state.
Resets breaker to Closed state. This is valid from HalfOpen state only.

Attributes
protected
def subscribe(subscriber: ActorRef, to: EventType): Boolean

Subscribe an ActorRef to receive events that it's interested in.
Subscribe an ActorRef to receive events that it's interested in.
subscriber
ActorRef that would receive the events
to
event types that this ActorRef is interested in
returns
true if subscription is successful
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def transition(fromState: State, toState: State): Unit

Implements consistent transition between states.
Implements consistent transition between states. Throws IllegalStateException if an invalid transition is attempted.
fromState
State being transitioning from
toState
State being transitioning to

Attributes
protected
final def tripBreaker(fromState: State): Unit

Trips breaker to an open state.
Trips breaker to an open state. This is valid from Closed or HalfOpen states.
fromState
State we're coming from (Closed or HalfOpen)

Attributes
protected
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package circuitbreaker

trait CircuitBreakerState extends AnyRef

Abstract Value Members

abstract val callTimeout: FiniteDuration

abstract def currentState: State

abstract val exponentialBackoffFactor: Double

abstract def fails(): Unit

abstract def isShortCircuited: Boolean

abstract val maxFailures: Int

abstract val maxResetTimeout: FiniteDuration

abstract val metricRegistry: MetricRegistry

abstract val name: String

abstract val resetTimeout: FiniteDuration

abstract def succeeds(): Unit

abstract def transitionImpl(fromState: State, toState: State): Boolean

abstract def withMetricRegistry(metricRegistry: MetricRegistry): CircuitBreakerState

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object StateGauge extends Gauge[State]

final def asInstanceOf[T0]: T0

final def attemptReset(): Unit

val beanName: ObjectName

final def checkAndMarkIfShortCircuit(): Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val mBeanServer: MBeanServer

final def markFailure(): Unit

final def markSuccess(): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def resetBreaker(): Unit

def subscribe(subscriber: ActorRef, to: EventType): Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def transition(fromState: State, toState: State): Unit

final def tripBreaker(fromState: State): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped