akka.pattern
Class CircuitBreaker$

java.lang.Object
  extended by akka.pattern.CircuitBreaker$

public class CircuitBreaker$
extends java.lang.Object

Companion object providing factory methods for Circuit Breaker which runs callbacks in caller's thread


Field Summary
static CircuitBreaker$ MODULE$
          Static reference to the singleton instance of this Scala object.
 
Constructor Summary
CircuitBreaker$()
           
 
Method Summary
 CircuitBreaker apply(Scheduler scheduler, int maxFailures, scala.concurrent.duration.FiniteDuration callTimeout, scala.concurrent.duration.FiniteDuration resetTimeout)
          Create a new CircuitBreaker.
 CircuitBreaker create(Scheduler scheduler, int maxFailures, scala.concurrent.duration.FiniteDuration callTimeout, scala.concurrent.duration.FiniteDuration resetTimeout)
          Java API: Create a new CircuitBreaker.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE$

public static final CircuitBreaker$ MODULE$
Static reference to the singleton instance of this Scala object.

Constructor Detail

CircuitBreaker$

public CircuitBreaker$()
Method Detail

apply

public CircuitBreaker apply(Scheduler scheduler,
                            int maxFailures,
                            scala.concurrent.duration.FiniteDuration callTimeout,
                            scala.concurrent.duration.FiniteDuration resetTimeout)
Create a new CircuitBreaker.

Callbacks run in caller's thread when using withSyncCircuitBreaker, and in same ExecutionContext as the passed in Future when using withCircuitBreaker. To use another ExecutionContext for the callbacks you can specify the executor in the constructor.

Parameters:
scheduler - Reference to Akka scheduler
maxFailures - Maximum number of failures before opening the circuit
callTimeout - FiniteDuration of time after which to consider a call a failure
resetTimeout - FiniteDuration of time after which to attempt to close the circuit

create

public CircuitBreaker create(Scheduler scheduler,
                             int maxFailures,
                             scala.concurrent.duration.FiniteDuration callTimeout,
                             scala.concurrent.duration.FiniteDuration resetTimeout)
Java API: Create a new CircuitBreaker.

Callbacks run in caller's thread when using withSyncCircuitBreaker, and in same ExecutionContext as the passed in Future when using withCircuitBreaker. To use another ExecutionContext for the callbacks you can specify the executor in the constructor.

Parameters:
scheduler - Reference to Akka scheduler
maxFailures - Maximum number of failures before opening the circuit
callTimeout - FiniteDuration of time after which to consider a call a failure
resetTimeout - FiniteDuration of time after which to attempt to close the circuit