ActorSubscriber

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.

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: ActorSubscriber.scala

Linear Supertypes

Actor, AnyRef, Any

Known Subclasses

AbstractActorSubscriber, UntypedActorSubscriber

Type Hierarchy

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Abstract Value Members

abstract def receive: actor.Actor.Receive

Definition Classes
Actor
abstract def requestStrategy: RequestStrategy

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

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

Implicit information
This member is added by an implicit conversion from ActorSubscriber to ArrowAssoc[ActorSubscriber] 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

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

INTERNAL API
INTERNAL API

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

INTERNAL API
INTERNAL API

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

INTERNAL API
INTERNAL API

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

INTERNAL API
INTERNAL API

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

Definition Classes
Any
def cancel(): Unit

Cancel upstream subscription.
Cancel upstream subscription. No more elements will be delivered after cancel.
The ActorSubscriber will be stopped immediately after signaling cancellation. 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
final def canceled: Boolean
def clone(): AnyRef

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

Definition Classes
Actor
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ActorSubscriber) ⇒ Boolean): ActorSubscriber

Implicit information
This member is added by an implicit conversion from ActorSubscriber to Ensuring[ActorSubscriber] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ActorSubscriber

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

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

Definition Classes
AnyRef → Any
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
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()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def postRestart(reason: Throwable): Unit

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

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

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

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
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
def request(elements: Long): Unit

Request a number of elements from upstream.
Request a number of elements from upstream.

Attributes
protected
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def supervisorStrategy: SupervisorStrategy

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

Definition Classes
AnyRef
def toString(): String

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

Definition Classes
Actor
final def wait(): Unit

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

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

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

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

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object ActorSubscriber | package actor

trait ActorSubscriber extends Actor

Type Members

type Receive = PartialFunction[Any, Unit]

Abstract Value Members

abstract def receive: actor.Actor.Receive

abstract def requestStrategy: RequestStrategy

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ActorSubscriber, B)

final def ==(arg0: Any): Boolean

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def cancel(): Unit

final def canceled: Boolean

def clone(): AnyRef

implicit val context: ActorContext

def ensuring(cond: (ActorSubscriber) ⇒ Boolean, msg: ⇒ Any): ActorSubscriber

def ensuring(cond: (ActorSubscriber) ⇒ Boolean): ActorSubscriber

def ensuring(cond: Boolean, msg: ⇒ Any): ActorSubscriber

def ensuring(cond: Boolean): ActorSubscriber

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def remainingRequested: Int

def request(elements: Long): Unit

implicit final val self: ActorRef

final def sender(): ActorRef

def supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unhandled(message: Any): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (ActorSubscriber, B)

Deprecated Value Members

def finalize(): Unit

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorSubscriber to any2stringadd[ActorSubscriber]

Inherited by implicit conversion StringFormat from ActorSubscriber to StringFormat[ActorSubscriber]

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

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

Ungrouped