Package org.apache.pekko.pattern

Interface GracefulStopSupport

public interface GracefulStopSupport

Method Summary

Modifier and Type	Method	Description
scala.concurrent.Future<Object>	gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout, Object stopMessage)	Returns a Future that will be completed with success (value true) when existing messages of the target actor has been processed and the actor has been terminated.
Object	gracefulStop$default$3()

Method Details

gracefulStop

scala.concurrent.Future<Object> gracefulStop(ActorRef target,
 scala.concurrent.duration.FiniteDuration timeout,
 Object stopMessage)

Returns a Future that will be completed with success (value true) when existing messages of the target actor has been processed and the actor has been terminated.

Useful when you need to wait for termination or compose ordered termination of several actors, which should only be done outside of the ActorSystem as blocking inside Actors is discouraged.

IMPORTANT NOTICE: the actor being terminated and its supervisor being informed of the availability of the deceased actor’s name are two distinct operations, which do not obey any reliable ordering. Especially the following will NOT work:

 def receive = {
   case msg =>
     Await.result(gracefulStop(someChild, timeout), timeout)
     context.actorOf(Props(...), "someChild") // assuming that that was someChild’s name, this will NOT work
 }
 

If the target actor isn't terminated within the timeout the Future is completed with failure pekko.pattern.AskTimeoutException.

If you want to invoke specialized stopping logic on your target actor instead of PoisonPill, you can pass your stop command as a parameter:

   gracefulStop(someChild, timeout, MyStopGracefullyMessage).onComplete {
      // Do something after someChild being stopped
   }
 

gracefulStop$default$3

Object gracefulStop$default$3()