akka.actor
Interface UnrestrictedStash

All Superinterfaces:

Actor

All Known Subinterfaces:

Creators.ActWithStash, Stash, UnboundedStash

All Known Implementing Classes:

UntypedActorWithStash, UntypedActorWithUnboundedStash, UntypedActorWithUnrestrictedStash

public interface UnrestrictedStash
extends Actor

A version of Stash that does not enforce any mailbox type. The proper mailbox has to be configured manually, and the mailbox should extend the DequeBasedMessageQueueSemantics marker trait.

Nested Class Summary

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

Actor.emptyBehavior$

Method Summary

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	postStop() Overridden callback.
void	prepend(scala.collection.immutable.Seq<Envelope> others) Prepends others to this stash.
void	preRestart(java.lang.Throwable reason, scala.Option<java.lang.Object> message) Overridden callback.
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 interface akka.actor.Actor

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

Method Detail

preRestart

void preRestart(java.lang.Throwable reason,
                scala.Option<java.lang.Object> message)

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

Specified by:

preRestart in interface Actor

Parameters:

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.

postStop

void postStop()

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.

Specified by:

postStop in interface Actor

context

ActorContext context()

INTERNAL API.

Context of the actor that uses this stash.

self

ActorRef self()

INTERNAL API.

Self reference of the actor that uses this stash.

theStash

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

actorCell

akka.actor.ActorCell actorCell()

capacity

int capacity()

mailbox

DequeBasedMessageQueueSemantics mailbox()

INTERNAL API.

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

stash

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

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

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

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

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

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

INTERNAL API.

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

enqueueFirst

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.