c

akka.stream.actor

AbstractActorPublisherWithStash

abstract class AbstractActorPublisherWithStash[T] extends AbstractActor with ActorPublisher[T] with Stash

Java API compatible with lambda expressions. This class adds a Stash to AbstractActorPublisher.

Annotations
@deprecated
Deprecated

(Since version 2.5.0) Use akka.stream.stage.GraphStage instead, it allows for all operations an Actor would and is more type-safe as well as guaranteed to be ReactiveStreams compliant.

Source
ActorPublisher.scala
See also

akka.stream.actor.ActorPublisher and akka.stream.actor.AbstractActorWithStash

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractActorPublisherWithStash
  2. Stash
  3. RequiresMessageQueue
  4. UnrestrictedStash
  5. StashSupport
  6. ActorPublisher
  7. AbstractActor
  8. Actor
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractActorPublisherWithStash()

    Deprecated

    Use akka.stream.stage.GraphStage instead, it allows for all operations an Actor would and is more type-safe as well as guaranteed to be ReactiveStreams compliant.

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def createReceive(): actor.AbstractActor.Receive

    An actor has to define its initial receive behavior by implementing the createReceive method.

    An actor has to define its initial receive behavior by implementing the createReceive method.

    Definition Classes
    AbstractActor

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to any2stringadd[AbstractActorPublisherWithStash[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractActorPublisherWithStash[T], B)
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to ArrowAssoc[AbstractActorPublisherWithStash[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorPublisherActor
  7. def aroundPostStop(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorPublisherActor
  8. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorPublisherActor
  9. def aroundPreStart(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorPublisherActor
  10. def aroundReceive(receive: Receive, msg: Any): Unit

    INTERNAL API

    INTERNAL API

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    ActorPublisherActor
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. 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!

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

    Definition Classes
    Actor
  14. def ensuring(cond: (AbstractActorPublisherWithStash[T]) ⇒ Boolean, msg: ⇒ Any): AbstractActorPublisherWithStash[T]
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to Ensuring[AbstractActorPublisherWithStash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (AbstractActorPublisherWithStash[T]) ⇒ Boolean): AbstractActorPublisherWithStash[T]
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to Ensuring[AbstractActorPublisherWithStash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractActorPublisherWithStash[T]
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to Ensuring[AbstractActorPublisherWithStash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): AbstractActorPublisherWithStash[T]
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to Ensuring[AbstractActorPublisherWithStash[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to StringFormat[AbstractActorPublisherWithStash[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getContext(): 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
  24. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Same as self().

    Definition Classes
    AbstractActor
  25. 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
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. 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
  28. 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
  29. 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
  30. 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
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. def onComplete(): Unit

    Complete the stream.

    Complete the stream. After that you are not allowed to call #onNext, #onError and #onComplete.

    Definition Classes
    ActorPublisher
  36. 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
  37. 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
  38. 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
  39. 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 onNext when isActive and totalDemand > 0, otherwise onNext will throw IllegalStateException.

    Definition Classes
    ActorPublisher
  40. 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
    AbstractActorActor
    Annotations
    @throws( classOf[Exception] )
  41. 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
    UnrestrictedStashActor
  42. 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
    UnrestrictedStashActor
  43. 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] )
  44. 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
    AbstractActorActor
    Annotations
    @throws( classOf[Exception] )
  45. 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
    AbstractActorActor
  46. final def receiveBuilder(): ReceiveBuilder

    Convenience factory of the ReceiveBuilder.

    Convenience factory of the ReceiveBuilder. Creates a new empty ReceiveBuilder.

    Definition Classes
    AbstractActor
  47. 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
  48. 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 deadLetters in 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
  49. 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

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  50. 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
  51. 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
    AbstractActorActor
  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. 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
  55. 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
  56. 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
    StashSupport
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  60. def [B](y: B): (AbstractActorPublisherWithStash[T], B)
    Implicit
    This member is added by an implicit conversion from AbstractActorPublisherWithStash[T] to ArrowAssoc[AbstractActorPublisherWithStash[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from ActorPublisher[T]

Inherited from AbstractActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AbstractActorPublisherWithStash[T] to any2stringadd[AbstractActorPublisherWithStash[T]]

Inherited by implicit conversion StringFormat from AbstractActorPublisherWithStash[T] to StringFormat[AbstractActorPublisherWithStash[T]]

Inherited by implicit conversion Ensuring from AbstractActorPublisherWithStash[T] to Ensuring[AbstractActorPublisherWithStash[T]]

Inherited by implicit conversion ArrowAssoc from AbstractActorPublisherWithStash[T] to ArrowAssoc[AbstractActorPublisherWithStash[T]]

Ungrouped