akka.actor

Class UntypedActorWithUnrestrictedStash

java.lang.Object

akka.actor.UntypedActor

akka.actor.UntypedActorWithUnrestrictedStash

All Implemented Interfaces:

Actor, UnrestrictedStash

public abstract class UntypedActorWithUnrestrictedStash
extends UntypedActor
implements UnrestrictedStash

Actor base class with Stash that does not enforce any mailbox type. The mailbox of the actor has to be configured manually. See UntypedActorWithStash for details on how Stash works.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$

Constructor Summary

Constructors

Constructor and Description
UntypedActorWithUnrestrictedStash()

Method Summary

Methods

Modifier and Type	Method and Description
akka.actor.ActorCell	actorCell()
int	capacity()
scala.collection.immutable.Vector<Envelope>	clearStash() INTERNAL API.
ActorContext	context() INTERNAL API.
void	enqueueFirst(Envelope envelope) Enqueues envelope at the first position in the mailbox.
DequeBasedMessageQueueSemantics	mailbox() INTERNAL API.
void	prepend(scala.collection.immutable.Seq<Envelope> others) Prepends others to this stash.
ActorRef	self() INTERNAL API.
void	stash() Adds the current message (the message that the actor received last) to the actor's stash.
scala.collection.immutable.Vector<Envelope>	theStash()
void	unstash() Prepends the oldest message in the stash to the mailbox, and then removes that message from the stash.
void	unstashAll() Prepends all messages in the stash to the mailbox, and then clears the stash.
void	unstashAll(scala.Function1<java.lang.Object,java.lang.Object> filterPredicate) INTERNAL API.

Methods inherited from class akka.actor.UntypedActor

getContext, getSelf, getSender, onReceive, postRestart, postStop, preRestart, preStart, receive, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.actor.UnrestrictedStash

postStop, preRestart

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, noSender, postRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Constructor Detail

UntypedActorWithUnrestrictedStash

public UntypedActorWithUnrestrictedStash()

Method Detail

context

public ActorContext context()

INTERNAL API.

Context of the actor that uses this stash.

self

public ActorRef self()

INTERNAL API.

Self reference of the actor that uses this stash.

theStash

public scala.collection.immutable.Vector<Envelope> theStash()

actorCell

public akka.actor.ActorCell actorCell()

capacity

public int capacity()

mailbox

public DequeBasedMessageQueueSemantics mailbox()

INTERNAL API.

The actor's deque-based message queue. mailbox.queue is the underlying Deque.

stash

public void stash()

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

Throws:

StashOverflowException - in case of a stash capacity violation

java.lang.IllegalStateException - if the same message is stashed more than once

prepend

public void prepend(scala.collection.immutable.Seq<Envelope> others)

Prepends others to this stash. This method is optimized for a large stash and small others.

unstash

public void unstash()

Prepends the oldest message in the stash to the mailbox, and then removes that message from 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 unstashed message is guaranteed to be removed from the stash regardless if the unstash() call successfully returns or throws an exception.

unstashAll

public void unstashAll()

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().

unstashAll

public void unstashAll(scala.Function1<java.lang.Object,java.lang.Object> filterPredicate)

INTERNAL API.

Prepends selected messages in the stash, applying filterPredicate, 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(Any => Boolean).

Parameters:

filterPredicate - only stashed messages selected by this predicate are prepended to the mailbox.

clearStash

public scala.collection.immutable.Vector<Envelope> clearStash()

INTERNAL API.

Clears the stash and and returns all envelopes that have not been unstashed.

enqueueFirst

public void enqueueFirst(Envelope envelope)

Enqueues envelope at the first position in the mailbox. If the message contained in the envelope is a Terminated message, it will be ensured that it can be re-received by the actor.