AtomicCircuitBreakerState

Instance Constructors

new AtomicCircuitBreakerState(name: String, scheduler: Scheduler, maxFailures: Int, callTimeout: FiniteDuration, resetTimeout: FiniteDuration, maxResetTimeout: FiniteDuration, exponentialBackoffFactor: Double, metricRegistry: MetricRegistry = new MetricRegistry())(implicit executor: ExecutionContext)

name
used to differentiate circuit breakers in metrics
scheduler
used to schedule reset attempt
maxFailures
maximum number of failures before opening the circuit
callTimeout
scala.concurrent.duration.FiniteDuration of time after which to consider a call a failure
resetTimeout
scala.concurrent.duration.FiniteDuration of time after which to attempt to close the circuit
maxResetTimeout
the upper bound of resetTimeout
exponentialBackoffFactor
The exponential amount that the wait time will be increased
executor
scala.concurrent.ExecutionContext used for execution of the scheduler

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]

Definition Classes
CircuitBreakerState
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
Definition Classes
CircuitBreakerState
val beanName: ObjectName

Definition Classes
CircuitBreakerState
val callTimeout: FiniteDuration

scala.concurrent.duration.FiniteDuration of time after which to consider a call a failure
scala.concurrent.duration.FiniteDuration of time after which to consider a call a failure

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
final def checkAndMarkIfShortCircuit(): Boolean

Check if circuit should be short circuited.
Check if circuit should be short circuited.

Definition Classes
CircuitBreakerState
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def currentState: State

Get the current state of the Circuit Breaker.
Get the current state of the Circuit Breaker.
returns
the current state

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val exponentialBackoffFactor: Double

The exponential amount that the wait time will be increased
The exponential amount that the wait time will be increased

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
def fails(): Unit

Mark a failed call through CircuitBreaker.
Mark a failed call through CircuitBreaker.

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
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
def isShortCircuited: Boolean

Check if circuit should be short circuited.
Check if circuit should be short circuited.
returns
true if short circuited

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
val mBeanServer: MBeanServer

Definition Classes
CircuitBreakerState
final def markFailure(): Unit

Mark a failed element/response/call through CircuitBreaker.
Mark a failed element/response/call through CircuitBreaker.

Definition Classes
CircuitBreakerState
final def markSuccess(): Unit

Mark a successful element/response/call through CircuitBreaker.
Mark a successful element/response/call through CircuitBreaker.

Definition Classes
CircuitBreakerState
val maxFailures: Int

maximum number of failures before opening the circuit
maximum number of failures before opening the circuit

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
val maxResetTimeout: FiniteDuration

the upper bound of resetTimeout
the upper bound of resetTimeout

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
val metricRegistry: MetricRegistry

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
val name: String

used to differentiate circuit breakers in metrics
used to differentiate circuit breakers in metrics

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
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
Definition Classes
CircuitBreakerState
val resetTimeout: FiniteDuration

scala.concurrent.duration.FiniteDuration of time after which to attempt to close the circuit
scala.concurrent.duration.FiniteDuration of time after which to attempt to close the circuit

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
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

Definition Classes
CircuitBreakerState
def succeeds(): Unit

Mark a successful call through CircuitBreaker.
Mark a successful call through CircuitBreaker.

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
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
Definition Classes
CircuitBreakerState
def transitionImpl(fromState: State, toState: State): Boolean

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 from

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState
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
Definition Classes
CircuitBreakerState
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( ... )
def withMetricRegistry(metricRegistry: MetricRegistry): AtomicCircuitBreakerState

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

Definition Classes
AtomicCircuitBreakerState → CircuitBreakerState

Related Docs: object AtomicCircuitBreakerState | package impl

class AtomicCircuitBreakerState extends AbstractAtomicCircuitBreakerLogic with CircuitBreakerState

Instance Constructors

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

val callTimeout: FiniteDuration

final def checkAndMarkIfShortCircuit(): Boolean

def clone(): AnyRef

def currentState: State

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val exponentialBackoffFactor: Double

def fails(): Unit

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isShortCircuited: Boolean

val mBeanServer: MBeanServer

final def markFailure(): Unit

final def markSuccess(): Unit

val maxFailures: Int

val maxResetTimeout: FiniteDuration

val metricRegistry: MetricRegistry

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def resetBreaker(): Unit

val resetTimeout: FiniteDuration

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

def succeeds(): Unit

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

def toString(): String

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

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

final def tripBreaker(fromState: State): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withMetricRegistry(metricRegistry: MetricRegistry): AtomicCircuitBreakerState

Inherited from CircuitBreakerState

Inherited from AbstractAtomicCircuitBreakerLogic

Inherited from AnyRef

Inherited from Any

Ungrouped