trait GracefulStopSupport extends AnyRef
- Alphabetic
- By Inheritance
- GracefulStopSupport
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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 }
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
Inherited from AnyRef
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
- Deprecated
(Since version ) see corresponding Javadoc for more information.
Inherited from Any
Inherited by implicit conversion any2stringadd from GracefulStopSupport to any2stringadd[GracefulStopSupport]
Value Members
-
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
Inherited by implicit conversion StringFormat from GracefulStopSupport to StringFormat[GracefulStopSupport]
Value Members
-
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()
Inherited by implicit conversion Ensuring from GracefulStopSupport to Ensuring[GracefulStopSupport]
Value Members
-
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
-
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
-
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
-
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
Inherited by implicit conversion ArrowAssoc from GracefulStopSupport to ArrowAssoc[GracefulStopSupport]
Value Members
-
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()
-
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
Ungrouped
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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 }
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
- Deprecated
(Since version ) see corresponding Javadoc for more information.