akka.pattern

Class BackoffOnRestartSupervisor

java.lang.Object

akka.pattern.BackoffOnRestartSupervisor

All Implemented Interfaces:

Actor, ActorLogging, HandleBackoff

public class BackoffOnRestartSupervisor
extends java.lang.Object
implements Actor, HandleBackoff, ActorLogging

Back-off supervisor that stops and starts a child actor when the child actor restarts. This back-off supervisor is created by using akka.pattern.BackoffSupervisor.props with akka.pattern.Backoff.onFailure.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
BackoffOnRestartSupervisor(Props childProps, java.lang.String childName, scala.concurrent.duration.FiniteDuration minBackoff, scala.concurrent.duration.FiniteDuration maxBackoff, BackoffReset reset, double randomFactor, OneForOneStrategy strategy)

Method Summary

Modifier and Type	Method and Description
scala.Option<ActorRef>	child()
java.lang.String	childName()
Props	childProps()
ActorContext	context() Stores the context for this actor, including self, and sender.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	onTerminated()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
BackoffReset	reset()
int	restartCount()
ActorRef	self() The 'self' field holds the ActorRef for this actor.
OneForOneStrategy	supervisorStrategy() User overridable definition the strategy to use for supervising child actors.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	waitChildTerminatedBeforeBackoff(ActorRef childRef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, postStop, preRestart, preStart, sender, unhandled

Methods inherited from interface akka.pattern.HandleBackoff

handleBackoff, preStart, startChild

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

BackoffOnRestartSupervisor

public BackoffOnRestartSupervisor(Props childProps,
                                  java.lang.String childName,
                                  scala.concurrent.duration.FiniteDuration minBackoff,
                                  scala.concurrent.duration.FiniteDuration maxBackoff,
                                  BackoffReset reset,
                                  double randomFactor,
                                  OneForOneStrategy strategy)

Method Detail

child

public scala.Option<ActorRef> child()

Specified by:

child in interface HandleBackoff

restartCount

public int restartCount()

Specified by:

restartCount in interface HandleBackoff

context

public ActorContext context()

Description copied from interface: Actor

Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a UntypedActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

childProps

public Props childProps()

Specified by:

childProps in interface HandleBackoff

childName

public java.lang.String childName()

Specified by:

childName in interface HandleBackoff

reset

public BackoffReset reset()

Specified by:

reset in interface HandleBackoff

supervisorStrategy

public OneForOneStrategy supervisorStrategy()

Description copied from interface: Actor

User overridable definition the strategy to use for supervising child actors.

Specified by:

supervisorStrategy in interface Actor

Returns:

(undocumented)

waitChildTerminatedBeforeBackoff

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> waitChildTerminatedBeforeBackoff(ActorRef childRef)

onTerminated

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> onTerminated()

receive

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Returns:

(undocumented)