akka.actor.dsl.Creators

ActWithStash

Related Doc: package Creators

trait ActWithStash extends ActorDSL.Act with Stash

Use this trait when defining an akka.actor.Actor with akka.actor.Stash, since just using actor()(new Act with Stash{}) will not be able to see the Stash component due to type erasure.

Source
Creators.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActWithStash
  2. Stash
  3. RequiresMessageQueue
  4. UnrestrictedStash
  5. StashSupport
  6. Act
  7. Actor
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

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 information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to any2stringadd[ActorDSL.ActWithStash] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorDSL.ActWithStash, B)

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to ArrowAssoc[ActorDSL.ActWithStash] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def AllForOneStrategy: actor.AllForOneStrategy.type

    Definition Classes
    Act
    See also

    akka.actor.AllForOneStrategy

  7. def Escalate: SupervisorStrategy.Escalate.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  8. def OneForOneStrategy: actor.OneForOneStrategy.type

    Definition Classes
    Act
    See also

    akka.actor.OneForOneStrategy

  9. def Restart: SupervisorStrategy.Restart.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  10. def Resume: SupervisorStrategy.Resume.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  11. def Stop: SupervisorStrategy.Stop.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  12. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  13. def aroundPostStop(): Unit

    Can be overridden to intercept calls to postStop.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  14. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Can be overridden to intercept calls to preRestart.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  15. def aroundPreStart(): Unit

    Can be overridden to intercept calls to preStart.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  16. def aroundReceive(receive: Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  17. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  18. def become(r: Receive): Unit

    Replace the behavior at the top of the behavior stack for this actor.

    Replace the behavior at the top of the behavior stack for this actor. The stack is cleared upon restart. Use unbecome() to pop an element off this stack or becomeStacked() to push a new element on top of it.

    Definition Classes
    Act
  19. def becomeStacked(r: Receive): Unit

    Add the given behavior on top of the behavior stack for this actor.

    Add the given behavior on top of the behavior stack for this actor. This stack is cleared upon restart. Use unbecome() to pop an element off this stack.

    Definition Classes
    Act
  20. def clone(): AnyRef

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

    Stores the context for this actor, including self, and sender.

    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!

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

    Definition Classes
    Actor
  22. def ensuring(cond: (ActorDSL.ActWithStash) ⇒ Boolean, msg: ⇒ Any): ActorDSL.ActWithStash

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to Ensuring[ActorDSL.ActWithStash] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: (ActorDSL.ActWithStash) ⇒ Boolean): ActorDSL.ActWithStash

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to Ensuring[ActorDSL.ActWithStash] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean, msg: ⇒ Any): ActorDSL.ActWithStash

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to Ensuring[ActorDSL.ActWithStash] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean): ActorDSL.ActWithStash

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to Ensuring[ActorDSL.ActWithStash] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to StringFormat[ActorDSL.ActWithStash] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

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

    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  34. final def notify(): Unit

    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  36. def postRestart(cause: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    Definition Classes
    ActActor
  37. def postStop(): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.

    Definition Classes
    UnrestrictedStashActor
  38. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    UnrestrictedStashActor
  39. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    ActActor
  40. def receive: Receive

    Default behavior of the actor is empty, use become to change this.

    Default behavior of the actor is empty, use become to change this.

    Definition Classes
    ActActor
  41. implicit final val self: ActorRef

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

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

    Can be used to send messages to itself:

    self ! message
    

    Definition Classes
    Actor
  42. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

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

    Definition Classes
    Actor
  43. def stash(): Unit

    Adds the current message (the message that the actor received last) to the actor's stash.

    Adds the current message (the message that the actor received last) to the actor's stash.

    Definition Classes
    StashSupport
    Exceptions thrown

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  44. def superviseWith(s: SupervisorStrategy): Unit

    Set the supervisor strategy of this actor, i.e.

    Set the supervisor strategy of this actor, i.e. how it supervises its children.

    Definition Classes
    Act
  45. def supervisorStrategy: SupervisorStrategy

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

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

    Definition Classes
    ActActor
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  47. def toString(): String

    Definition Classes
    AnyRef → Any
  48. def unbecome(): Unit

    Pop the active behavior from the behavior stack of this actor.

    Pop the active behavior from the behavior stack of this actor. This stack is cleared upon restart.

    Definition Classes
    Act
  49. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Actor
  50. def unstashAll(): Unit

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.

    The stash is guaranteed to be empty after calling unstashAll().

    Definition Classes
    StashSupport
  51. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. def whenFailing(body: (Throwable, Option[Any]) ⇒ Unit): Unit

    Replace the preRestart action with the supplied function.

    Replace the preRestart action with the supplied function. Default action is to call super.preRestart(), which will kill all children and invoke postStop().

    Definition Classes
    Act
  55. def whenRestarted(body: (Throwable) ⇒ Unit): Unit

    Replace the postRestart action with the supplied function.

    Replace the postRestart action with the supplied function. Default action is to call super.postRestart which will call preStart().

    Definition Classes
    Act
  56. def whenStarting(body: ⇒ Unit): Unit

    Replace the preStart action with the supplied thunk.

    Replace the preStart action with the supplied thunk. Default action is to call super.preStart()

    Definition Classes
    Act
  57. def whenStopping(body: ⇒ Unit): Unit

    Replace the postStop action with the supplied thunk.

    Replace the postStop action with the supplied thunk. Default action is to call super.postStop.

    Definition Classes
    Act
  58. def [B](y: B): (ActorDSL.ActWithStash, B)

    Implicit information
    This member is added by an implicit conversion from ActorDSL.ActWithStash to ArrowAssoc[ActorDSL.ActWithStash] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from ActorDSL.Act

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorDSL.ActWithStash to any2stringadd[ActorDSL.ActWithStash]

Inherited by implicit conversion StringFormat from ActorDSL.ActWithStash to StringFormat[ActorDSL.ActWithStash]

Inherited by implicit conversion Ensuring from ActorDSL.ActWithStash to Ensuring[ActorDSL.ActWithStash]

Inherited by implicit conversion ArrowAssoc from ActorDSL.ActWithStash to ArrowAssoc[ActorDSL.ActWithStash]

Ungrouped