Class

org.squbs.lifecycle

ActorWithGracefulStopHelper

Related Doc: package lifecycle

Permalink

abstract class ActorWithGracefulStopHelper extends AbstractActor with GracefulStopHelper

Java API for creating actors with GracefulStopHelper.

Linear Supertypes
GracefulStopHelper, ActorLogging, GracefulStopSupport, AbstractActor, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorWithGracefulStopHelper
  2. GracefulStopHelper
  3. ActorLogging
  4. GracefulStopSupport
  5. AbstractActor
  6. Actor
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ActorWithGracefulStopHelper()

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def createReceive(): akka.actor.AbstractActor.Receive

    Permalink
    Definition Classes
    AbstractActor

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  5. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  6. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  7. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  8. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  12. final def defaultLeafActorStop: Unit

    Permalink

    Default gracefully stop behavior for leaf level actors (Actors only receive the msg as input and send out a result) towards the GracefulStop message

    Default gracefully stop behavior for leaf level actors (Actors only receive the msg as input and send out a result) towards the GracefulStop message

    Simply stop itself

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  13. final def defaultMidActorStop(dependencies: List[ActorRef]): Unit

    Permalink

    Java API stopping non-leaf actors with default timeout.

    Java API stopping non-leaf actors with default timeout.

    dependencies

    All non-leaf actors to be stopped.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  14. final def defaultMidActorStop(dependencies: List[ActorRef], timeout: Duration): Unit

    Permalink

    Java API stopping non-leaf actors.

    Java API stopping non-leaf actors.

    dependencies

    All non-leaf actors to be stopped.

    timeout

    The timeout.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  15. final def defaultMidActorStop(dependencies: Iterable[ActorRef], timeout: FiniteDuration = stopTimeout / 2): Unit

    Permalink

    Default gracefully stop behavior for middle level actors (Actors rely on the results of other actors to finish their tasks) towards the GracefulStop message

    Default gracefully stop behavior for middle level actors (Actors rely on the results of other actors to finish their tasks) towards the GracefulStop message

    Simply propagate the GracefulStop message to all actors that should be stop ahead of this actor

    If some actors failed to respond to the GracefulStop message, It will send PoisonPill again

    After all the actors get terminated it stops itself

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getContext(): ActorContext

    Permalink
    Definition Classes
    AbstractActor
  21. def getSelf(): ActorRef

    Permalink
    Definition Classes
    AbstractActor
  22. def getSender(): ActorRef

    Permalink
    Definition Classes
    AbstractActor
  23. def getStopTimeout: Long

    Permalink

    Override getStopTimeout to set a custom stop timeout.

    Override getStopTimeout to set a custom stop timeout.

    returns

    The timeout, in milliseconds to allow for stopping the server.

  24. final def gracefulStop(target: ActorRef, timeout: Duration): CompletionStage[Boolean]

    Permalink

    Java API for gracefulStop using the default message - PoisonPill.

    Java API for gracefulStop using the default message - PoisonPill.

    target

    The target actor to stop.

    timeout

    The timeout.

    returns

    A CompletionStage carrying true for success stopping the target.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  25. def gracefulStop(target: ActorRef, timeout: Duration, stopMessage: Any): CompletionStage[Boolean]

    Permalink

    Java API for gracefulStop.

    Java API for gracefulStop.

    target

    The target actor to stop.

    timeout

    The timeout.

    stopMessage

    The message to send to the actor for stopping.

    returns

    A CompletionStage carrying true for success stopping the target.

    Attributes
    protected
    Definition Classes
    GracefulStopHelper
  26. def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any): Future[Boolean]

    Permalink
    Definition Classes
    GracefulStopSupport
  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def log: LoggingAdapter

    Permalink
    Definition Classes
    ActorLogging
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    AbstractActor → Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  34. def postStop(): Unit

    Permalink
    Definition Classes
    AbstractActor → Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  35. def preRestart(reason: Throwable, message: Optional[Any]): Unit

    Permalink
    Definition Classes
    AbstractActor
    Annotations
    @throws( classOf[java.lang.Exception] )
  36. def preStart(): Unit

    Permalink
    Definition Classes
    AbstractActor → Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  37. def receive: PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    AbstractActor → Actor
  38. final def receiveBuilder(): ReceiveBuilder

    Permalink
    Definition Classes
    AbstractActor
  39. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  40. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  41. final def stopTimeout: FiniteDuration

    Permalink

    Duration that the actor needs to finish the graceful stop.

    Duration that the actor needs to finish the graceful stop. Override it for customized timeout and it will be registered to the reaper Default to 5 seconds

    returns

    Duration

    Definition Classes
    ActorWithGracefulStopHelperGracefulStopHelper
  42. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    AbstractActor → Actor
  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  44. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  45. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Actor
  46. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Definition Classes
    AbstractActor → Actor
    Annotations
    @deprecated @throws( classOf[java.lang.Exception] )
    Deprecated

    (Since version 2.5.0) Override preRestart with message parameter with Optional type instead

Inherited from GracefulStopHelper

Inherited from ActorLogging

Inherited from GracefulStopSupport

Inherited from AbstractActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped