akka.actor

UntypedActorWithStash

class UntypedActorWithStash extends UntypedActor with Stash

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 UntypedActorWithStash {
    int count = 0;
    public void onReceive(Object msg) {
      if (msg instanceof String) {
        if (count < 0) {
          getSender().tell(new Integer(((String) msg).length()));
        } else if (count == 2) {
          count = -1;
          unstashAll();
        } else {
          count += 1;
          stash();
        }
      }
    }
  }

Attributes
abstract
Linear Supertypes
Stash, UntypedActor, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. UntypedActorWithStash
  2. Stash
  3. UntypedActor
  4. Actor
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UntypedActorWithStash ()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. def onReceive (message: Any): Unit

    To be implemented by concrete UntypedActor.

    To be implemented by concrete UntypedActor. Defines the message handler.

    Attributes
    abstract
    Definition Classes
    UntypedActor
    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. 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.

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

    Attributes
    protected[akka] implicit
    Definition Classes
    Actor
  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  10. def equals (arg0: Any): Boolean

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  13. def getContext (): UntypedActorContext

    Definition Classes
    UntypedActor
  14. def getSelf (): ActorRef

    Returns the 'self' reference.

    Returns the 'self' reference.

    Definition Classes
    UntypedActor
  15. def getSender (): ActorRef

    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.

    Definition Classes
    UntypedActor
  16. def hashCode (): Int

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  19. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  20. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  21. def postRestart (reason: Throwable): Unit

    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.

    Definition Classes
    UntypedActorActor
  22. def postStop (): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    UntypedActorActor
  23. 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 of the superclass.

    Definition Classes
    Stash
  24. def preStart (): Unit

    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
    UntypedActorActor
  25. def receive : PartialFunction[Any, Unit]

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

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

    Attributes
    protected final
    Definition Classes
    UntypedActorActor
  26. implicit 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
    

    Attributes
    implicit final
    Definition Classes
    Actor
  27. 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 ActorSystem.

    Attributes
    final
    Definition Classes
    Actor
  28. 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
    Stash
  29. 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
    UntypedActorActor
  30. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  31. def toString (): String

    Definition Classes
    AnyRef → Any
  32. 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 DeathPactException (in case of an unhandled Terminated message) or publishes an UnhandledMessage to the actor's system's EventStream

    Definition Classes
    Actor
  33. 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
    Stash
  34. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Stash

Inherited from UntypedActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any