akka.stream.actor

ActorSubscriber

trait ActorSubscriber extends Actor

Extend/mixin this trait in your akka.actor.Actor to make it a stream subscriber with full control of stream back pressure. It will receive ActorSubscriberMessage.OnNext, ActorSubscriberMessage.OnComplete and ActorSubscriberMessage.OnError messages from the stream. It can also receive other, non-stream messages, in the same way as any actor.

Attach the actor as a org.reactivestreams.Subscriber to the stream with Scala API ActorSubscriber#apply, or Java API UntypedActorSubscriber#create or Java API compatible with lambda expressions AbstractActorSubscriber#create.

Subclass must define the RequestStrategy to control stream back pressure. After each incoming message the ActorSubscriber will automatically invoke the RequestStrategy#requestDemand and propagate the returned demand to the stream. The provided WatermarkRequestStrategy is a good strategy if the actor performs work itself. The provided MaxInFlightRequestStrategy is useful if messages are queued internally or delegated to other actors. You can also implement a custom RequestStrategy or call #request manually together with ZeroRequestStrategy or some other strategy. In that case you must also call #request when the actor is started or when it is ready, otherwise it will not receive any elements.

Source
ActorSubscriber.scala
Linear Supertypes
Actor, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActorSubscriber
  2. Actor
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. abstract def receive: actor.Actor.Receive

    Definition Classes
    Actor
  2. abstract def requestStrategy: RequestStrategy

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ActorSubscriber, B)

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to ArrowAssoc[ActorSubscriber] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorSubscriber → Actor
  9. def aroundPostStop(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorSubscriber → Actor
  10. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorSubscriber → Actor
  11. def aroundPreStart(): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorSubscriber → Actor
  12. def aroundReceive(receive: Receive, msg: Any): Unit

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka]
    Definition Classes
    ActorSubscriber → Actor
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def cancel(): Unit

    Cancel upstream subscription.

    Cancel upstream subscription. No more elements will be delivered after cancel.

    The ActorSubscriber will be stopped immediatly after signalling cancelation. In case the upstream subscription has not yet arrived the Actor will stay alive until a subscription arrives, cancel it and then stop itself.

    Attributes
    protected
  15. final def canceled: Boolean

  16. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. implicit val context: ActorContext

    Definition Classes
    Actor
  18. def ensuring(cond: (ActorSubscriber) ⇒ Boolean, msg: ⇒ Any): ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: (ActorSubscriber) ⇒ Boolean): ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean, msg: ⇒ Any): ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean): ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  32. def postRestart(reason: Throwable): Unit

    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  33. def postStop(): Unit

    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  34. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  35. def preStart(): Unit

    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  36. def remainingRequested: Int

    The number of stream elements that have already been requested from upstream but not yet received.

    The number of stream elements that have already been requested from upstream but not yet received.

    Attributes
    protected
  37. def request(elements: Long): Unit

    Request a number of elements from upstream.

    Request a number of elements from upstream.

    Attributes
    protected
  38. implicit final val self: ActorRef

    Definition Classes
    Actor
  39. final def sender(): ActorRef

    Definition Classes
    Actor
  40. def supervisorStrategy: SupervisorStrategy

    Definition Classes
    Actor
  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  42. def toString(): String

    Definition Classes
    AnyRef → Any
  43. def unhandled(message: Any): Unit

    Definition Classes
    Actor
  44. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. def [B](y: B): (ActorSubscriber, B)

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to ArrowAssoc[ActorSubscriber] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (actorSubscriber: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (actorSubscriber: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to ArrowAssoc[ActorSubscriber] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorSubscriber: ArrowAssoc[ActorSubscriber]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ActorSubscriber

    Implicit information
    This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorSubscriber: Ensuring[ActorSubscriber]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorSubscriber to StringAdd

Inherited by implicit conversion any2stringfmt from ActorSubscriber to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ActorSubscriber to ArrowAssoc[ActorSubscriber]

Inherited by implicit conversion any2Ensuring from ActorSubscriber to Ensuring[ActorSubscriber]

Ungrouped