Merge pull request akka#22719 from akka/backoffSupervisorDocumentation

Document using OneForOne with BackoffSupervisor
slamj1 · Apr 14, 2017 · 6d22dd1 · 6d22dd1
2 parents 4246dcd + 3ef035f
commit 6d22dd1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/akka-actor/src/main/scala/akka/pattern/BackoffOptions.scala b/akka-actor/src/main/scala/akka/pattern/BackoffOptions.scala
@@ -166,7 +166,8 @@ trait BackoffOptions {
    * Returns a new BackoffOptions with the supervisorStrategy.
    * @param supervisorStrategy the supervisorStrategy that the back-off supervisor will use.
    *   The default supervisor strategy is used as fallback if the specified supervisorStrategy (its decider)
-   *   does not explicitly handle an exception.
+   *   does not explicitly handle an exception. As the BackoffSupervisor creates a separate actor to handle the
+   *   backoff process, only a [[OneForOneStrategy]] makes sense here.
    */
   def withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOptions
 

diff --git a/akka-actor/src/main/scala/akka/pattern/BackoffSupervisor.scala b/akka-actor/src/main/scala/akka/pattern/BackoffSupervisor.scala
@@ -65,7 +65,8 @@ object BackoffSupervisor {
    *   random delay based on this factor is added, e.g. `0.2` adds up to `20%` delay.
    *   In order to skip this additional delay pass in `0`.
    * @param strategy the supervision strategy to use for handling exceptions
-   *   in the child
+   *   in the child. As the BackoffSupervisor creates a separate actor to handle the
+   *   backoff process, only a [[OneForOneStrategy]] makes sense here.
    */
   def propsWithSupervisorStrategy(
     childProps:   Props,