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
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- BackoffOptions
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Abstract Value Members
-
abstract
def
withAutoReset(resetBackoff: FiniteDuration): BackoffOptions
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.
-
abstract
def
withDefaultStoppingStrategy: BackoffOptions
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 bySupervisorStrategy.stoppingStrategy. -
abstract
def
withManualReset: BackoffOptions
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.Resetto its parent (the backoff-supervisor actor). -
abstract
def
withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOptions
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.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BackoffOptions to any2stringadd[BackoffOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BackoffOptions, B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (BackoffOptions, B)
- Implicit
- 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
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Inherited from Any
Inherited by implicit conversion any2stringadd from BackoffOptions to any2stringadd[BackoffOptions]
Value Members
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BackoffOptions to any2stringadd[BackoffOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
Inherited by implicit conversion StringFormat from BackoffOptions to StringFormat[BackoffOptions]
Value Members
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
Inherited by implicit conversion Ensuring from BackoffOptions to Ensuring[BackoffOptions]
Value Members
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
Inherited by implicit conversion ArrowAssoc from BackoffOptions to ArrowAssoc[BackoffOptions]
Value Members
-
def
->[B](y: B): (BackoffOptions, B)
- Implicit
- 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()
-
def
→[B](y: B): (BackoffOptions, B)
- Implicit
- This member is added by an implicit conversion from BackoffOptions to ArrowAssoc[BackoffOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Ungrouped
-
abstract
def
withAutoReset(resetBackoff: FiniteDuration): BackoffOptions
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.
-
abstract
def
withDefaultStoppingStrategy: BackoffOptions
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 bySupervisorStrategy.stoppingStrategy. -
abstract
def
withManualReset: BackoffOptions
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.Resetto its parent (the backoff-supervisor actor). -
abstract
def
withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): BackoffOptions
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.
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BackoffOptions to any2stringadd[BackoffOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BackoffOptions, B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BackoffOptions) ⇒ Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BackoffOptions
- Implicit
- This member is added by an implicit conversion from BackoffOptions to Ensuring[BackoffOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (BackoffOptions, B)
- Implicit
- This member is added by an implicit conversion from BackoffOptions to ArrowAssoc[BackoffOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc