Expose success and fail methods in CircuitBreaker #18347

akka-docs/rst/common/code/docs/circuitbreaker/CircuitBreakerDocSpec.scala

@@ -8,10 +8,9 @@ package docs.circuitbreaker
 import scala.concurrent.duration._
 import akka.pattern.CircuitBreaker
 import akka.pattern.pipe
-import akka.actor.Actor
-import akka.actor.ActorLogging
+import akka.actor.{Actor, ActorLogging, ActorRef}
+
 import scala.concurrent.Future
-import akka.event.Logging
 
 //#imports1
 
@@ -45,3 +44,35 @@ class DangerousActor extends Actor with ActorLogging {
 
 }
 
+class TellPatternActor(recipient : ActorRef) extends Actor with ActorLogging {
+  import context.dispatcher
+
+  val breaker =
+    new CircuitBreaker(
+      context.system.scheduler,
+      maxFailures = 5,
+      callTimeout = 10.seconds,
+      resetTimeout = 1.minute).onOpen(notifyMeOnOpen())
+
+  def notifyMeOnOpen(): Unit =
+    log.warning("My CircuitBreaker is now open, and will not close for one minute")
+
+  //#circuit-breaker-tell-pattern
+  import akka.actor.ReceiveTimeout
+
+  def receive = {
+    case "call" if breaker.isClosed => {
+      recipient ! "message"
+    }
+    case "response" => {
+      breaker.succeed()
+    }
+    case err: Throwable => {
+      breaker.fail()
+    }
+    case ReceiveTimeout => {
+      breaker.fail()
+    }
+  }
+  //#circuit-breaker-tell-pattern
+}

akka-docs/rst/common/code/docs/circuitbreaker/TellPatternJavaActor.java

@@ -0,0 +1,51 @@
+/**
+ * Copyright (C) 2009-2016 Lightbend Inc. <http://www.lightbend.com>
+ */
+package docs.circuitbreaker;
+
+import akka.actor.ActorRef;
+import akka.actor.ReceiveTimeout;
+import akka.actor.UntypedActor;
+import akka.event.Logging;
+import akka.event.LoggingAdapter;
+import akka.pattern.CircuitBreaker;
+import scala.concurrent.duration.Duration;
+
+public class TellPatternJavaActor extends UntypedActor {
+
+  private final ActorRef       target;
+  private final CircuitBreaker breaker;
+  private final LoggingAdapter log = Logging.getLogger(getContext().system(), this);
+
+  public TellPatternJavaActor(ActorRef targetActor) {
+    this.target  = targetActor;
+    this.breaker = new CircuitBreaker(
+      getContext().dispatcher(), getContext().system().scheduler(),
+      5, Duration.create(10, "s"), Duration.create(1, "m"))
+      .onOpen(new Runnable() {
+        public void run() {
+          notifyMeOnOpen();
+        }
+      });
+  }
+
+  public void notifyMeOnOpen() {
+    log.warning("My CircuitBreaker is now open, and will not close for one minute");
+  }
+
+  //#circuit-breaker-tell-pattern
+  @Override
+  public void onReceive(Object payload) {
+    if ( "call".equals(payload) && breaker.isClosed() ) {
+      target.tell("message", getSelf());
+    } else if ( "response".equals(payload) ) {
+      breaker.succeed();
+    } else if ( payload instanceof Throwable ) {
+      breaker.fail();
+    } else if ( payload instanceof ReceiveTimeout ) {
+      breaker.fail();
+    }
+  }
+  //#circuit-breaker-tell-pattern
+
+}