Trait

akka.pattern

BackoffOptions

Related Doc: package pattern

Permalink

trait BackoffOptions extends AnyRef

Configures a back-off supervisor actor. Start with Backoff.onStop or Backoff.onFailure. BackoffOptions is immutable, so be sure to chain methods like:

val options = Backoff.onFailure(childProps, childName, minBackoff, maxBackoff, randomFactor)
              .withManualReset
context.actorOf(BackoffSupervisor.props(options), name)
Source
BackoffOptions.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BackoffOptions
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def withAutoReset(resetBackoff: FiniteDuration): BackoffOptions

    Permalink

    Returns a new BackoffOptions with automatic back-off reset.

    Returns a new BackoffOptions with automatic back-off reset. The back-off algorithm is reset if the child does not crash within the specified resetBackoff.

    resetBackoff

    The back-off is reset if the child does not crash within this duration.

  2. abstract def withDefaultStoppingStrategy: BackoffOptions

    Permalink

    Returns a new BackoffOptions with a default SupervisorStrategy.stoppingStrategy.

    Returns a new BackoffOptions with a default SupervisorStrategy.stoppingStrategy. The default supervisor strategy is used as fallback for throwables not handled by SupervisorStrategy.stoppingStrategy.

  3. abstract def withManualReset: BackoffOptions

    Permalink

    Returns a new BackoffOptions with manual back-off reset.

    Returns a new BackoffOptions with manual back-off reset. The back-off is only reset if the child sends a BackoffSupervisor.Reset to its parent (the backoff-supervisor actor).

  4. abstract def withReplyWhileStopped(replyWhileStopped: Any): BackoffOptions

    Permalink

    Returns a new BackoffOptions with a constant reply to messages that the supervisor receives while its child is stopped.

    Returns a new BackoffOptions with a constant reply to messages that the supervisor receives while its child is stopped. By default, a message received while the child is stopped is forwarded to deadLetters. With this option, the supervisor will reply to the sender instead.

    replyWhileStopped

    The message that the supervisor will send in response to all messages while its child is stopped.

  5. abstract def withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOptions

    Permalink

    Returns a new BackoffOptions with the supervisorStrategy.

    Returns a new BackoffOptions with the supervisorStrategy.

    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. As the BackoffSupervisor creates a separate actor to handle the backoff process, only a OneForOneStrategy makes sense here.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to any2stringadd[BackoffOptions] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (BackoffOptions, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to ArrowAssoc[BackoffOptions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (BackoffOptions) ⇒ Boolean, msg: ⇒ Any): BackoffOptions

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (BackoffOptions) ⇒ Boolean): BackoffOptions

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): BackoffOptions

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): BackoffOptions

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to StringFormat[BackoffOptions] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (BackoffOptions, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BackoffOptions to ArrowAssoc[BackoffOptions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BackoffOptions to any2stringadd[BackoffOptions]

Inherited by implicit conversion StringFormat from BackoffOptions to StringFormat[BackoffOptions]

Inherited by implicit conversion Ensuring from BackoffOptions to Ensuring[BackoffOptions]

Inherited by implicit conversion ArrowAssoc from BackoffOptions to ArrowAssoc[BackoffOptions]

Ungrouped