Trait/Object

com.github.j5ik2o.akka.backoff.enhancement

BackoffOptions

Related Docs: object BackoffOptions | package enhancement

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)
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BackoffOptions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val backoffType: BackoffType

    Permalink

  2. abstract val childName: String

    Permalink

  3. abstract val childProps: Props

    Permalink

  4. abstract val eventSubscriber: Option[ActorRef]

    Permalink

  5. abstract val maxBackoff: FiniteDuration

    Permalink

  6. abstract val minBackoff: FiniteDuration

    Permalink

  7. abstract val onStartChildHandler: (ActorRef, Option[Throwable]) ⇒ Unit

    Permalink

  8. abstract val onStopChildHandler: (ActorRef) ⇒ Unit

    Permalink

  9. abstract val randomFactor: Double

    Permalink

  10. abstract val reset: Option[BackoffReset]

    Permalink

  11. abstract val supervisorStrategy: OneForOneStrategy

    Permalink

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

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

  14. abstract def withEventSubscriber(subscriber: Option[ActorRef]): BackoffOptions

    Permalink

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

  16. abstract def withOnStartChildHandler(onStartChildHandler: (ActorRef, Option[Throwable]) ⇒ Unit): BackoffOptions

    Permalink

  17. abstract def withOnStopChildHandler(onStopChildHandler: (ActorRef) ⇒ Unit): BackoffOptions

    Permalink

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

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped