Packages

t

akka.actor.dsl.Creators

ActWithStash

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
Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, ActorDSL.Act, Actor, AnyRef, Any
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
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Value Members

  1. def AllForOneStrategy: actor.AllForOneStrategy.type

    Definition Classes
    Act
    See also

    akka.actor.AllForOneStrategy

  2. def Escalate: SupervisorStrategy.Escalate.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  3. def OneForOneStrategy: actor.OneForOneStrategy.type

    Definition Classes
    Act
    See also

    akka.actor.OneForOneStrategy

  4. def Restart: SupervisorStrategy.Restart.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  5. def Resume: SupervisorStrategy.Resume.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  6. def Stop: SupervisorStrategy.Stop.type

    Definition Classes
    Act
    See also

    akka.actor.SupervisorStrategy

  7. 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
  8. 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
  9. implicit val context: ActorContext

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

    Scala API: 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.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  10. def postRestart(cause: Throwable): Unit

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

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

    Definition Classes
    Act → Actor
  11. 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
    UnrestrictedStash → Actor
    Annotations
    @throws( classOf[Exception] )
  12. 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
    UnrestrictedStash → Actor
    Annotations
    @throws( classOf[Exception] )
  13. 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
    Act → Actor
  14. 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
    Act → Actor
  15. 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
  16. 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
  17. 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

  18. 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
  19. 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
    Act → Actor
  20. 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
  21. 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
  22. 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
  23. 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
  24. 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
  25. 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
  26. 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