Packages

t

akka.pattern

GracefulStopSupport

trait GracefulStopSupport extends AnyRef

Source
GracefulStopSupport.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GracefulStopSupport
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to any2stringadd[GracefulStopSupport] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GracefulStopSupport, B)
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to ArrowAssoc[GracefulStopSupport] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (GracefulStopSupport) ⇒ Boolean, msg: ⇒ Any): GracefulStopSupport
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to Ensuring[GracefulStopSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GracefulStopSupport) ⇒ Boolean): GracefulStopSupport
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to Ensuring[GracefulStopSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): GracefulStopSupport
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to Ensuring[GracefulStopSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GracefulStopSupport
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to Ensuring[GracefulStopSupport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to StringFormat[GracefulStopSupport] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any = PoisonPill): Future[Boolean]

    Returns a scala.concurrent.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.

    Returns a scala.concurrent.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 scala.concurrent.Future is completed with failure akka.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
    }
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (GracefulStopSupport, B)
    Implicit
    This member is added by an implicit conversion from GracefulStopSupport to ArrowAssoc[GracefulStopSupport] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GracefulStopSupport to any2stringadd[GracefulStopSupport]

Inherited by implicit conversion StringFormat from GracefulStopSupport to StringFormat[GracefulStopSupport]

Inherited by implicit conversion Ensuring from GracefulStopSupport to Ensuring[GracefulStopSupport]

Inherited by implicit conversion ArrowAssoc from GracefulStopSupport to ArrowAssoc[GracefulStopSupport]

Ungrouped