akka.contrib.circuitbreaker

Class CircuitBreakerProxy$

java.lang.Object

akka.contrib.circuitbreaker.CircuitBreakerProxy$

public class CircuitBreakerProxy$
extends java.lang.Object

This is an Actor which implements the circuit breaker pattern, you may also be interested in the raw circuit breaker CircuitBreaker

Field Summary

Fields

Modifier and Type	Field and Description
static CircuitBreakerProxy$	MODULE$ Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerProxy$()

Method Summary

Modifier and Type	Method and Description
Props	props(ActorRef target, int maxFailures, Timeout callTimeout, Timeout resetTimeout, scala.Option<ActorRef> circuitEventListener, scala.Function1<java.lang.Object,java.lang.Object> failureDetector, scala.Function1<CircuitBreakerProxy.CircuitOpenFailure,java.lang.Object> failureMap) Creates an circuit breaker actor proxying a target actor intended for request-reply interactions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULE$

public static final CircuitBreakerProxy$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

CircuitBreakerProxy$

public CircuitBreakerProxy$()

Method Detail

props

public Props props(ActorRef target,
                   int maxFailures,
                   Timeout callTimeout,
                   Timeout resetTimeout,
                   scala.Option<ActorRef> circuitEventListener,
                   scala.Function1<java.lang.Object,java.lang.Object> failureDetector,
                   scala.Function1<CircuitBreakerProxy.CircuitOpenFailure,java.lang.Object> failureMap)

Creates an circuit breaker actor proxying a target actor intended for request-reply interactions. It is possible to send messages through this proxy without expecting a response wrapping them into a CircuitBreakerProxy.TellOnly or a CircuitBreakerProxy.Passthrough the difference between the two being that a message wrapped into a CircuitBreakerProxy.Passthrough is going to be forwarded even when the circuit is open (e.g. if you need to terminate the target and proxy actors sending a PoisonPill message)

The circuit breaker implements the same state machine documented in CircuitBreaker

Parameters:

target - the actor to proxy

maxFailures - maximum number of failures before opening the circuit

callTimeout - timeout before considering the ongoing call a failure

resetTimeout - time after which the channel will be closed after entering the open state

circuitEventListener - an actor that will receive a series of messages of type CircuitBreakerProxy.CircuitBreakerEvent

failureDetector - function to detect if the a message received from the target actor as response from a request represent a failure

failureMap - function to map a failure into a response message. The failing response message is wrapped into a CircuitBreakerProxy.CircuitOpenFailure object

Returns:

(undocumented)