abstract class AbstractActorPublisherWithStash[T] extends AbstractActor with ActorPublisher[T] with Stash
Java API compatible with lambda expressions.
This class adds a Stash to AbstractActorPublisher.
- Source
- ActorPublisher.scala
- See also
akka.stream.actor.ActorPublisher and akka.stream.actor.AbstractActorWithStash
- Alphabetic
- By Inheritance
- AbstractActorPublisherWithStash
- Stash
- RequiresMessageQueue
- UnrestrictedStash
- StashSupport
- ActorPublisher
- AbstractActor
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new AbstractActorPublisherWithStash()
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Value Members
-
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.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.
getContextreturns a akka.actor.UntypedActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
-
def
getContext(): AbstractActorContext
Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.
Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.
- Definition Classes
- AbstractActor
-
final
def
isActive: Boolean
The state when the publisher is active, i.e.
The state when the publisher is active, i.e. before the subscriber is attached and when an subscriber is attached. It is allowed to call #onComplete and #onError in this state. It is allowed to call #onNext in this state when #totalDemand is greater than zero.
- Definition Classes
- ActorPublisher
-
final
def
isCanceled: Boolean
The state after the stream subscriber has canceled the subscription.
The state after the stream subscriber has canceled the subscription. It is allowed to call #onNext, #onError, and #onComplete in this state, but the calls will not perform anything.
- Definition Classes
- ActorPublisher
-
final
def
isCompleted: Boolean
The terminal state after calling #onComplete.
The terminal state after calling #onComplete. It is not allowed to call #onNext, #onError, and #onComplete in this state.
- Definition Classes
- ActorPublisher
-
final
def
isErrorEmitted: Boolean
The terminal state after calling #onError.
The terminal state after calling #onError. It is not allowed to call #onNext, #onError, and #onComplete in this state.
- Definition Classes
- ActorPublisher
-
def
onComplete(): Unit
Complete the stream.
Complete the stream. After that you are not allowed to call #onNext, #onError and #onComplete.
- Definition Classes
- ActorPublisher
-
def
onCompleteThenStop(): Unit
Complete the stream.
Complete the stream. After that you are not allowed to call #onNext, #onError and #onComplete.
After signaling completion the Actor will then stop itself as it has completed the protocol. When #onComplete is called before any Subscriber has had the chance to subscribe to this ActorPublisher the completion signal (and therefore stopping of the Actor as well) will be delayed until such Subscriber arrives.
- Definition Classes
- ActorPublisher
-
def
onError(cause: Throwable): Unit
Terminate the stream with failure.
Terminate the stream with failure. After that you are not allowed to call #onNext, #onError and #onComplete.
- Definition Classes
- ActorPublisher
-
def
onErrorThenStop(cause: Throwable): Unit
Terminate the stream with failure.
Terminate the stream with failure. After that you are not allowed to call #onNext, #onError and #onComplete.
After signaling the Error the Actor will then stop itself as it has completed the protocol. When #onError is called before any Subscriber has had the chance to subscribe to this ActorPublisher the error signal (and therefore stopping of the Actor as well) will be delayed until such Subscriber arrives.
- Definition Classes
- ActorPublisher
-
def
onNext(element: T): Unit
Send an element to the stream subscriber.
Send an element to the stream subscriber. You are allowed to send as many elements as have been requested by the stream subscriber. This amount can be inquired with #totalDemand. It is only allowed to use
onNextwhenisActiveandtotalDemand > 0, otherwiseonNextwill throwIllegalStateException.- Definition Classes
- ActorPublisher
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart().User overridable callback: By default it calls
preStart().- 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
- 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
-
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
-
def
preStart(): Unit
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
receive: actor.Actor.Receive
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.
- Definition Classes
- AbstractActor → Actor
-
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 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
-
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
IllegalStateExceptionif the same message is stashed more than onceStashOverflowExceptionin case of a stash capacity violation
-
def
subscriptionTimeout: Duration
Subscription timeout after which this actor will become Canceled and reject any incoming "late" subscriber.
Subscription timeout after which this actor will become Canceled and reject any incoming "late" subscriber.
The actor will receive an SubscriptionTimeoutExceeded message upon which it MUST react by performing all necessary cleanup and stopping itself.
Use this feature in order to avoid leaking actors when you suspect that this Publisher may never get subscribed to by some Subscriber.
- Definition Classes
- ActorPublisher
-
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
- Actor
-
final
def
totalDemand: Long
Total number of requested elements from the stream subscriber.
Total number of requested elements from the stream subscriber. This actor automatically keeps tracks of this amount based on incoming request messages and outgoing
onNext.- Definition Classes
- ActorPublisher
-
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 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
-
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