Class

akka.actor

AbstractActorWithStash

Related Doc: package actor

Permalink

abstract class AbstractActorWithStash extends AbstractActor with Stash

Java API: compatible with lambda expressions

Actor base class that should be extended to create an actor with a stash.

The stash enables an actor to temporarily stash away messages that can not or should not be handled using the actor's current behavior.

Example:

public class MyActorWithStash extends AbstractActorWithStash {
  int count = 0;

  public MyActorWithStash() {
    receive(ReceiveBuilder. match(String.class, s -> {
      if (count < 0) {
        sender().tell(new Integer(s.length()), self());
      } else if (count == 2) {
        count = -1;
        unstashAll();
      } else {
        count += 1;
        stash();
      }}).build()
    );
  }
}
Note that the subclasses of AbstractActorWithStash by default request a Deque based mailbox since this class implements the RequiresMessageQueue<DequeBasedMessageQueueSemantics> marker interface. You can override the default mailbox provided when DequeBasedMessageQueueSemantics are requested via config:
  akka.actor.mailbox.requirements {
    "akka.dispatch.BoundedDequeBasedMessageQueueSemantics" = your-custom-mailbox
  }
Alternatively, you can add your own requirement marker to the actor and configure a mailbox type to be used for your marker.

For a Stash based actor that enforces unbounded deques see akka.actor.AbstractActorWithUnboundedStash. There is also an unrestricted version akka.actor.AbstractActorWithUnrestrictedStash that does not enforce the mailbox type.

Source
AbstractActor.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractActorWithStash
  2. Stash
  3. RequiresMessageQueue
  4. UnrestrictedStash
  5. StashSupport
  6. AbstractActor
  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

Instance Constructors

  1. new AbstractActorWithStash()

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def createReceive(): AbstractActor.Receive

    Permalink

    An actor has to define its initial receive behavior by implementing the createReceive method.

    An actor has to define its initial receive behavior by implementing the createReceive method.

    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. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from AbstractActorWithStash to any2stringadd[AbstractActorWithStash] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractActorWithStash, B)

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

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

    Permalink

    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
  7. def aroundPostStop(): Unit

    Permalink

    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
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    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
  9. def aroundPreStart(): Unit

    Permalink

    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
  10. def aroundReceive(receive: Actor.Receive, msg: Any): Unit

    Permalink

    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
  11. final def asInstanceOf[T0]: T0

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

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

    Permalink

    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
  14. def ensuring(cond: (AbstractActorWithStash) ⇒ Boolean, msg: ⇒ Any): AbstractActorWithStash

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

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

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

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

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

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

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

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

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

    Permalink

    Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Definition Classes
    AbstractActor
  24. def getSelf(): ActorRef

    Permalink

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Same as self().

    Definition Classes
    AbstractActor
  25. def getSender(): ActorRef

    Permalink

    The reference sender Actor of the currently processed message.

    The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

    Same as sender().

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

    Definition Classes
    AbstractActor
  26. def hashCode(): Int

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

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

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

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

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

    Permalink

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

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

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    AbstractActorActor
    Annotations
    @throws( classOf[Exception] )
  32. def postStop(): Unit

    Permalink

    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
  33. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    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
  34. def preRestart(reason: Throwable, message: Optional[Any]): Unit

    Permalink

    User overridable callback: By default it disposes of all children and then calls postStop().

    User overridable callback: By default it disposes of all children and then calls postStop().

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

    Definition Classes
    AbstractActor
    Annotations
    @throws( classOf[Exception] )
  35. def preStart(): Unit

    Permalink

    User overridable callback.

    User overridable callback.

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

    Definition Classes
    AbstractActorActor
    Annotations
    @throws( classOf[Exception] )
  36. def receive: PartialFunction[Any, Unit]

    Permalink

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    AbstractActorActor
  37. final def receiveBuilder(): ReceiveBuilder

    Permalink

    Convenience factory of the ReceiveBuilder.

    Convenience factory of the ReceiveBuilder. Creates a new empty ReceiveBuilder.

    Definition Classes
    AbstractActor
  38. implicit final val self: ActorRef

    Permalink

    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
  39. final def sender(): ActorRef

    Permalink

    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
  40. def stash(): Unit

    Permalink

    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

  41. def supervisorStrategy: SupervisorStrategy

    Permalink

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

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

    Definition Classes
    AbstractActorActor
  42. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink

    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
  45. def unstashAll(): Unit

    Permalink

    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
  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( ... )
  49. def [B](y: B): (AbstractActorWithStash, B)

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

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from AbstractActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped