abstract class AbstractActorWithUnboundedStash extends AbstractActor with UnboundedStash
Java API: compatible with lambda expressions
Actor base class with Stash that enforces an unbounded deque for the actor. The proper mailbox has to be configured
manually, and the mailbox should extend the pekko.dispatch.DequeBasedMessageQueueSemantics marker trait.
See pekko.actor.AbstractActorWithStash for details on how Stash works.
- Source
- AbstractActor.scala
- Alphabetic
- By Inheritance
- AbstractActorWithUnboundedStash
- UnboundedStash
- RequiresMessageQueue
- UnrestrictedStash
- StashSupport
- AbstractActor
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AbstractActorWithUnboundedStash()
Type Members
- type Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Abstract Value Members
- abstract def createReceive(): AbstractActor.Receive
An actor has to define its initial receive behavior by implementing the
createReceivemethod.An actor has to define its initial receive behavior by implementing the
createReceivemethod.- Definition Classes
- AbstractActor
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toany2stringadd[AbstractActorWithUnboundedStash] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AbstractActorWithUnboundedStash, B)
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toArrowAssoc[AbstractActorWithUnboundedStash] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def aroundPostRestart(reason: Throwable): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
postRestart. CallspostRestartby default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPostStop(): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
postStop. CallspostStopby default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
preRestart. CallspreRestartby default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPreStart(): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
preStart. CallspreStartby default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundReceive(receive: Actor.Receive, msg: Any): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to this actor's current behavior.
- receive
current behavior.
- msg
current message.
- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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!
pekko.actor.ActorContext is the Scala API.
getContextreturns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- def ensuring(cond: (AbstractActorWithUnboundedStash) => Boolean, msg: => Any): AbstractActorWithUnboundedStash
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toEnsuring[AbstractActorWithUnboundedStash] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AbstractActorWithUnboundedStash) => Boolean): AbstractActorWithUnboundedStash
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toEnsuring[AbstractActorWithUnboundedStash] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AbstractActorWithUnboundedStash
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toEnsuring[AbstractActorWithUnboundedStash] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AbstractActorWithUnboundedStash
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toEnsuring[AbstractActorWithUnboundedStash] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getContext(): AbstractActor.ActorContext
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
- def getSelf(): ActorRef
Returns the ActorRef for this actor.
Returns the ActorRef for this actor.
Same as
self().- Definition Classes
- AbstractActor
- 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.
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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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.
- 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
- AbstractActor → Actor
- Annotations
- @throws(classOf[Exception])
- 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])
- 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])
- def preRestart(reason: Throwable, message: Optional[Any]): Unit
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])
- 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
- AbstractActor → Actor
- Annotations
- @throws(classOf[Exception])
- def receive: PartialFunction[Any, Unit]
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
- AbstractActor → Actor
- final def receiveBuilder(): ReceiveBuilder
Convenience factory of the
ReceiveBuilder.Convenience factory of the
ReceiveBuilder. Creates a new emptyReceiveBuilder.- Definition Classes
- AbstractActor
- 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
- 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
deadLettersin pekko.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
- 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
java.lang.IllegalStateExceptionif the same message is stashed more than oncepekko.actor.StashOverflowExceptionin case of a stash capacity violation
- 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
- AbstractActor → Actor
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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 pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream
- Definition Classes
- Actor
- 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
MessageQueueAppendFailedExceptionis thrown.The stash is guaranteed to be empty after calling
unstashAll().- Definition Classes
- StashSupport
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toStringFormat[AbstractActorWithUnboundedStash] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AbstractActorWithUnboundedStash, B)
- Implicit
- This member is added by an implicit conversion from AbstractActorWithUnboundedStash toArrowAssoc[AbstractActorWithUnboundedStash] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.