Packages

t

akka.pattern

BackoffOnFailureOptions

sealed trait BackoffOnFailureOptions extends ExtendedBackoffOptions[BackoffOnFailureOptions]

Annotations
@DoNotInherit()
Source
BackoffOptions.scala
Linear Supertypes
ExtendedBackoffOptions[BackoffOnFailureOptions], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BackoffOnFailureOptions
  2. ExtendedBackoffOptions
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

    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.

    Definition Classes
    ExtendedBackoffOptions
  2. abstract def withHandlerWhileStopped(handler: ActorRef): BackoffOnFailureOptions

    Returns a new BackoffOptions with a custom handler for messages that the supervisor receives while its child is stopped.

    Returns a new BackoffOptions with a custom handler for messages that the supervisor receives while its child is stopped. By default, a message received while the child is stopped is forwarded to deadLetters. Essentially, this handler replaces deadLetters allowing to implement custom handling instead of a static reply.

    handler

    PartialFunction of the received message and sender

    Definition Classes
    ExtendedBackoffOptions
  3. abstract def withManualReset: BackoffOnFailureOptions

    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).

    Definition Classes
    ExtendedBackoffOptions
  4. abstract def withMaxNrOfRetries(maxNrOfRetries: Int): BackoffOnFailureOptions

    Returns a new BackoffOptions with a maximum number of retries to restart the child actor.

    Returns a new BackoffOptions with a maximum number of retries to restart the child actor. By default, the supervisor will retry infinitely. With this option, the supervisor will terminate itself after the maxNoOfRetries is reached.

    maxNrOfRetries

    the number of times a child actor is allowed to be restarted. If negative, the value is unbounded, otherwise the provided limit is used. If the limit is exceeded the child actor will be stopped.

    Definition Classes
    ExtendedBackoffOptions
  5. abstract def withReplyWhileStopped(replyWhileStopped: Any): BackoffOnFailureOptions

    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.

    Definition Classes
    ExtendedBackoffOptions
  6. abstract def withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOnFailureOptions

    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. Note that changing the strategy will replace the previously defined maxNrOfRetries.

    Definition Classes
    ExtendedBackoffOptions

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toany2stringadd[BackoffOnFailureOptions] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BackoffOnFailureOptions, B)
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toArrowAssoc[BackoffOnFailureOptions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (BackoffOnFailureOptions) => Boolean, msg: => Any): BackoffOnFailureOptions
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toEnsuring[BackoffOnFailureOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (BackoffOnFailureOptions) => Boolean): BackoffOnFailureOptions
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toEnsuring[BackoffOnFailureOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): BackoffOnFailureOptions
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toEnsuring[BackoffOnFailureOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): BackoffOnFailureOptions
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toEnsuring[BackoffOnFailureOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toStringFormat[BackoffOnFailureOptions] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (BackoffOnFailureOptions, B)
    Implicit
    This member is added by an implicit conversion from BackoffOnFailureOptions toArrowAssoc[BackoffOnFailureOptions] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from ExtendedBackoffOptions[BackoffOnFailureOptions]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBackoffOnFailureOptions to any2stringadd[BackoffOnFailureOptions]

Inherited by implicit conversion StringFormat fromBackoffOnFailureOptions to StringFormat[BackoffOnFailureOptions]

Inherited by implicit conversion Ensuring fromBackoffOnFailureOptions to Ensuring[BackoffOnFailureOptions]

Inherited by implicit conversion ArrowAssoc fromBackoffOnFailureOptions to ArrowAssoc[BackoffOnFailureOptions]

Ungrouped