akka.pattern

Interface BackoffOptions

All Known Implementing Classes:

BackoffOptionsImpl

public interface BackoffOptions

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)
 

Method Summary

Modifier and Type	Method and Description
Props	props() Returns the props to create the back-off supervisor.
BackoffOptions	withAutoReset(scala.concurrent.duration.FiniteDuration resetBackoff) Returns a new BackoffOptions with automatic back-off reset.
BackoffOptions	withDefaultStoppingStrategy() Returns a new BackoffOptions with a default SupervisorStrategy.stoppingStrategy.
BackoffOptions	withManualReset() Returns a new BackoffOptions with manual back-off reset.
BackoffOptions	withSupervisorStrategy(OneForOneStrategy supervisorStrategy) Returns a new BackoffOptions with the supervisorStrategy.

Method Detail

withAutoReset

BackoffOptions withAutoReset(scala.concurrent.duration.FiniteDuration resetBackoff)

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.

Parameters:

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

Returns:

(undocumented)

withManualReset

BackoffOptions withManualReset()

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

Returns:

(undocumented)

withSupervisorStrategy

BackoffOptions withSupervisorStrategy(OneForOneStrategy supervisorStrategy)

Returns a new BackoffOptions with the supervisorStrategy.

Parameters:

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.

Returns:

(undocumented)

withDefaultStoppingStrategy

BackoffOptions withDefaultStoppingStrategy()

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

Returns:

(undocumented)

props

Props props()

Returns the props to create the back-off supervisor.

Returns:

(undocumented)